Skip to Content
API ReferenceProjects

Projects API

List projects

GET /v1/projects?page=1&pageSize=20

Returns paginated list of projects for the authenticated organisation.

Query parameters

ParamTypeDefaultDescription
pagenumber1Page number
pageSizenumber20Items per page (max 100)

Response

{
  "data": [
    {
      "id": "uuid",
      "org_id": "uuid",
      "name": "My RAG Pipeline",
      "slug": "my-rag-pipeline",
      "description": "Evaluations for our RAG system",
      "created_at": "2026-04-07T12:00:00.000Z",
      "updated_at": "2026-04-07T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "hasMore": false
  }
}

Create project

POST /v1/projects

Request body

FieldTypeRequiredDescription
namestringYesProject name
descriptionstringNoDescription (max 2,000 chars)
slugstringNoURL-safe slug (auto-generated from name if omitted)
{
  "name": "My RAG Pipeline",
  "description": "Evaluations for our retrieval-augmented generation system"
}

Response 201 Created

{
  "data": {
    "id": "uuid",
    "org_id": "uuid",
    "name": "My RAG Pipeline",
    "slug": "my-rag-pipeline",
    "description": "Evaluations for our retrieval-augmented generation system",
    "created_at": "2026-04-07T12:00:00.000Z",
    "updated_at": "2026-04-07T12:00:00.000Z"
  }
}

Get project

GET /v1/projects/:slug

Returns a single project by slug.

Update project

PATCH /v1/projects/:slug

Request body

FieldTypeDescription
namestringUpdated name
descriptionstringUpdated description

Delete project

DELETE /v1/projects/:slug

Soft-deletes the project and all its suites, cases, and run data. Returns 204 No Content.

Last updated on
AuthenticationEval Suites