Skip to main content
Python
from openlayer import Openlayer

client = Openlayer()
project = client.projects.create(
  name="My Project",
  description="My project description.",
  taskType="llm-base"
)
{
  "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.",
  "source": "web",
  "taskType": "llm-base",
  "versionCount": 2,
  "inferencePipelineCount": 1,
  "goalCount": 10,
  "developmentGoalCount": 5,
  "monitoringGoalCount": 5,
  "links": {
    "app": "https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "gitRepo": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "gitId": 123,
    "dateConnected": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "branch": "<string>",
    "name": "<string>",
    "private": true,
    "slug": "<string>",
    "url": "<string>",
    "rootDir": "<string>",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "gitAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

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 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 length: 280
Example:

"My project description."

​
gitRepo
object

Response

Status OK.

​
id
string<uuid>
required

The project id.

Example:

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

​
workspaceId
string<uuid> | null
required

The workspace id.

Example:

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

​
creatorId
string<uuid> | null
required

The project creator id.

Example:

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

​
name
string
required

The project name.

Maximum length: 64
Example:

"My Project"

​
dateCreated
string<date-time>
required

The project creation date.

Example:

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

​
dateUpdated
string<date-time>
required

The project last updated date.

Example:

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

​
source
enum<string> | null
required

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

The number of versions (commits) in the project.

Required range: x >= 0
Example:

2

​
inferencePipelineCount
integer
required

The number of inference pipelines in the project.

Required range: x >= 0
Example:

1

​
goalCount
integer
required

The total number of tests in the project.

Required range: x >= 0
Example:

10

​
developmentGoalCount
integer
required

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

Required range: x >= 0
Example:

5

​
monitoringGoalCount
integer
required

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

Required range: x >= 0
Example:

5

​
links
object
required

Links to the project.

​
description
string | null

The project description.

Maximum length: 280
Example:

"My project description."

​
gitRepo
object