Retrieve projects

curl --request GET \
  --url https://api.openlayer.com/v1/projects \
  --header 'Authorization: Bearer <token>'

{
  "_meta": {
    "page": 2,
    "perPage": 50,
    "totalItems": 1,
    "totalPages": 1
  },
  "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.",
      "sample": true,
      "source": "web",
      "taskType": "llm-base",
      "versionCount": 2,
      "inferencePipelineCount": 1,
      "goalCount": 10,
      "developmentGoalCount": 5,
      "monitoringGoalCount": 5,
      "unreadNotificationCount": 1,
      "links": {
        "app": "https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "slackChannelNotificationsEnabled": true,
      "slackChannelName": "#my-project",
      "slackChannelId": "C01B2PZQX1Z",
      "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

headerrequired

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

Query Parameters

page

integer

default: 1

The page to return in a paginated query.

perPage

integer

default: 25

Maximum number of items to return per page.

name

string

Filter list of items by project name.

taskType

enum<string>

Filter list of items by task type.

Available options:

llm-base,

tabular-classification,

tabular-regression,

text-classification

Response

200 - application/json

_meta

object

required

items

object[]

required

items.id

string

required

The project id.

items.workspaceId

string | null

required

The workspace id.

items.creatorId

string | null

required

The project creator id.

items.name

string

required

The project name.

items.dateCreated

string

required

The project creation date.

items.dateUpdated

string

required

The project last updated date.

items.description

string | null

The project description.

items.sample

boolean

required

Whether the project is a sample project or a user-created project.

items.source

enum<string> | null

required

The source of the project.

Available options:

web,

api,

null

items.taskType

enum<string>

required

The task type of the project.

Available options:

llm-base,

tabular-classification,

tabular-regression,

text-classification

items.versionCount

integer

required

The number of versions (commits) in the project.

items.inferencePipelineCount

integer

required

The number of inference pipelines in the project.

items.goalCount

integer

required

The total number of tests in the project.

items.developmentGoalCount

integer

required

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

items.monitoringGoalCount

integer

required

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

items.unreadNotificationCount

integer

The number of unread notifications in the project.

items.links

object

required

Links to the project.

items.slackChannelNotificationsEnabled

boolean

Whether slack channel notifications are enabled for the project.

items.slackChannelName

string | null

The slack channel connected to the project.

items.slackChannelId

string | null

The slack channel id connected to the project.

items.gitRepo

object | null

Was this page helpful?

Overview Retrieve a presigned URL

curl --request GET \
  --url https://api.openlayer.com/v1/projects \
  --header 'Authorization: Bearer <token>'

{
  "_meta": {
    "page": 2,
    "perPage": 50,
    "totalItems": 1,
    "totalPages": 1
  },
  "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.",
      "sample": true,
      "source": "web",
      "taskType": "llm-base",
      "versionCount": 2,
      "inferencePipelineCount": 1,
      "goalCount": 10,
      "developmentGoalCount": 5,
      "monitoringGoalCount": 5,
      "unreadNotificationCount": 1,
      "links": {
        "app": "https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "slackChannelNotificationsEnabled": true,
      "slackChannelName": "#my-project",
      "slackChannelId": "C01B2PZQX1Z",
      "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"
      }
    }
  ]
}

Reference

SDKs

CLI

REST API

Authorizations

Query Parameters

Response