v1

latestOpenAPI 3.0.32026-07-223120123.1 KB
Projects

Create project

Create a project in your workspace.

post/projects

Request body

idstring uuid required

The project id.

workspaceIdstring uuid nullable required

The workspace id.

creatorIdstring uuid nullable required

The project creator id.

namestring required

The project name.

dateCreatedstring date-time required

The project creation date.

dateUpdatedstring date-time required

The project last updated date.

descriptionstring nullable

The project description.

source'web' | 'api' | 'null' nullable required

The source of the project.

taskType'llm-base' | 'tabular-classification' | 'tabular-regression' | 'text-classification' required

The task type of the project.

versionCountinteger required

The number of versions (commits) in the project.

inferencePipelineCountinteger required

The number of inference pipelines in the project.

goalCountinteger required

The total number of tests in the project.

developmentGoalCountinteger required

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

monitoringGoalCountinteger required

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

Example request

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workspaceId": "055fddb1-261f-4654-8598-f6347ee46a09",
  "creatorId": "589ece63-49a2-41b4-98e1-10547761d4b0",
  "name": "My Project",
  "dateCreated": "2024-03-22T11:31:01.185Z",
  "dateUpdated": "2024-03-22T11:31:01.185Z",
  "description": "My project description.",
  "versionCount": 2,
  "inferencePipelineCount": 1,
  "goalCount": 10,
  "developmentGoalCount": 5,
  "monitoringGoalCount": 5,
  "links": {
    "app": "https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Response

Status OK.

idstring uuid required

The project id.

workspaceIdstring uuid nullable required

The workspace id.

creatorIdstring uuid nullable required

The project creator id.

namestring required

The project name.

dateCreatedstring date-time required

The project creation date.

dateUpdatedstring date-time required

The project last updated date.

descriptionstring nullable

The project description.

source'web' | 'api' | 'null' nullable required

The source of the project.

taskType'llm-base' | 'tabular-classification' | 'tabular-regression' | 'text-classification' required

The task type of the project.

versionCountinteger required

The number of versions (commits) in the project.

inferencePipelineCountinteger required

The number of inference pipelines in the project.

goalCountinteger required

The total number of tests in the project.

developmentGoalCountinteger required

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

monitoringGoalCountinteger required

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

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workspaceId": "055fddb1-261f-4654-8598-f6347ee46a09",
  "creatorId": "589ece63-49a2-41b4-98e1-10547761d4b0",
  "name": "My Project",
  "dateCreated": "2024-03-22T11:31:01.185Z",
  "dateUpdated": "2024-03-22T11:31:01.185Z",
  "description": "My project description.",
  "versionCount": 2,
  "inferencePipelineCount": 1,
  "goalCount": 10,
  "developmentGoalCount": 5,
  "monitoringGoalCount": 5,
  "links": {
    "app": "https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}