Skip to main content
Python

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Body

application/json
name
string
required

The project name.

Maximum string length: 64
Example:

"My Project"

taskType
enum<string>
required

The task type of the project.

Available options:
llm-base,
tabular-classification,
tabular-regression,
text-classification
description
string | null

The project description.

Maximum string length: 280
Example:

"My project description."

Response

Status OK.

id
string<uuid>
required
read-only

The project id.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

workspaceId
string<uuid> | null
required
read-only

The workspace id.

Example:

"055fddb1-261f-4654-8598-f6347ee46a09"

creatorId
string<uuid> | null
required
read-only

The project creator id.

Example:

"589ece63-49a2-41b4-98e1-10547761d4b0"

name
string
required

The project name.

Maximum string length: 64
Example:

"My Project"

dateCreated
string<date-time>
required
read-only

The project creation date.

Example:

"2024-03-22T11:31:01.185Z"

dateUpdated
string<date-time>
required
read-only

The project last updated date.

Example:

"2024-03-22T11:31:01.185Z"

source
enum<string> | null
required
read-only

The source of the project.

Available options:
web,
api,
null
taskType
enum<string>
required

The task type of the project.

Available options:
llm-base,
tabular-classification,
tabular-regression,
text-classification
versionCount
integer
required
read-only

The number of versions (commits) in the project.

Required range: x >= 0
Example:

2

inferencePipelineCount
integer
required
read-only

The number of inference pipelines in the project.

Required range: x >= 0
Example:

1

goalCount
integer
required
read-only

The total number of tests in the project.

Required range: x >= 0
Example:

10

developmentGoalCount
integer
required
read-only

The number of tests in the development mode of the project.

Required range: x >= 0
Example:

5

monitoringGoalCount
integer
required
read-only

The number of tests in the monitoring mode of the project.

Required range: x >= 0
Example:

5

Links to the project.

description
string | null

The project description.

Maximum string length: 280
Example:

"My project description."

gitRepo
object | null
read-only