Reference
SDKs
- Overview
- Openlayer SDKs
CLI
- Overview
- CLI global options
- Commands
REST API
- Overview
- Workspaces
- Invites and API keys
- Projects
- Development
- Monitoring
List projects
List your workspace’s projects.
from openlayer import Openlayer
client = Openlayer()
client.projects.list()
{
"items": [
{
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your workspace API key. See Find your API key for more information.
Query Parameters
The page to return in a paginated query.
x > 1
Maximum number of items to return per page.
1 < x < 100
Filter list of items by project name.
Filter list of items by task type.
llm-base
, tabular-classification
, tabular-regression
, text-classification
Response
The project id.
The workspace id.
The project creator id.
The project name.
64
The project creation date.
The project last updated date.
The source of the project.
web
, api
, null
The task type of the project.
llm-base
, tabular-classification
, tabular-regression
, text-classification
The number of versions (commits) in the project.
x > 0
The number of inference pipelines in the project.
x > 0
The total number of tests in the project.
x > 0
The number of tests in the development mode of the project.
x > 0
The number of tests in the monitoring mode of the project.
x > 0
The project description.
280
Was this page helpful?
from openlayer import Openlayer
client = Openlayer()
client.projects.list()
{
"items": [
{
"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"
}
}
]
}