Create Project

POST

/v1/projects

const url = 'https://example.com/v1/projects';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"example","description":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/projects \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example" }'

Create a new project.

Projects are used to organize finetune jobs. Each finetune job must be associated with a project.

Parameters

Header Parameters

x-api-key

Any of:

string
null

string

Request Body^required

application/json

ProjectCreateRequest

Request to create a new project

object

name

required

Name

Project name

string

>= 1 characters <= 255 characters

description

Any of:

string
null

string

<= 1000 characters

Example ^generated

{
  "name": "example",
  "description": "example"
}

Responses

200

Project created successfully

application/json

ProjectCreateResponse

Response for project creation

object

created

required

Created

Whether the project was created

boolean

project_id

required

Project Id

ID of the created project

string format: uuid

Example ^generated

{
  "created": true,
  "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

401

Invalid or missing API key

application/json

ErrorResponse

Standard error response.

object

detail

required

Detail

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

422

Validation error

Create Project

Parameters

Header Parameters

Request Body required

Example generated

Responses

200

Example generated

401

Example generated

422

Request Body^required

Example ^generated

Example ^generated

Example ^generated