Catalog | Documentation

post

Body

emailstring · emailRequired

is_mobileany ofOptionalDefault: false

booleanOptional

or

nullOptional

redirect_urlany ofOptional

stringOptional

or

nullOptional

workspaceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/auth/login

POST /v1/catalog/auth/login HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "email": "[email protected]",
  "is_mobile": false,
  "redirect_url": "text",
  "workspace": "text"
}

No content

Validate

get

Path parameters

tokenanyRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/auth/validate/{token}

GET /v1/catalog/auth/validate/{token} HTTP/1.1
Accept: */*

No content

Logout

post

Logout from Catalog

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/auth/logout

POST /v1/catalog/auth/logout HTTP/1.1
Accept: */*

No content

Send Invitation Code Enterprise

post

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

Body

ws_idstring · min: 5 · max: 60RequiredPattern: ^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$

ws_namestringRequired

invitation_codestringRequired

team_sizestringRequired

emailstringRequired

user_fullnamestringRequired

from_workbookbooleanRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/workspaces/onboard/enterprise/invitation-code

POST /v1/catalog/workspaces/onboard/enterprise/invitation-code HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "ws_id": "text",
  "ws_name": "text",
  "invitation_code": "text",
  "team_size": "text",
  "email": "text",
  "user_fullname": "text",
  "from_workbook": true
}

No content

Validate Email Invite

get

Path parameters

tokenstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/workspaces/onboard/enterprise/validate/{token}

GET /v1/catalog/workspaces/onboard/enterprise/validate/{token} HTTP/1.1
Accept: */*

No content

Create

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

idstring · min: 5 · max: 60RequiredPattern: ^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$

namestringRequired

invitation_codeany ofOptionalDefault: ""

stringOptional

or

nullOptional

org_namestringRequired

team_sizestringRequired

occupationstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/workspaces/onboard/enterprise

POST /v1/catalog/workspaces/onboard/enterprise HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "id": "text",
  "name": "text",
  "invitation_code": "",
  "org_name": "text",
  "team_size": "text",
  "occupation": "text"
}

No content

Preflight Handler

options

Responses

200

Successful Response

application/json

Responseany

options

/v1/catalog/workspaces/onboard/enterprise

OPTIONS /v1/catalog/workspaces/onboard/enterprise HTTP/1.1
Accept: */*

200

Successful Response

No content

Update Workspace

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

idstring · min: 5 · max: 60RequiredPattern: ^[A-Za-z0-9]+(?:[._-]{1}[A-Za-z0-9]+)*$

namestringRequired

invitation_codeany ofOptionalDefault: ""

stringOptional

or

nullOptional

org_namestringRequired

team_sizestringRequired

occupationstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/workspaces

POST /v1/catalog/workspaces HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "id": "text",
  "name": "text",
  "invitation_code": "",
  "org_name": "text",
  "team_size": "text",
  "occupation": "text"
}

No content

Invite

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

emailsstring · email[]Required

workspace_idstringRequired

is_mobileany ofOptionalDefault: false

booleanOptional

or

nullOptional

roleany ofRequired

stringOptional

or

nullOptional

app_permissionsany ofOptional

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/workspaces/members/invite

POST /v1/catalog/workspaces/members/invite HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "emails": [
    "[email protected]"
  ],
  "workspace_id": "text",
  "is_mobile": false,
  "role": "text",
  "app_permissions": [
    "text"
  ]
}

No content

Get Workspace Members

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

qany ofOptional

stringOptional

or

nullOptional

pageintegerOptionalDefault: 1

limitintegerOptionalDefault: 10

Header parameters

authorizationany ofOptionalDefault: ""

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/workspaces/members

GET /v1/catalog/workspaces/members HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Roles

get

Lists all custom roles defined for a project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

pageinteger · min: 1Optional

Page number

Default: 1

limitinteger · min: 1Optional

Items per page

Default: 10

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/projects/{project_id}/roles

GET /v1/catalog/projects/{project_id}/roles HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "project_id": "text",
    "role_key": "text",
    "role_title": "text",
    "created_by": "text",
    "created_at": "2026-02-13T09:50:53.154Z",
    "updated_at": "2026-02-13T09:50:53.154Z",
    "permissions": [
      {
        "resource_type": "text",
        "resource_id": "text",
        "actions": [
          "text"
        ]
      }
    ]
  }
]

Create Role

post

Creates a new custom role within a project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

role_keystringRequired

role_titlestringRequired

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/projects/{project_id}/roles

POST /v1/catalog/projects/{project_id}/roles HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "role_key": "text",
  "role_title": "text",
  "permissions": [
    {
      "resource_type": "text",
      "resource_id": "text",
      "actions": [
        "text"
      ]
    }
  ]
}

{
  "id": "text",
  "project_id": "text",
  "role_key": "text",
  "role_title": "text",
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z",
  "permissions": [
    {
      "resource_type": "text",
      "resource_id": "text",
      "actions": [
        "text"
      ]
    }
  ]
}

Get Role

get

Retrieves details for a specific role, optionally including its permissions.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

role_idstringRequired

Query parameters

include_permissionsbooleanOptional

Set to true to include the role's permissions from the authorization system.

Default: false

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/projects/{project_id}/roles/{role_id}

GET /v1/catalog/projects/{project_id}/roles/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "project_id": "text",
  "role_key": "text",
  "role_title": "text",
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z",
  "permissions": [
    {
      "resource_type": "text",
      "resource_id": "text",
      "actions": [
        "text"
      ]
    }
  ]
}

Update Role

put

Updates a role's title or its permissions.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

role_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

role_titleany ofOptional

stringOptional

or

nullOptional

permissionsany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/v1/catalog/projects/{project_id}/roles/{role_id}

PUT /v1/catalog/projects/{project_id}/roles/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "role_title": "text",
  "permissions": [
    {
      "resource_type": "text",
      "resource_id": "text",
      "actions": [
        "text"
      ]
    }
  ]
}

{
  "id": "text",
  "project_id": "text",
  "role_key": "text",
  "role_title": "text",
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z",
  "permissions": [
    {
      "resource_type": "text",
      "resource_id": "text",
      "actions": [
        "text"
      ]
    }
  ]
}

Delete Role

delete

Deletes a custom role from a project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

role_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

204

Successful Response

422

Validation Error

application/json

delete

/v1/catalog/projects/{project_id}/roles/{role_id}

DELETE /v1/catalog/projects/{project_id}/roles/{role_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Role By Key

get

Retrieves a role by its unique key, optionally including its permissions.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

role_keystringRequired

Query parameters

include_permissionsbooleanOptional

Set to true to include the role's permissions from the authorization system.

Default: false

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/projects/{project_id}/roles/key/{role_key}

GET /v1/catalog/projects/{project_id}/roles/key/{role_key} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "project_id": "text",
  "role_key": "text",
  "role_title": "text",
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z",
  "permissions": [
    {
      "resource_type": "text",
      "resource_id": "text",
      "actions": [
        "text"
      ]
    }
  ]
}

List Project Members

get

Lists all members in a project, including their roles.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/projects/{project_id}/members

GET /v1/catalog/projects/{project_id}/members HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "project_id": "text",
    "user_id": "text",
    "role_id": "text",
    "created_by": "text",
    "created_at": "2026-02-13T09:50:53.154Z",
    "user": {
      "id": "text",
      "name": "text",
      "avatar_url": "text",
      "title": "text",
      "description": "text",
      "email": "text",
      "gender": "text",
      "interested_in": [
        "text"
      ],
      "social_links": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "works": 1,
      "followers": 1,
      "joined_at": "2026-02-13T09:50:53.154Z"
    },
    "role": {
      "id": "text",
      "project_id": "text",
      "role_key": "text",
      "role_title": "text",
      "created_by": "text",
      "created_at": "2026-02-13T09:50:53.154Z",
      "updated_at": "2026-02-13T09:50:53.154Z",
      "permissions": [
        {
          "resource_type": "text",
          "resource_id": "text",
          "actions": [
            "text"
          ]
        }
      ]
    }
  }
]

Assign Member

post

Assigns a user to a specific role within a project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

user_idstringRequired

role_idstringRequired

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/projects/{project_id}/members

POST /v1/catalog/projects/{project_id}/members HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "user_id": "text",
  "role_id": "text"
}

{
  "id": "text",
  "project_id": "text",
  "user_id": "text",
  "role_id": "text",
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z"
}

Remove Project Member

delete

Removes a user and all their role assignments from a project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

member_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/projects/{project_id}/members/{member_id}

DELETE /v1/catalog/projects/{project_id}/members/{member_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Project Member Role

put

Updates an existing member's role in the project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

member_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

role_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/catalog/projects/{project_id}/members/{member_id}/role

PUT /v1/catalog/projects/{project_id}/members/{member_id}/role HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "role_id": "text"
}

No content

List Catalog Invitations

get

List pending invitations for a catalog project.

Requires VIEW permission on the project's invitation resource.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/projects/{project_id}/members/invitations

GET /v1/catalog/projects/{project_id}/members/invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create Catalog Invitation

post

Create an invitation for an external user to join a catalog project.

Requires CREATE permission on the project's invitation resource.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request to create an invitation for an external user

emailstringRequired

role_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/projects/{project_id}/members/invitations

POST /v1/catalog/projects/{project_id}/members/invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "email": "text",
  "role_id": "text"
}

No content

Revoke Catalog Invitation

delete

Revoke a pending invitation.

Requires DELETE permission on the project's invitation resource.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

invitation_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/projects/{project_id}/members/invitations/{invitation_id}

DELETE /v1/catalog/projects/{project_id}/members/invitations/{invitation_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Resend Catalog Invitation

post

Resend a pending invitation with a new token and extended expiry.

Generates a new invitation token, extends expiration (if applicable), and sends a new invitation email to the user.

Requires UPDATE permission on the project's invitation resource.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

invitation_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/projects/{project_id}/members/invitations/{invitation_id}/resend

POST /v1/catalog/projects/{project_id}/members/invitations/{invitation_id}/resend HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Api Keys

get

List all API keys in the project

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

pageinteger · min: 1Optional

Page number

Default: 1

limitinteger · min: 1Optional

Items per page

Default: 10

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/projects/{project_id}/apikeys

GET /v1/catalog/projects/{project_id}/apikeys HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_keys": [
    {
      "id": "text",
      "project_id": "text",
      "workspace_id": "text",
      "name": "text",
      "key_value": "text",
      "created_by": "text",
      "created_at": "2026-02-13T09:50:53.154Z",
      "last_used_at": "2026-02-13T09:50:53.154Z",
      "expires_at": "2026-02-13T09:50:53.154Z"
    }
  ],
  "total_count": 1
}

Create Api Key

post

Create a new API key for the project

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

nameany ofOptional

stringOptional

or

nullOptional

expires_in_daysany ofOptional

integerOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/projects/{project_id}/apikeys

POST /v1/catalog/projects/{project_id}/apikeys HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "text",
  "expires_in_days": 1
}

{
  "id": "text",
  "key_value": "text",
  "name": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "expires_at": "2026-02-13T09:50:53.154Z"
}

Revoke Api Key

delete

Revoke an API key (soft delete)

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

key_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/projects/{project_id}/apikeys/{key_id}

DELETE /v1/catalog/projects/{project_id}/apikeys/{key_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List labeling projects

get

List labeling projects with filtering and pagination.

Returns a paginated list of projects where the current user is a member.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

qany ofOptional

Search by project name

stringOptional

or

nullOptional

statusany ofOptional

Filter by status (draft, active, completed, archived, suspended)

string[]Optional

or

nullOptional

schema_typeany ofOptional

Filter by schema type

string[]Optional

or

nullOptional

sort_byany ofOptional

Sort fields with direction (e.g., 'name:asc', 'created_at:desc')

string[]Optional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects

GET /v1/catalog/annotation/projects HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create labeling project

post

Create a new labeling project.

Creates a project with the specified schema type and task definition. The project starts in DRAFT status and the creator is automatically added as a project manager.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

schema_typestring · enumRequiredPossible values:

number_of_review_roundsinteger · min: 1 · max: 5OptionalDefault: 1

meta_infoany ofOptionalDefault: {}

or

nullOptional

timeout_configany ofOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/annotation/projects

POST /v1/catalog/annotation/projects HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 664

{
  "name": "text",
  "description": "text",
  "schema_type": "text_classification",
  "task_definition": {
    "data_fields": [
      {
        "id": "text",
        "name": "text",
        "label": "text",
        "type": "text",
        "description": "text"
      }
    ],
    "label_fields": [
      {
        "id": "text",
        "name": "text",
        "label": "text",
        "type": "list",
        "description": "text",
        "required": true,
        "explanation_enabled": true,
        "config": {
          "type": "list",
          "selection_mode": "single",
          "dynamic_options": false,
          "allow_custom_value": false,
          "options": [
            "text"
          ],
          "options_source": "text",
          "option_value_field": "text",
          "option_label_field": "text"
        }
      }
    ]
  },
  "number_of_review_rounds": 1,
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "timeout_config": {
    "task_timeout_minutes": 1,
    "enabled": false
  }
}

No content

Get project details

get

Get labeling project details.

Returns comprehensive project information including statistics about batches, tasks, and team members.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}

GET /v1/catalog/annotation/projects/{project_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update project

put

Update labeling project settings.

Updates project properties such as name, description, and status. Task definition and review rounds can only be updated in DRAFT status.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

nameany ofOptional

stringOptional

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

task_definitionany ofOptional

or

nullOptional

number_of_review_roundsany ofOptional

integer · min: 1 · max: 5Optional

or

nullOptional

meta_infoany ofOptional

or

nullOptional

statusany ofOptional

string · enumOptional

Project lifecycle states

Possible values:

or

nullOptional

training_configany ofOptional

or

nullOptional

timeout_configany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/catalog/annotation/projects/{project_id}

PUT /v1/catalog/annotation/projects/{project_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 702

{
  "name": "text",
  "description": "text",
  "task_definition": {
    "data_fields": [
      {
        "id": "text",
        "name": "text",
        "label": "text",
        "type": "text",
        "description": "text"
      }
    ],
    "label_fields": [
      {
        "id": "text",
        "name": "text",
        "label": "text",
        "type": "list",
        "description": "text",
        "required": true,
        "explanation_enabled": true,
        "config": {
          "type": "list",
          "selection_mode": "single",
          "dynamic_options": false,
          "allow_custom_value": false,
          "options": [
            "text"
          ],
          "options_source": "text",
          "option_value_field": "text",
          "option_label_field": "text"
        }
      }
    ]
  },
  "number_of_review_rounds": 1,
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": "draft",
  "training_config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "timeout_config": {
    "task_timeout_minutes": 1,
    "enabled": false
  }
}

No content

Delete project

delete

Delete a labeling project.

Projects can only be deleted if they are in DRAFT or ARCHIVED status. This operation permanently removes the project and all associated data.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/annotation/projects/{project_id}

DELETE /v1/catalog/annotation/projects/{project_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List project batches

get

List batches for a project with pagination.

Returns a paginated list of batches with embedded progress statistics.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

qany ofOptional

Search by name

stringOptional

or

nullOptional

statusany ofOptional

Filter by status

string[]Optional

or

nullOptional

sort_byany ofOptional

Sort by field and direction

string[]Optional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/batches

GET /v1/catalog/annotation/projects/{project_id}/batches HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create batch with automatic task generation

post

Create a new batch with automatic task generation.

Creates a batch from the specified dataset and automatically generates tasks from data points. The batch starts in IN_PROGRESS status once tasks are generated successfully.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

dataset_idstringRequired

nameany ofOptional

stringOptional

or

nullOptional

number_of_target_tasksintegerRequired

exclude_existing_data_pointsbooleanOptionalDefault: true

meta_infoany ofOptionalDefault: {}

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/batches

POST /v1/catalog/annotation/projects/{project_id}/batches HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "dataset_id": "text",
  "name": "text",
  "number_of_target_tasks": 1,
  "exclude_existing_data_points": true,
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get batch details

get

Get batch details with embedded progress statistics.

Returns comprehensive batch information including task progress, creation details, and current status.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

batch_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/batches/{batch_id}

GET /v1/catalog/annotation/projects/{project_id}/batches/{batch_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update batch

put

Update batch name and meta_info.

Only name and meta_info can be updated. Other batch properties like target task count and dataset cannot be modified after creation.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

batch_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request model for updating batch properties

nameany ofOptional

stringOptional

or

nullOptional

meta_infoany ofOptional

or

nullOptional

statusany ofOptional

string · enumOptional

Batch processing states for labeling projects

Possible values:

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/catalog/annotation/projects/{project_id}/batches/{batch_id}

PUT /v1/catalog/annotation/projects/{project_id}/batches/{batch_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "name": "text",
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "status": "pending"
}

No content

Get tasks in batch

get

Get tasks in a batch with role-based access control.

Managers: Can see all tasks in the batch with full filtering
Labelers/Reviewers: Can only see tasks assigned to them in this batch

Returns paginated list of tasks with complete information including data points, annotations, and assignee details.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

batch_idstringRequired

Query parameters

statusany ofOptional

Filter by task status

string[]Optional

or

nullOptional

assignee_idany ofOptional

Filter by assignee user IDs or 'unassigned'

string[]Optional

or

nullOptional

reviewer_idany ofOptional

Filter by reviewer user IDs or 'unassigned'

string[]Optional

or

nullOptional

is_quality_taskany ofOptional

Filter by quality task status

booleanOptional

or

nullOptional

qany ofOptional

Search by task content

stringOptional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

sort_byany ofOptional

Sort by field and direction

string[]Optional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/batches/{batch_id}/tasks

GET /v1/catalog/annotation/projects/{project_id}/batches/{batch_id}/tasks HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Bulk Assign Tasks

put

Bulk assign or unassign tasks (Manager role required).

task with user_id: assign task to user
task with user_id=null: unassign task

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/v1/catalog/annotation/projects/{project_id}/tasks/assignments

PUT /v1/catalog/annotation/projects/{project_id}/tasks/assignments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "assignments": [
    {
      "task_id": "text",
      "user_id": "text"
    }
  ]
}

{
  "assigned_count": 1,
  "unassigned_count": 1,
  "failed_count": 1,
  "failed_task_ids": [
    "text"
  ],
  "message": "text"
}

Claim Task From Project

post

Claim tasks from any batch in the project (Labeler role). Supports presigned token authentication for external users.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request for claiming tasks

number_of_tasksany ofOptional

Number of tasks to claim (max 50)

integer · min: 1 · max: 50Optional

or

nullOptional

task_idsany ofOptional

Specific task IDs to claim

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/tasks/claim

POST /v1/catalog/annotation/projects/{project_id}/tasks/claim HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "number_of_tasks": 1,
  "task_ids": [
    "text"
  ]
}

No content

Get User Tasks

get

Get tasks assigned to the current user in this project with pagination and filtering (Labeler role). Supports presigned token authentication for external users.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

statusany ofOptional

Filter by task status

string[]Optional

or

nullOptional

qany ofOptional

Search by task content

stringOptional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

sort_byany ofOptional

Sort by field and direction

string[]Optional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/tasks

GET /v1/catalog/annotation/projects/{project_id}/tasks HTTP/1.1
Accept: */*

No content

Get User Task Statistics

get

Get current user's task statistics in this project.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/tasks/statistics

GET /v1/catalog/annotation/projects/{project_id}/tasks/statistics HTTP/1.1
Accept: */*

No content

Get Quality Tasks

get

Get all quality tasks in project for training selection (Manager only).

Returns paginated list of completed quality tasks that can be selected for training configuration.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

batch_idany ofOptional

Filter by batch ID

stringOptional

or

nullOptional

qany ofOptional

Search by task content

stringOptional

or

nullOptional

sort_byany ofOptional

Sort by field and direction

string[]Optional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/tasks/quality

GET /v1/catalog/annotation/projects/{project_id}/tasks/quality HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Task Details

get

Get task details by task ID (Labeler role - own tasks only). Supports presigned token authentication for external users.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

task_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/tasks/{task_id}

GET /v1/catalog/annotation/projects/{project_id}/tasks/{task_id} HTTP/1.1
Accept: */*

No content

Start working on a task

post

Start working on a task (PENDING -> IN_PROGRESS) (Labeler role). Supports presigned token authentication for external users.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

task_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/start

POST /v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/start HTTP/1.1
Accept: */*

No content

Submit Annotation

post

Submit annotation for a task (IN_PROGRESS -> SUBMITTED) (Labeler role). Supports presigned token authentication for external users.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

task_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

mark_as_qualitybooleanOptionalDefault: false

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/submit

POST /v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/submit HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "annotation": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "mark_as_quality": false
}

No content

Skip Tasks

post

Skip multiple tasks and return them to the unassigned pool (Labeler role). Supports presigned token authentication for external users.

Allows users to skip their assigned PENDING or IN_PROGRESS tasks. The tasks will be reset to original state and returned to the pool.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request for skipping tasks

task_idsstring[]Required

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/tasks/skip

POST /v1/catalog/annotation/projects/{project_id}/tasks/skip HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "task_ids": [
    "text"
  ]
}

No content

Timeout a task

post

Timeout an IN_PROGRESS task and reset it to PENDING. Supports presigned token authentication for external users.

Called by frontend when timeout countdown expires. The task will be returned to the pool for other users to claim.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

task_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/timeout

POST /v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/timeout HTTP/1.1
Accept: */*

No content

Get task review history

get

Get complete review history for a task.

Returns all review records ordered by review round, including reviewer info, actions, and feedback.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

task_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/reviews

GET /v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/reviews HTTP/1.1
Accept: */*

No content

Predict Field Value

post

Predict custom field value using LLM.

Generates suggested custom value(s) for a list field based on the task's data. Requires labeler, reviewer, or manager role.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

task_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request to predict custom field value using LLM

field_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/predict-field

POST /v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/predict-field HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "field_id": "text"
}

No content

Set task quality status

post

Mark or unmark a task as a quality task (Manager only).

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

task_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request to mark or unmark a task as quality task

is_quality_taskbooleanRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/quality

POST /v1/catalog/annotation/projects/{project_id}/tasks/{task_id}/quality HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "is_quality_task": true
}

No content

Start reviewing a task

post

Start reviewing a task (PENDING -> IN_PROGRESS) (Reviewer role). Supports presigned token authentication for external users.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

review_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/reviews/{review_id}/start

POST /v1/catalog/annotation/projects/{project_id}/reviews/{review_id}/start HTTP/1.1
Accept: */*

No content

Submit review decision

post

Submit review decision for a specific review. Supports presigned token authentication for external users.

Actions:

accept: Approve annotation, advance to next review round or complete
reject: Send back to labeler for fixes (keeps assigned_to)
fix: Reviewer corrects annotation directly and advances

For fix action, annotation field is required.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request model for submitting a review decision

review_idstringRequired

actionstring · enumRequired

Review decision types

Possible values:

annotationany ofOptional

or

nullOptional

feedbackany ofOptional

stringOptional

or

nullOptional

mark_as_qualitybooleanOptionalDefault: false

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/reviews/submit

POST /v1/catalog/annotation/projects/{project_id}/reviews/submit HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "review_id": "text",
  "action": "accept",
  "annotation": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "feedback": "text",
  "mark_as_quality": false
}

No content

Claim reviews for current user

post

Claim reviews from the project for the current user. Supports presigned token authentication for external users.

Supports queue continuation - returns existing claimed reviews plus newly claimed ones up to the requested amount.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request for claiming reviews

number_of_tasksany ofOptional

Number of reviews to claim (max 50)

integer · min: 1 · max: 50Optional

or

nullOptional

task_idsany ofOptional

Specific task IDs to claim reviews for

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/reviews/claim

POST /v1/catalog/annotation/projects/{project_id}/reviews/claim HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "number_of_tasks": 1,
  "task_ids": [
    "text"
  ]
}

No content

Skip claimed reviews

post

Skip multiple claimed reviews and return them to the review pool. Supports presigned token authentication for external users.

The reviews will be reset to unclaimed state for other reviewers.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request for skipping reviews

review_idsstring[]Required

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/reviews/skip

POST /v1/catalog/annotation/projects/{project_id}/reviews/skip HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "review_ids": [
    "text"
  ]
}

No content

Timeout a review

post

Timeout an IN_PROGRESS review and reset it to PENDING. Supports presigned token authentication for external users.

Called by frontend when timeout countdown expires. The review will be returned to the pool for other reviewers to claim.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

review_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/reviews/{review_id}/timeout

POST /v1/catalog/annotation/projects/{project_id}/reviews/{review_id}/timeout HTTP/1.1
Accept: */*

No content

Get User Reviews

get

Get reviews assigned to the current user in this project with pagination and filtering (Reviewer role).

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

statusany ofOptional

Filter by review status

string[]Optional

or

nullOptional

actionany ofOptional

Filter by review action

string[]Optional

or

nullOptional

qany ofOptional

Search by review ID

stringOptional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

sort_byany ofOptional

Sort by field and direction

string[]Optional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/reviews

GET /v1/catalog/annotation/projects/{project_id}/reviews HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get User Review Statistics

get

Get current user's review statistics in this project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/reviews/statistics

GET /v1/catalog/annotation/projects/{project_id}/reviews/statistics HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Project Members

get

List all members in a project.

Requires 'member:view' permission in the project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

qany ofOptional

Search by member name/email

stringOptional

or

nullOptional

roleany ofOptional

Filter by member roles

string[]Optional

or

nullOptional

sort_byany ofOptional

Sort fields with direction (e.g., 'created_at:desc', 'name:asc')

string[]Optional

or

nullOptional

include_removedbooleanOptional

Include soft-deleted members

Default: false

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/members

GET /v1/catalog/annotation/projects/{project_id}/members HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Add Project Member

post

Add a member to a project.

Requires 'member:add' permission in the project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request to add a member to a project

user_idstringRequired

rolestring · enumRequired

Team member roles in projects

Possible values:

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/members

POST /v1/catalog/annotation/projects/{project_id}/members HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "user_id": "text",
  "role": "manager"
}

No content

Update Member

put

Update a member in a project.

Requires 'member:update_role' permission in the project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

member_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request to update a member

rolestring · enumRequired

Team member roles in projects

Possible values:

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/catalog/annotation/projects/{project_id}/members/{member_id}

PUT /v1/catalog/annotation/projects/{project_id}/members/{member_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "role": "manager"
}

No content

Remove Project Member

delete

Remove a member from a project (soft delete).

Requires 'member:remove' permission in the project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

member_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/annotation/projects/{project_id}/members/{member_id}

DELETE /v1/catalog/annotation/projects/{project_id}/members/{member_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Current User Membership

get

Get current user's membership details in the project.

Returns the authenticated user's membership record if they are an active member.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/members/me

GET /v1/catalog/annotation/projects/{project_id}/members/me HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Invitations

get

List pending invitations for a project.

Requires 'member:view' permission in the project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/members/invitations

GET /v1/catalog/annotation/projects/{project_id}/members/invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create Invitation

post

Create an invitation for an external user.

Requires 'member:create' permission in the project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request to create an invitation for an external user

emailstringRequired

Email address to invite

rolestring · enumRequired

Role to assign

Possible values:

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/members/invitations

POST /v1/catalog/annotation/projects/{project_id}/members/invitations HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "email": "text",
  "role": "manager"
}

No content

Revoke Invitation

delete

Revoke (delete) a pending invitation.

Requires 'member:remove' permission in the project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

invitation_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/annotation/projects/{project_id}/members/invitations/{invitation_id}

DELETE /v1/catalog/annotation/projects/{project_id}/members/invitations/{invitation_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Resend Invitation

post

Resend a pending invitation with a new token and extended expiry.

Generates a new invitation token, extends expiration (if applicable), and sends a new invitation email to the user.

Requires 'member:create' permission in the project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

invitation_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/members/invitations/{invitation_id}/resend

POST /v1/catalog/annotation/projects/{project_id}/members/invitations/{invitation_id}/resend HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Start training attempt

post

Start a new training attempt and get quality tasks.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/training/start

POST /v1/catalog/annotation/projects/{project_id}/training/start HTTP/1.1
Accept: */*

No content

Get user training status

get

Check if user has completed training for this project.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/training/status

GET /v1/catalog/annotation/projects/{project_id}/training/status HTTP/1.1
Accept: */*

No content

Submit training task response

post

Submit a single training task response.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request to submit a single training task response

attempt_idstringRequired

task_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/training/submit

POST /v1/catalog/annotation/projects/{project_id}/training/submit HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "attempt_id": "text",
  "task_id": "text",
  "annotation": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

List training attempts

get

List training attempts for a project (manager view).

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

user_idany ofOptional

Filter by user IDs

string[]Optional

or

nullOptional

statusany ofOptional

Filter by status

string[]Optional

or

nullOptional

is_archivedany ofOptional

Filter by archived status

booleanOptional

or

nullOptional

sort_byany ofOptional

Sort by field and direction

string[]Optional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/training/attempts

GET /v1/catalog/annotation/projects/{project_id}/training/attempts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get training attempt detail

get

Get full training attempt details including responses.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

attempt_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/training/attempts/{attempt_id}

GET /v1/catalog/annotation/projects/{project_id}/training/attempts/{attempt_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reset user training

post

Reset a user's training attempts (manager action).

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request to reset a user's training attempts

user_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/training/reset-user

POST /v1/catalog/annotation/projects/{project_id}/training/reset-user HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "user_id": "text"
}

No content

Retry evaluation for failed attempt

post

Retry evaluation for an attempt that is in ERROR status.

Only the attempt owner or project manager can retry.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

attempt_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/projects/{project_id}/training/attempts/{attempt_id}/retry-evaluation

POST /v1/catalog/annotation/projects/{project_id}/training/attempts/{attempt_id}/retry-evaluation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get training configuration

get

Get training configuration with full task data (Manager only).

Returns training config including expanded quality task data for the selected tasks.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/projects/{project_id}/training/config

GET /v1/catalog/annotation/projects/{project_id}/training/config HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List training jobs

get

List training jobs with filtering and pagination.

Returns paginated list of training jobs. Users can filter by project, creator, or status. Requires view permission on projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

project_idany ofOptional

Filter by project ID

stringOptional

or

nullOptional

user_idany ofOptional

Filter by creator user ID

stringOptional

or

nullOptional

statusany ofOptional

Filter by status (comma-separated)

string[]Optional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

sort_byany ofOptional

Sort by field:direction

string[]Optional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/annotation/training/jobs

GET /v1/catalog/annotation/training/jobs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "project_ids": [
        "text"
      ],
      "model_id": "text",
      "status": "reviewing",
      "jsonl_s3_url": "text",
      "external_job_id": "text",
      "hyperparameters": {
        "epochs": 3,
        "learning_rate": 0.00002,
        "batch_size": 16,
        "warmup_steps": 100,
        "weight_decay": 0.01,
        "model": {
          "model_name_or_path": "text",
          "model_max_length": 2048,
          "attn_implementation": "text",
          "trust_remote_code": true,
          "torch_dtype": "auto",
          "use_fast": true,
          "revision": "main",
          "padding": "longest",
          "padding_free": false,
          "padding_side": "left",
          "truncation_side": "right",
          "use_4bit_quantization": false,
          "use_8bit_quantization": false,
          "bnb_4bit_compute_dtype": "bfloat16",
          "bnb_4bit_quant_type": "nf4",
          "bnb_4bit_quant_storage_dtype": "bfloat16",
          "use_nested_quant": true,
          "use_peft_lora": false,
          "lora_r": 8,
          "lora_alpha": 16,
          "lora_dropout": 0.05,
          "lora_target_modules": "all-linear",
          "use_reentrant": false,
          "use_unsloth": false
        },
        "dataset": {
          "source": "datalog",
          "schema_type": "conversation",
          "urls": [
            "text"
          ],
          "shuffle": true,
          "train_eval_split": 0.8,
          "train_max_samples": 1,
          "validation_max_samples": 1
        },
        "training_params": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "job_type": "sft",
        "detach": true,
        "down": true,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "meta_info": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "created_by": "text",
      "created_at": "2026-02-13T09:50:53.154Z",
      "updated_at": "2026-02-13T09:50:53.154Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 1
}

Register training job

post

Register a new training job and trigger the training pipeline.

Creates a training job record and triggers Temporal workflow to:

Export annotated tasks to JSONL
Submit to external training service
Poll for completion
Create model card

Requires manager permissions on all specified projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request DTO for registering a new training job

project_idsany ofOptional

string[] · min: 1Optional

or

nullOptional

model_idstringRequired

job_typestringOptionalDefault: sft

nameany ofOptional

stringOptional

or

nullOptional

job_nameany ofOptional

stringOptional

or

nullOptional

resourceany ofOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/annotation/training/jobs

POST /v1/catalog/annotation/training/jobs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1216

{
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "job_type": "sft",
  "name": "text",
  "job_name": "text",
  "resource": {
    "infra": "vast",
    "accelerators": "RTX3090:1",
    "disk_size": 100,
    "image_id": "text",
    "memory": "text",
    "cpus": "text"
  }
}

{
  "id": "text",
  "name": "text",
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "status": "reviewing",
  "jsonl_s3_url": "text",
  "external_job_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Get training job details

get

Get details of a specific training job.

Returns full training job information including status, hyperparameters, and metadata. Requires view permission on at least one associated project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/annotation/training/jobs/{job_id}

GET /v1/catalog/annotation/training/jobs/{job_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "status": "reviewing",
  "jsonl_s3_url": "text",
  "external_job_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Delete training job

delete

Delete a training job and its associated resources.

Permanently removes the job record from the database and attempts to delete associated resources on the external service. Requires manager permissions.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/annotation/training/jobs/{job_id}

DELETE /v1/catalog/annotation/training/jobs/{job_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Approve training job

post

Approve a training job and trigger the training pipeline.

Only workspace owners or admins can approve jobs. Must be called via governance delegation (internal service).

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request DTO for approving a training job

notesany ofOptional

Approval notes

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/annotation/training/jobs/{job_id}/approve

POST /v1/catalog/annotation/training/jobs/{job_id}/approve HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "notes": "text"
}

{
  "id": "text",
  "name": "text",
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "status": "reviewing",
  "jsonl_s3_url": "text",
  "external_job_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Reject training job

post

Reject a training job.

Only workspace owners or admins can reject jobs. Must be called via governance delegation (internal service).

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request DTO for rejecting a training job

reasonstringRequired

Reason for rejection

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/annotation/training/jobs/{job_id}/reject

POST /v1/catalog/annotation/training/jobs/{job_id}/reject HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "reason": "text"
}

{
  "id": "text",
  "name": "text",
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "status": "reviewing",
  "jsonl_s3_url": "text",
  "external_job_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

List model cards

get

List trained model cards with filtering and pagination.

Returns paginated list of model cards (trained models). Can filter by project, training job, or status. Requires view permission on projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

project_idany ofOptional

Filter by project ID

stringOptional

or

nullOptional

training_job_idany ofOptional

Filter by training job ID

stringOptional

or

nullOptional

statusany ofOptional

Filter by status

string[]Optional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/annotation/training/models

GET /v1/catalog/annotation/training/models HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "training_job_id": "text",
      "name": "text",
      "version": 1,
      "base_model_id": "text",
      "inference_endpoint": "text",
      "metrics": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "training_config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "s3_model_path": "text",
      "status": "reviewing",
      "created_at": "2026-02-13T09:50:53.154Z",
      "updated_at": "2026-02-13T09:50:53.154Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 1
}

Update model card status

patch

Update model card status (active, deprecated, archived).

Allows managers to manage model lifecycle. Only managers of associated projects can update model card status.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

model_card_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request DTO for updating model card status

statusstring · enumRequired

Model card lifecycle states

Possible values:

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

patch

/v1/catalog/annotation/training/models/{model_card_id}/status

PATCH /v1/catalog/annotation/training/models/{model_card_id}/status HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "status": "reviewing"
}

No content

Cancel training job

post

Cancel a running training job.

Stops the training job on the external service and updates the job status to cancelled. Requires manager permissions on associated projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/annotation/training/jobs/{job_id}/cancel

POST /v1/catalog/annotation/training/jobs/{job_id}/cancel HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "status": "reviewing",
  "jsonl_s3_url": "text",
  "external_job_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Get training job logs

get

Get logs from a training job.

Returns the most recent log lines from the training job. Useful for debugging failures or monitoring progress. Requires view permission on associated projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Query parameters

tailinteger · min: 1 · max: 10000Optional

Number of log lines to retrieve

Default: 100

streambooleanOptional

Whether to stream logs via SSE

Default: false

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/training/jobs/{job_id}/logs

GET /v1/catalog/annotation/training/jobs/{job_id}/logs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get training job metrics

get

Get detailed metrics for a training job.

Returns comprehensive metrics including:

Training metrics (loss, learning rate, step progress, etc.)
Evaluation metrics (accuracy, eval loss, perplexity, etc.)
GPU metrics (utilization, memory, temperature, power usage, etc.)

Requires view permission on associated projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/training/jobs/{job_id}/metrics

GET /v1/catalog/annotation/training/jobs/{job_id}/metrics HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Deploy model

post

Deploy a trained model to inference endpoint.

Executes a Temporal workflow that:

Validates model card and training completion
Calls AIFinity deployment API
Polls for deployment status
Creates deployment record in database
Registers model with TensorZero (TODO)

Waits for workflow completion and returns deployment details with inference_endpoint.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

model_card_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request to deploy a model card

version_labelany ofOptional

Version label (e.g., 'v1', 'production')

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/annotation/training/models/{model_card_id}/deploy

POST /v1/catalog/annotation/training/models/{model_card_id}/deploy HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "version_label": "text",
  "configurations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "text",
  "model_card_id": "text",
  "deployment_id": "text",
  "inference_endpoint": "text",
  "version_label": "text",
  "status": "deploying",
  "configurations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "deployed_at": "2026-02-13T09:50:53.154Z",
  "stopped_at": "2026-02-13T09:50:53.154Z",
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

List deployments

get

List all deployments for a model card.

Supports filtering by status and pagination.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

model_card_idstringRequired

Query parameters

statusany ofOptional

Filter by status (active, stopped, failed, deploying)

stringOptional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/annotation/training/models/{model_card_id}/deployments

GET /v1/catalog/annotation/training/models/{model_card_id}/deployments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "deployments": [
    {
      "id": "text",
      "model_card_id": "text",
      "deployment_id": "text",
      "inference_endpoint": "text",
      "version_label": "text",
      "status": "deploying",
      "configurations": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "deployed_at": "2026-02-13T09:50:53.154Z",
      "stopped_at": "2026-02-13T09:50:53.154Z",
      "created_by": "text",
      "created_at": "2026-02-13T09:50:53.154Z",
      "updated_at": "2026-02-13T09:50:53.154Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 1
}

Get deployment

get

Get deployment details by ID.

Includes current status, configuration, and metrics.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

deployment_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/annotation/training/deployments/{deployment_id}

GET /v1/catalog/annotation/training/deployments/{deployment_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "model_card_id": "text",
  "deployment_id": "text",
  "inference_endpoint": "text",
  "version_label": "text",
  "status": "deploying",
  "configurations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "deployed_at": "2026-02-13T09:50:53.154Z",
  "stopped_at": "2026-02-13T09:50:53.154Z",
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Delete deployment

delete

Delete a deployment and its associated resources.

Permanently removes the deployment record from the database and attempts to delete associated resources on the external service. Requires manager permissions.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

deployment_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/annotation/training/deployments/{deployment_id}

DELETE /v1/catalog/annotation/training/deployments/{deployment_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Stop deployment

post

Stop a running deployment.

Gracefully shuts down the deployment and updates the database record. Returns 409 Conflict if deployment is already stopped.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

deployment_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/annotation/training/deployments/{deployment_id}/stop

POST /v1/catalog/annotation/training/deployments/{deployment_id}/stop HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "model_card_id": "text",
  "deployment_id": "text",
  "inference_endpoint": "text",
  "version_label": "text",
  "status": "deploying",
  "configurations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "deployed_at": "2026-02-13T09:50:53.154Z",
  "stopped_at": "2026-02-13T09:50:53.154Z",
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Accept Invitation

post

Accept an invitation using the token from email.

This is a PUBLIC endpoint - no authentication required. Creates/updates user, workspace membership, and project membership.

Path parameters

tokenstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/invitations/{token}/acceptance

POST /v1/catalog/annotation/invitations/{token}/acceptance HTTP/1.1
Accept: */*

No content

List annotation datasets

get

List annotation datasets for a project

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

qany ofOptional

Search by name

stringOptional

or

nullOptional

project_idstringRequired

Project ID (required)

statusany ofOptional

Filter by status

stringOptional

or

nullOptional

schema_typeany ofOptional

Filter by schema type

string · enumOptionalPossible values:

or

nullOptional

created_byany ofOptional

Filter by creator

stringOptional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/datasets

GET /v1/catalog/annotation/datasets?project_id=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create annotation dataset

post

Create a new annotation dataset and trigger processing

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

project_idstringRequired

collection_idstringRequired

namestringRequired

target_number_of_data_pointsintegerRequired

schema_typestring · enumRequiredPossible values:

dataset_configurationany ofOptionalDefault: {}

or

nullOptional

selected_column_idany ofOptional

stringOptional

or

nullOptional

reference_dataset_idany ofOptional

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/annotation/datasets

POST /v1/catalog/annotation/datasets HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "project_id": "text",
  "collection_id": "text",
  "name": "text",
  "target_number_of_data_points": 1,
  "schema_type": "text_classification",
  "schema_configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "dataset_configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "selected_column_id": "text",
  "reference_dataset_id": "text"
}

No content

Generate scenario configuration from dataset

post

Generate a new dataset configuration (scenario) using LLM based on this dataset and user instructions.

Returns a suggested schema_configuration that the user can modify before creating a new dataset. The new dataset will store reference_dataset_id in meta_info for traceability.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

dataset_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request model for generating scenario configuration using LLM

instructionsstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/datasets/{dataset_id}/scenarios

POST /v1/catalog/annotation/datasets/{dataset_id}/scenarios HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "instructions": "text"
}

No content

Get dataset details

get

Get annotation dataset details with progress information

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

dataset_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/datasets/{dataset_id}

GET /v1/catalog/annotation/datasets/{dataset_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update dataset name

put

Update annotation dataset (name only)

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

dataset_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

namestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/catalog/annotation/datasets/{dataset_id}

PUT /v1/catalog/annotation/datasets/{dataset_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

No content

Delete annotation dataset

delete

Delete annotation dataset (soft delete)

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

dataset_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/annotation/datasets/{dataset_id}

DELETE /v1/catalog/annotation/datasets/{dataset_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Trigger annotation dataset processing

post

Trigger processing for a failed or cancelled annotation dataset

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

dataset_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/datasets/{dataset_id}/trigger

POST /v1/catalog/annotation/datasets/{dataset_id}/trigger HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Cancel annotation dataset

post

Cancel an ongoing annotation dataset processing and clean up partial data

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

dataset_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/datasets/{dataset_id}/cancel

POST /v1/catalog/annotation/datasets/{dataset_id}/cancel HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Trigger data source processing

post

Trigger processing for a failed data source

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

dataset_idstringRequired

data_source_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/datasets/{dataset_id}/data-sources/{data_source_id}/trigger

POST /v1/catalog/annotation/datasets/{dataset_id}/data-sources/{data_source_id}/trigger HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Generate preview with SSE streaming

post

Generate preview dataset

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request model for annotation dataset preview

collection_idstringRequired

asset_idstringRequired

schema_typestring · enumRequiredPossible values:

data_source_typestring · enumOptionalDefault: asset_documentPossible values:

selected_column_idany ofOptional

stringOptional

or

nullOptional

dataset_configurationany ofOptionalDefault: {}

or

nullOptional

start_pageany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/annotation/datasets/preview

POST /v1/catalog/annotation/datasets/preview HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "collection_id": "text",
  "asset_id": "text",
  "schema_type": "text_classification",
  "schema_configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "data_source_type": "asset_document",
  "selected_column_id": "text",
  "dataset_configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "start_page": 1
}

No content

List dataset data points

get

List data points for a dataset

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

dataset_idstringRequired

Query parameters

asset_idany ofOptional

Filter by asset ID

stringOptional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/datasets/{dataset_id}/data-points

GET /v1/catalog/annotation/datasets/{dataset_id}/data-points HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get data point details

get

Get single data point details

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

data_point_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/data-points/{data_point_id}

GET /v1/catalog/annotation/data-points/{data_point_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export Training Data

post

Export annotated tasks to HuggingFace training data format.

Synchronously exports annotation tasks from specified projects to S3 in JSONL format. Timeout: 2 minutes for large datasets.

Args: request: Export request with project_ids and optional output_path user_data: Authenticated user from middleware

Returns: ExportTrainingDataResponse with S3 URL and export statistics

Raises: 400: Invalid project IDs or no tasks found 403: User doesn't have access to projects 500: Export failed 504: Export timeout (>2 minutes)

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request model for exporting training data.

project_idsstring[]Required

include_allany ofOptionalDefault: true

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/annotation/export-training-data

POST /v1/catalog/annotation/export-training-data HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "project_ids": [
    "text"
  ],
  "include_all": true
}

{
  "dataset_url": "text",
  "total_records": 1,
  "records_by_schema": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "file_size_bytes": 1,
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

List training jobs

get

List training jobs with filtering and pagination.

Returns paginated list of training jobs. Users can filter by project, creator, or status. Requires view permission on projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

project_idany ofOptional

Filter by project ID

stringOptional

or

nullOptional

user_idany ofOptional

Filter by creator user ID

stringOptional

or

nullOptional

statusany ofOptional

Filter by status (comma-separated)

string[]Optional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

sort_byany ofOptional

Sort by field:direction

string[]Optional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/training/jobs

GET /v1/catalog/training/jobs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "project_ids": [
        "text"
      ],
      "model_id": "text",
      "status": "reviewing",
      "jsonl_s3_url": "text",
      "external_job_id": "text",
      "hyperparameters": {
        "epochs": 3,
        "learning_rate": 0.00002,
        "batch_size": 16,
        "warmup_steps": 100,
        "weight_decay": 0.01,
        "model": {
          "model_name_or_path": "text",
          "model_max_length": 2048,
          "attn_implementation": "text",
          "trust_remote_code": true,
          "torch_dtype": "auto",
          "use_fast": true,
          "revision": "main",
          "padding": "longest",
          "padding_free": false,
          "padding_side": "left",
          "truncation_side": "right",
          "use_4bit_quantization": false,
          "use_8bit_quantization": false,
          "bnb_4bit_compute_dtype": "bfloat16",
          "bnb_4bit_quant_type": "nf4",
          "bnb_4bit_quant_storage_dtype": "bfloat16",
          "use_nested_quant": true,
          "use_peft_lora": false,
          "lora_r": 8,
          "lora_alpha": 16,
          "lora_dropout": 0.05,
          "lora_target_modules": "all-linear",
          "use_reentrant": false,
          "use_unsloth": false
        },
        "dataset": {
          "source": "datalog",
          "schema_type": "conversation",
          "urls": [
            "text"
          ],
          "shuffle": true,
          "train_eval_split": 0.8,
          "train_max_samples": 1,
          "validation_max_samples": 1
        },
        "training_params": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "job_type": "sft",
        "detach": true,
        "down": true,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "meta_info": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "created_by": "text",
      "created_at": "2026-02-13T09:50:53.154Z",
      "updated_at": "2026-02-13T09:50:53.154Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 1
}

Register training job

post

Register a new training job and trigger the training pipeline.

Creates a training job record and triggers Temporal workflow to:

Export annotated tasks to JSONL
Submit to external training service
Poll for completion
Create model card

Requires manager permissions on all specified projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request DTO for registering a new training job

project_idsany ofOptional

string[] · min: 1Optional

or

nullOptional

model_idstringRequired

job_typestringOptionalDefault: sft

nameany ofOptional

stringOptional

or

nullOptional

job_nameany ofOptional

stringOptional

or

nullOptional

resourceany ofOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/training/jobs

POST /v1/catalog/training/jobs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1216

{
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "job_type": "sft",
  "name": "text",
  "job_name": "text",
  "resource": {
    "infra": "vast",
    "accelerators": "RTX3090:1",
    "disk_size": 100,
    "image_id": "text",
    "memory": "text",
    "cpus": "text"
  }
}

{
  "id": "text",
  "name": "text",
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "status": "reviewing",
  "jsonl_s3_url": "text",
  "external_job_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Get training job details

get

Get details of a specific training job.

Returns full training job information including status, hyperparameters, and metadata. Requires view permission on at least one associated project.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/training/jobs/{job_id}

GET /v1/catalog/training/jobs/{job_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "status": "reviewing",
  "jsonl_s3_url": "text",
  "external_job_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Delete training job

delete

Delete a training job and its associated resources.

Permanently removes the job record from the database and attempts to delete associated resources on the external service. Requires manager permissions.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/training/jobs/{job_id}

DELETE /v1/catalog/training/jobs/{job_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Approve training job

post

Approve a training job and trigger the training pipeline.

Only workspace owners or admins can approve jobs. Must be called via governance delegation (internal service).

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request DTO for approving a training job

notesany ofOptional

Approval notes

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/training/jobs/{job_id}/approve

POST /v1/catalog/training/jobs/{job_id}/approve HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "notes": "text"
}

{
  "id": "text",
  "name": "text",
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "status": "reviewing",
  "jsonl_s3_url": "text",
  "external_job_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Reject training job

post

Reject a training job.

Only workspace owners or admins can reject jobs. Must be called via governance delegation (internal service).

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request DTO for rejecting a training job

reasonstringRequired

Reason for rejection

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/training/jobs/{job_id}/reject

POST /v1/catalog/training/jobs/{job_id}/reject HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "reason": "text"
}

{
  "id": "text",
  "name": "text",
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "status": "reviewing",
  "jsonl_s3_url": "text",
  "external_job_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

List model cards

get

List trained model cards with filtering and pagination.

Returns paginated list of model cards (trained models). Can filter by project, training job, or status. Requires view permission on projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

project_idany ofOptional

Filter by project ID

stringOptional

or

nullOptional

training_job_idany ofOptional

Filter by training job ID

stringOptional

or

nullOptional

statusany ofOptional

Filter by status

string[]Optional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/training/models

GET /v1/catalog/training/models HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "training_job_id": "text",
      "name": "text",
      "version": 1,
      "base_model_id": "text",
      "inference_endpoint": "text",
      "metrics": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "training_config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "s3_model_path": "text",
      "status": "reviewing",
      "created_at": "2026-02-13T09:50:53.154Z",
      "updated_at": "2026-02-13T09:50:53.154Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 1
}

Update model card status

patch

Update model card status (active, deprecated, archived).

Allows managers to manage model lifecycle. Only managers of associated projects can update model card status.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

model_card_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request DTO for updating model card status

statusstring · enumRequired

Model card lifecycle states

Possible values:

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

patch

/v1/catalog/training/models/{model_card_id}/status

PATCH /v1/catalog/training/models/{model_card_id}/status HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "status": "reviewing"
}

No content

Cancel training job

post

Cancel a running training job.

Stops the training job on the external service and updates the job status to cancelled. Requires manager permissions on associated projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/training/jobs/{job_id}/cancel

POST /v1/catalog/training/jobs/{job_id}/cancel HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "project_ids": [
    "text"
  ],
  "model_id": "text",
  "status": "reviewing",
  "jsonl_s3_url": "text",
  "external_job_id": "text",
  "hyperparameters": {
    "epochs": 3,
    "learning_rate": 0.00002,
    "batch_size": 16,
    "warmup_steps": 100,
    "weight_decay": 0.01,
    "model": {
      "model_name_or_path": "text",
      "model_max_length": 2048,
      "attn_implementation": "text",
      "trust_remote_code": true,
      "torch_dtype": "auto",
      "use_fast": true,
      "revision": "main",
      "padding": "longest",
      "padding_free": false,
      "padding_side": "left",
      "truncation_side": "right",
      "use_4bit_quantization": false,
      "use_8bit_quantization": false,
      "bnb_4bit_compute_dtype": "bfloat16",
      "bnb_4bit_quant_type": "nf4",
      "bnb_4bit_quant_storage_dtype": "bfloat16",
      "use_nested_quant": true,
      "use_peft_lora": false,
      "lora_r": 8,
      "lora_alpha": 16,
      "lora_dropout": 0.05,
      "lora_target_modules": "all-linear",
      "use_reentrant": false,
      "use_unsloth": false
    },
    "dataset": {
      "source": "datalog",
      "schema_type": "conversation",
      "urls": [
        "text"
      ],
      "shuffle": true,
      "train_eval_split": 0.8,
      "train_max_samples": 1,
      "validation_max_samples": 1
    },
    "training_params": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "job_type": "sft",
    "detach": true,
    "down": true,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "meta_info": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Get training job logs

get

Get logs from a training job.

Returns the most recent log lines from the training job. Useful for debugging failures or monitoring progress. Requires view permission on associated projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Query parameters

tailinteger · min: 1 · max: 10000Optional

Number of log lines to retrieve

Default: 100

streambooleanOptional

Whether to stream logs via SSE

Default: false

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/training/jobs/{job_id}/logs

GET /v1/catalog/training/jobs/{job_id}/logs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get training job metrics

get

Get detailed metrics for a training job.

Returns comprehensive metrics including:

Training metrics (loss, learning rate, step progress, etc.)
Evaluation metrics (accuracy, eval loss, perplexity, etc.)
GPU metrics (utilization, memory, temperature, power usage, etc.)

Requires view permission on associated projects.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

job_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/training/jobs/{job_id}/metrics

GET /v1/catalog/training/jobs/{job_id}/metrics HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Deploy model

post

Deploy a trained model to inference endpoint.

Executes a Temporal workflow that:

Validates model card and training completion
Calls AIFinity deployment API
Polls for deployment status
Creates deployment record in database
Registers model with TensorZero (TODO)

Waits for workflow completion and returns deployment details with inference_endpoint.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

model_card_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

Request to deploy a model card

version_labelany ofOptional

Version label (e.g., 'v1', 'production')

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/training/models/{model_card_id}/deploy

POST /v1/catalog/training/models/{model_card_id}/deploy HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "version_label": "text",
  "configurations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "id": "text",
  "model_card_id": "text",
  "deployment_id": "text",
  "inference_endpoint": "text",
  "version_label": "text",
  "status": "deploying",
  "configurations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "deployed_at": "2026-02-13T09:50:53.154Z",
  "stopped_at": "2026-02-13T09:50:53.154Z",
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

List deployments

get

List all deployments for a model card.

Supports filtering by status and pagination.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

model_card_idstringRequired

Query parameters

statusany ofOptional

Filter by status (active, stopped, failed, deploying)

stringOptional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/training/models/{model_card_id}/deployments

GET /v1/catalog/training/models/{model_card_id}/deployments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "deployments": [
    {
      "id": "text",
      "model_card_id": "text",
      "deployment_id": "text",
      "inference_endpoint": "text",
      "version_label": "text",
      "status": "deploying",
      "configurations": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "deployed_at": "2026-02-13T09:50:53.154Z",
      "stopped_at": "2026-02-13T09:50:53.154Z",
      "created_by": "text",
      "created_at": "2026-02-13T09:50:53.154Z",
      "updated_at": "2026-02-13T09:50:53.154Z"
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 1
}

Get deployment

get

Get deployment details by ID.

Includes current status, configuration, and metrics.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

deployment_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/training/deployments/{deployment_id}

GET /v1/catalog/training/deployments/{deployment_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "model_card_id": "text",
  "deployment_id": "text",
  "inference_endpoint": "text",
  "version_label": "text",
  "status": "deploying",
  "configurations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "deployed_at": "2026-02-13T09:50:53.154Z",
  "stopped_at": "2026-02-13T09:50:53.154Z",
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Delete deployment

delete

Delete a deployment and its associated resources.

Permanently removes the deployment record from the database and attempts to delete associated resources on the external service. Requires manager permissions.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

deployment_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/training/deployments/{deployment_id}

DELETE /v1/catalog/training/deployments/{deployment_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Stop deployment

post

Stop a running deployment.

Gracefully shuts down the deployment and updates the database record. Returns 409 Conflict if deployment is already stopped.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

deployment_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/training/deployments/{deployment_id}/stop

POST /v1/catalog/training/deployments/{deployment_id}/stop HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "model_card_id": "text",
  "deployment_id": "text",
  "inference_endpoint": "text",
  "version_label": "text",
  "status": "deploying",
  "configurations": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "deployed_at": "2026-02-13T09:50:53.154Z",
  "stopped_at": "2026-02-13T09:50:53.154Z",
  "created_by": "text",
  "created_at": "2026-02-13T09:50:53.154Z",
  "updated_at": "2026-02-13T09:50:53.154Z"
}

Verify user by email

post

Verify if a user exists in Catalog and has catalog access. Returns minimal public profile if user is eligible.

Requirements:

User must exist
User must be ACTIVE member of at least one workspace
User must be owner, admin, OR have catalog in app_permissions

Only accessible by aggregator service (server key required). SK authentication is enforced at router level.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

emailstring · emailRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/internal/users/verify

POST /v1/catalog/internal/users/verify HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "email": "[email protected]"
}

No content

List labeling projects (internal)

get

List labeling projects for a specific member (aggregator only).

This endpoint allows the aggregator to query projects where a specific user is a member, optionally filtering by their role in those projects.

SK authentication is enforced at router level.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

member_idstringRequired

Filter by member user ID

member_roleany ofOptional

Filter by member role(s) (manager, labeler, reviewer, external_manager)

Default: ["manager"]

string[]Optional

or

nullOptional

qany ofOptional

Search by project name

stringOptional

or

nullOptional

statusany ofOptional

Filter by status (draft, active, completed, archived, suspended)

string[]Optional

or

nullOptional

schema_typeany ofOptional

Filter by schema type

string[]Optional

or

nullOptional

sort_byany ofOptional

Sort fields with direction (e.g., 'name:asc', 'created_at:desc')

string[]Optional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/internal/annotation/projects

GET /v1/catalog/internal/annotation/projects?member_id=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get labeling project by ID (internal)

get

Get labeling project details by ID for internal aggregator validation.

SK authentication is enforced at router level.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/internal/annotation/projects/{project_id}

GET /v1/catalog/internal/annotation/projects/{project_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Register aggregator for project

post

Register the aggregator system user as EXTERNAL_MANAGER for a project.

This endpoint adds [email protected] to the project with EXTERNAL_MANAGER role, enabling the aggregator to manage external workers for this project.

No request body needed - automatically uses AGGREGATOR_EMAIL constant. SK authentication is enforced at router level.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/internal/annotation/projects/{project_id}/register-aggregator

POST /v1/catalog/internal/annotation/projects/{project_id}/register-aggregator HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get User Tasks By Sub Id

get

Get tasks by external user identifier (sub_id) in a project.

Service account endpoint for retrieving tasks associated with an external user. Filters tasks where task.sub_id matches the provided sub_id.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

sub_idstringRequired

External user identifier

statusany ofOptional

Filter by task status

string[]Optional

or

nullOptional

qany ofOptional

Search by task content

stringOptional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

sort_byany ofOptional

Sort by field and direction

string[]Optional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/internal/annotation/projects/{project_id}/tasks

GET /v1/catalog/internal/annotation/projects/{project_id}/tasks?sub_id=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get User Reviews By Sub Id

get

Get reviews by external user identifier (sub_id) in a project.

Service account endpoint for retrieving reviews associated with an external user. Filters reviews where review.sub_id matches the provided sub_id.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

sub_idstringRequired

External user identifier

statusany ofOptional

Filter by review status

string[]Optional

or

nullOptional

actionany ofOptional

Filter by review action

string[]Optional

or

nullOptional

qany ofOptional

Search by review ID

stringOptional

or

nullOptional

pageinteger · min: 1Optional

Page number

Default: 1

page_sizeinteger · min: 1 · max: 100Optional

Items per page

Default: 20

sort_byany ofOptional

Sort by field and direction

string[]Optional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/internal/annotation/projects/{project_id}/reviews

GET /v1/catalog/internal/annotation/projects/{project_id}/reviews?sub_id=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Training Status By Sub Id

get

Get training status by external user identifier (sub_id) in a project.

Service account endpoint for checking training completion status.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

sub_idstringRequired

External user identifier

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/internal/annotation/projects/{project_id}/training/status

GET /v1/catalog/internal/annotation/projects/{project_id}/training/status?sub_id=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Generate Presigned Token

post

Generate presigned token for external user access with custom permissions.

INTERNAL ONLY: Requires server key authentication.

The token grants scoped access based on the provided permissions. Token is valid for 4 hours and cannot be revoked (stateless design).

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

project_idstringRequired

sub_idstringRequired

user_idany ofOptional

User ID for authentication (defaults to current authenticated user)

stringOptional

or

nullOptional

ttl_hoursany ofOptional

Optional token TTL in hours (defaults to 24 hours if not provided)

numberOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v1/catalog/internal/auth/presigned-tokens

POST /v1/catalog/internal/auth/presigned-tokens HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "project_id": "text",
  "sub_id": "text",
  "user_id": "text",
  "permissions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "ttl_hours": 1
}

{
  "token": "text",
  "expires_in_seconds": 1
}

Stream dataset debug logs

get

Stream debug logs for a dataset via SSE (historical + real-time).

Sends historical logs from the database first, then streams real-time logs from Redis pub/sub as they are generated.

Args: dataset_id: UUID of the annotation dataset request: FastAPI request object (for disconnect detection) user_data: Authenticated user information

Returns: StreamingResponse with text/event-stream content

Raises: HTTPException: 404 if dataset not found, 403 if no permission, 500 on errors

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

dataset_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/annotation/sse/datasets/{dataset_id}/debug-logs

GET /v1/catalog/annotation/sse/datasets/{dataset_id}/debug-logs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Accept Catalog Invitation

post

Accept a catalog project invitation using the token from email.

PUBLIC endpoint - no authentication required. Provisions user, workspace membership, catalog permissions, and project membership.

Path parameters

tokenstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/invitations/{token}/acceptance

POST /v1/catalog/invitations/{token}/acceptance HTTP/1.1
Accept: */*

No content

Get Catalog Projects Count

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

qany ofOptionalDefault: ""

stringOptional

or

nullOptional

sort_byany ofOptional

stringOptional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/projects/count

GET /v1/catalog/projects/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Catalog Project

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/projects/{project_id}

GET /v1/catalog/projects/{project_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete Catalog Project

delete

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/projects/{project_id}

DELETE /v1/catalog/projects/{project_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get My Project Permissions

get

Get all effective permissions for the current user in a project. Returns aggregated permissions from direct grants and role assignments. Used by frontend to show/hide UI actions based on permissions.

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/projects/{project_id}/permissions/me

GET /v1/catalog/projects/{project_id}/permissions/me HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Catalog Projects

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

qany ofOptionalDefault: ""

stringOptional

or

nullOptional

pageintegerOptionalDefault: 1

limitintegerOptionalDefault: 10

sort_byany ofOptional

stringOptional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/projects

GET /v1/catalog/projects HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create Catalog Project

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

namestringRequired

descriptionstringOptionalDefault: ""

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/projects

POST /v1/catalog/projects HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "name": "text",
  "description": ""
}

No content

Update Catalog Project

put

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

idstringRequired

namestringRequired

descriptionstringOptionalDefault: ""

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/catalog/projects

PUT /v1/catalog/projects HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "id": "text",
  "name": "text",
  "description": ""
}

No content

Get Catalog Tables Count

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/projects/{project_id}/tables/count

GET /v1/catalog/projects/{project_id}/tables/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Catalog Tables

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Query parameters

pageintegerOptionalDefault: 1

limitintegerOptionalDefault: 10

table_typeany ofOptional

stringOptional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/projects/{project_id}/tables

GET /v1/catalog/projects/{project_id}/tables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create Catalog Table

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

project_idstringRequired

namestringRequired

table_typestringOptionalDefault: TABLE

descriptionstringOptionalDefault: ""

statusstring · enumOptionalDefault: DRAFTPossible values:

model_transformstringOptionalDefault: BASIC

languagestringOptionalDefault: English

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/projects/{project_id}/tables

POST /v1/catalog/projects/{project_id}/tables HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "project_id": "text",
  "name": "text",
  "table_type": "TABLE",
  "description": "",
  "status": "DRAFT",
  "model_transform": "BASIC",
  "language": "English"
}

No content

Get Catalog Table Json

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/json

GET /v1/catalog/tables/{table_id}/json HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Catalog Table

put

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

idstringRequired

namestringRequired

descriptionstringOptionalDefault: ""

statusany ofOptional

string · enumOptionalPossible values:

or

nullOptional

model_transformany ofOptional

stringOptional

or

nullOptional

table_typeany ofOptionalDefault: TABLE

stringOptional

or

nullOptional

languageany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/catalog/tables/{table_id}

PUT /v1/catalog/tables/{table_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "id": "text",
  "name": "text",
  "description": "",
  "status": "DRAFT",
  "model_transform": "text",
  "table_type": "TABLE",
  "language": "text"
}

No content

Delete Catalog Table

delete

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/tables/{table_id}

DELETE /v1/catalog/tables/{table_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Catalog Asset Content

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

asset_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/assets/{asset_id}

GET /v1/catalog/tables/{table_id}/assets/{asset_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete Catalog Asset

delete

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

asset_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/tables/{table_id}/assets/{asset_id}

DELETE /v1/catalog/tables/{table_id}/assets/{asset_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Catalog Assets Count

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/assets/count

GET /v1/catalog/tables/{table_id}/assets/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Catalog Assets

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Query parameters

pageintegerOptionalDefault: 1

limitintegerOptionalDefault: 10

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/assets

GET /v1/catalog/tables/{table_id}/assets HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create Catalog Assets

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Query parameters

transformbooleanOptionalDefault: false

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

upload_filesstring · binary[]OptionalDefault: []

plain_textany ofOptional

stringOptional

or

nullOptional

source_idany ofOptional

stringOptional

or

nullOptional

column_static_dataany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/tables/{table_id}/assets

POST /v1/catalog/tables/{table_id}/assets HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 94

{
  "upload_files": [
    "binary"
  ],
  "plain_text": "text",
  "source_id": "text",
  "column_static_data": "text"
}

No content

Upload To Collection

post

Upload assets using git-like project/collection path structure.

This endpoint provides a more intuitive interface for uploading assets, similar to git repository structure: /upload/{team}/{repo}

Example: /upload/my_project/customer_docs

Args: project_name: Name of the project (team) collection_name: Name of the collection (table/repo) upload_files: Files to upload plain_text: Plain text content to upload as a text file source_id: Optional source identifier for the upload column_static_data: JSON string of static column data transform: Whether to trigger transformation pipeline after upload

Returns: Response with uploaded files, asset IDs, and optional transform task ID

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_namestringRequired

collection_namestringRequired

Query parameters

transformbooleanOptionalDefault: false

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

upload_filesstring · binary[]OptionalDefault: []

plain_textany ofOptional

stringOptional

or

nullOptional

source_idany ofOptional

stringOptional

or

nullOptional

column_static_dataany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/upload/{project_name}/{collection_name}

POST /v1/catalog/upload/{project_name}/{collection_name} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 94

{
  "upload_files": [
    "binary"
  ],
  "plain_text": "text",
  "source_id": "text",
  "column_static_data": "text"
}

No content

List Catalog Assets By Name

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_namestringRequired

collection_namestringRequired

Query parameters

pageinteger · min: 1OptionalDefault: 1

limitinteger · min: 1 · max: 100OptionalDefault: 10

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/assets/{project_name}/{collection_name}

GET /v1/catalog/assets/{project_name}/{collection_name} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Catalog Prompt

post

Send a prompt to a specific collection in a project.

This endpoint allows triggering the prompting logic (similar to w_prompt) using the project and collection names.

Args: project_name: Name of the project collection_name: Name of the collection (table) session_id: ID of the chat session prompt: The prompt text context: Optional context dictionary for the orchestrator

Returns: Empty dictionary on success

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_namestringRequired

collection_namestringRequired

session_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

promptstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/prompt/{project_name}/{collection_name}/{session_id}

POST /v1/catalog/prompt/{project_name}/{collection_name}/{session_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "prompt": "text",
  "context": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get Catalog Columns Count

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/columns/count

GET /v1/catalog/tables/{table_id}/columns/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Catalog Columns

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/columns

GET /v1/catalog/tables/{table_id}/columns HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create Catalog Column

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

namestringRequired

content_locationstringRequired

prompt_templatestringRequired

data_typestringRequired

agent_idany ofOptional

stringOptional

or

nullOptional

configany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/tables/{table_id}/columns

POST /v1/catalog/tables/{table_id}/columns HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "name": "text",
  "content_location": "text",
  "scan_ranges": [],
  "prompt_template": "text",
  "data_type": "text",
  "agent_id": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Update Catalog Column

put

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

idstringRequired

namestringRequired

content_locationstringRequired

prompt_templatestringRequired

data_typestringRequired

agent_idany ofOptional

stringOptional

or

nullOptional

configany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/catalog/tables/{table_id}/columns

PUT /v1/catalog/tables/{table_id}/columns HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "id": "text",
  "name": "text",
  "content_location": "text",
  "scan_ranges": [],
  "prompt_template": "text",
  "data_type": "text",
  "agent_id": "text",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get Catalog Columns By Name

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_namestringRequired

collection_namestringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/columns/{project_name}/{collection_name}

GET /v1/catalog/columns/{project_name}/{collection_name} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create Catalog Columns Bulk

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Bodyobject · CatalogColumnCreateRequest[]

namestringRequired

content_locationstringRequired

prompt_templatestringRequired

data_typestringRequired

agent_idany ofOptional

stringOptional

or

nullOptional

configany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/tables/{table_id}/columns/bulk

POST /v1/catalog/tables/{table_id}/columns/bulk HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 170

[
  {
    "name": "text",
    "content_location": "text",
    "scan_ranges": [],
    "prompt_template": "text",
    "data_type": "text",
    "agent_id": "text",
    "config": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

No content

Delete Catalog Column

delete

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

column_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/tables/{table_id}/columns/{column_id}

DELETE /v1/catalog/tables/{table_id}/columns/{column_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Catalog Asset Column By Assets

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Query parameters

asset_idsstring[]Required

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/data_assets

GET /v1/catalog/tables/{table_id}/data_assets?asset_ids=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Catalog Asset Column

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/asset_column

GET /v1/catalog/tables/{table_id}/asset_column HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete Catalog Asset Column

delete

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/tables/{table_id}/asset_column

DELETE /v1/catalog/tables/{table_id}/asset_column HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Catalog Column Value

put

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

asset_idstringRequired

column_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

valuestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/catalog/tables/{table_id}/assets/{asset_id}/columns/{column_id}/value_data

PUT /v1/catalog/tables/{table_id}/assets/{asset_id}/columns/{column_id}/value_data HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "value": "text"
}

No content

Transform Data

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

project_idstringRequired

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/projects/{project_id}/tables/{table_id}/transformation

POST /v1/catalog/projects/{project_id}/tables/{table_id}/transformation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "to_prod": false,
  "asset_ids": [
    "text"
  ],
  "processing_mode": "scan_all_in_one",
  "enable_scan_batch": false,
  "enable_knowledge_batch": false
}

No content

Export Catalog Data Json

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/export/json

GET /v1/catalog/tables/{table_id}/export/json HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export Catalog Data Csv

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/export/csv

GET /v1/catalog/tables/{table_id}/export/csv HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export Catalog Data Excel

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/export/excel

GET /v1/catalog/tables/{table_id}/export/excel HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Tables Files

get

Get list of files for all tables accessible to the user's workspace and owned by the user

Each table will include up to 'limit' files, but the total_files field will indicate the total count.

Args: q: Optional search query to filter by project name or table name limit: Maximum number of files per table (default: 5)

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

qany ofOptional

stringOptional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/tables/files

GET /v1/catalog/tables/files HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "index_id": "text",
    "project_id": "text",
    "project_name": "text",
    "table_name": "text",
    "table_id": "text",
    "files": [
      "text"
    ],
    "link": "text",
    "total_files": 1
  }
]

Get Catalog Templates

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

pageintegerOptionalDefault: 1

limitintegerOptionalDefault: 10

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/templates

GET /v1/catalog/templates HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create Catalog Template

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

table_idstringRequired

namestringRequired

descriptionstringOptionalDefault: ""

visibilitystringOptionalDefault: PRIVATE

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/templates

POST /v1/catalog/templates HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "table_id": "text",
  "name": "text",
  "description": "",
  "visibility": "PRIVATE"
}

No content

Get Catalog Template Detail

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

template_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/templates/{template_id}

GET /v1/catalog/templates/{template_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "template": {
    "id": "text",
    "workspace_id": "text",
    "owner_id": "text",
    "name": "text",
    "description": "text",
    "visibility": "text",
    "link": "text"
  },
  "columns": [
    {
      "id": "text",
      "template_id": "text",
      "name": "text",
      "content_location": "text",
      "scan_ranges": [],
      "prompt_template": "text",
      "data_type": "text"
    }
  ]
}

Update Catalog Template

put

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

template_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

namestringRequired

descriptionstringOptionalDefault: ""

visibilitystringOptionalDefault: PRIVATE

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/catalog/templates/{template_id}

PUT /v1/catalog/templates/{template_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "name": "text",
  "description": "",
  "visibility": "PRIVATE"
}

No content

Delete Catalog Template

delete

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

template_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/templates/{template_id}

DELETE /v1/catalog/templates/{template_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Count Catalog Templates

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/templates/count

GET /v1/catalog/templates/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Catalog Template By Link

get

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

linkstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/templates/link/{link}

GET /v1/catalog/templates/link/{link} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "template": {
    "id": "text",
    "workspace_id": "text",
    "owner_id": "text",
    "name": "text",
    "description": "text",
    "visibility": "text",
    "link": "text"
  },
  "columns": [
    {
      "id": "text",
      "template_id": "text",
      "name": "text",
      "content_location": "text",
      "scan_ranges": [],
      "prompt_template": "text",
      "data_type": "text"
    }
  ]
}

Create Template Column

post

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

template_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

namestringRequired

content_locationstringRequired

prompt_templatestringRequired

data_typestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/v1/catalog/templates/{template_id}/columns

POST /v1/catalog/templates/{template_id}/columns HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "name": "text",
  "content_location": "text",
  "scan_ranges": [],
  "prompt_template": "text",
  "data_type": "text"
}

No content

Update Template Column

put

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

template_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Body

idstringRequired

namestringRequired

content_locationstringRequired

prompt_templatestringRequired

data_typestringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

put

/v1/catalog/templates/{template_id}/columns

PUT /v1/catalog/templates/{template_id}/columns HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "id": "text",
  "name": "text",
  "content_location": "text",
  "scan_ranges": [],
  "prompt_template": "text",
  "data_type": "text"
}

No content

Delete Template Column

delete

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

template_idstringRequired

column_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/v1/catalog/templates/{template_id}/columns/{column_id}

DELETE /v1/catalog/templates/{template_id}/columns/{column_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Table Files Paginated

get

Get files for a specific table

Args: table_id: The ID of the table to get files for limit: Maximum number of files to return (default: 5)

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Path parameters

table_idstringRequired

Query parameters

limitintegerOptionalDefault: 5

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/catalog/tables/{table_id}/files

GET /v1/catalog/tables/{table_id}/files HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "index_id": "text",
  "project_id": "text",
  "project_name": "text",
  "table_name": "text",
  "table_id": "text",
  "files": [
    "text"
  ],
  "link": "text",
  "total_files": 1
}

Get Hugging Face Models

get

Get list of Hugging Face models with pagination and filtering.

Supports both legacy pagination (page-based) and cursor-based pagination.

Features:

Pagination: 20 items per page (configurable)
Multiple filter options and HF native parameters
Automatic cursor extraction and next page URL wrapping
Link header parsing

The response includes a wrapped next_page URL that can be used for pagination:

Original HF URL: https://huggingface.co/api/models?limit=20&cursor=xyz
Wrapped URL: /v1/catalog/models?limit=20&cursor=xyz

Response schema: { "data": [array of models from Hugging Face API], "total": integer (total available models), "page": integer (current page number), "next_page": string (wrapped next page URL for pagination, or empty if last page), "items_per_page": integer (20 or custom limit) }

Authorizations

AuthorizationstringRequired

JWT access token for authentication. Swagger UI automatically adds 'Bearer ' prefix.

cookie

authstringOptionalDefault: ""

Query parameters

pageany ofOptional

Page number (1-indexed) for legacy pagination

integer · min: 1Optional

or

nullOptional

limitany ofOptional

Limit items per page (default 20, max 100)

integer · min: 1 · max: 100Optional

or

nullOptional

cursorany ofOptional

Cursor for cursor-based pagination (from next_page_url)

stringOptional

or

nullOptional

searchany ofOptional

Search query for repos and usernames

stringOptional

or

nullOptional

authorany ofOptional

Filter by author/organization

stringOptional

or

nullOptional

filterany ofOptional

Filter by tags (HF native parameter)

stringOptional

or

nullOptional

taskany ofOptional

Filter by task (legacy, maps to filter)

stringOptional

or

nullOptional

libraryany ofOptional

Filter by library (legacy, maps to filter)

stringOptional

or

nullOptional

languageany ofOptional

Filter by language (legacy, maps to filter)

stringOptional

or

nullOptional

licenseany ofOptional

Filter by license (legacy, maps to filter)

stringOptional

or

nullOptional

model_idany ofOptional

Filter by model ID pattern (legacy, maps to filter)

stringOptional

or

nullOptional

task_typeany ofOptional

Filter by task type (convenience param, e.g., 'text-generation')

stringOptional

or

nullOptional

frameworkany ofOptional

Filter by framework (convenience param, e.g., 'tensorflow')

stringOptional

or

nullOptional

size_rangeany ofOptional

Filter by size range (can specify multiple)

string[]Optional

or

nullOptional

sortany ofOptional

Sort by property (e.g., 'downloads', 'trendingScore', 'modified')

stringOptional

or

nullOptional

directionany ofOptional

Sort direction (-1 for descending)

stringOptional

or

nullOptional

fullany ofOptional

Fetch complete model data including all tags, files

booleanOptional

or

nullOptional

configany ofOptional

Fetch repo config

booleanOptional

or

nullOptional

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/models

GET /v1/catalog/models HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Hugging Face Model

get

Get detailed information for a specific Hugging Face model.

Args: model_id: Model identifier in format "author/model-name" (e.g., "bert-base-uncased", "meta-llama/Llama-2-7b-hf")

Returns: Dictionary containing full model details from HF API including: - Basic metadata (id, author, modelId, lastModified) - Model card data (tags, pipeline_tag, library_name) - Usage statistics (downloads, likes) - Files and configuration

Response example: { "id": "bert-base-uncased", "modelId": "bert-base-uncased", "author": "google", "downloads": 1234567, "likes": 890, "tags": ["transformers", "pytorch", "bert"], "pipeline_tag": "fill-mask", ... }

cookie

authstringOptionalDefault: ""

Path parameters

model_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Sub-IDany ofOptional

stringOptional

or

nullOptional

X-Internal-Serviceany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

get

/v1/catalog/models/{model_id}

GET /v1/catalog/models/{model_id} HTTP/1.1
Accept: */*

No content

hashtagLogin

hashtagValidate

hashtagLogout

hashtagSend Invitation Code Enterprise

hashtagValidate Email Invite

hashtagCreate

hashtagPreflight Handler

hashtagUpdate Workspace

hashtagInvite

hashtagGet Workspace Members

hashtagList Roles

hashtagCreate Role

hashtagGet Role

hashtagUpdate Role

hashtagDelete Role

hashtagGet Role By Key

hashtagList Project Members

hashtagAssign Member

hashtagRemove Project Member

hashtagUpdate Project Member Role

hashtagList Catalog Invitations

hashtagCreate Catalog Invitation

hashtagRevoke Catalog Invitation

hashtagResend Catalog Invitation

hashtagList Api Keys

hashtagCreate Api Key

hashtagRevoke Api Key

hashtagList labeling projects

hashtagCreate labeling project

hashtagGet project details

hashtagUpdate project

hashtagDelete project

hashtagList project batches

hashtagCreate batch with automatic task generation

hashtagGet batch details

hashtagUpdate batch

hashtagGet tasks in batch

hashtagBulk Assign Tasks

hashtagClaim Task From Project

hashtagGet User Tasks

hashtagGet User Task Statistics

hashtagGet Quality Tasks

hashtagGet Task Details

hashtagStart working on a task

hashtagSubmit Annotation

hashtagSkip Tasks

hashtagTimeout a task

hashtagGet task review history

hashtagPredict Field Value

hashtagSet task quality status

hashtagStart reviewing a task

hashtagSubmit review decision

hashtagClaim reviews for current user

hashtagSkip claimed reviews

hashtagTimeout a review

hashtagGet User Reviews

hashtagGet User Review Statistics

hashtagList Project Members

hashtagAdd Project Member

hashtagUpdate Member

hashtagRemove Project Member

hashtagGet Current User Membership

hashtagList Invitations

hashtagCreate Invitation

hashtagRevoke Invitation

hashtagResend Invitation

hashtagStart training attempt

hashtagGet user training status

hashtagSubmit training task response

hashtagList training attempts

hashtagGet training attempt detail

hashtagReset user training

hashtagRetry evaluation for failed attempt

hashtagGet training configuration

hashtagList training jobs

hashtagRegister training job

hashtagGet training job details

hashtagDelete training job

hashtagApprove training job

hashtagReject training job

Login

Validate

Logout

Send Invitation Code Enterprise

Validate Email Invite

Create

Preflight Handler

Update Workspace

Invite

Get Workspace Members

List Roles

Create Role

Get Role

Update Role

Delete Role

Get Role By Key

List Project Members

Assign Member

Remove Project Member

Update Project Member Role

List Catalog Invitations

Create Catalog Invitation

Revoke Catalog Invitation

Resend Catalog Invitation

List Api Keys

Create Api Key

Revoke Api Key

List labeling projects

Create labeling project

Get project details

Update project

Delete project

List project batches

Create batch with automatic task generation

Get batch details

Update batch

Get tasks in batch

Bulk Assign Tasks

Claim Task From Project

Get User Tasks

Get User Task Statistics

Get Quality Tasks

Get Task Details

Start working on a task

Submit Annotation

Skip Tasks

Timeout a task

Get task review history

Predict Field Value

Set task quality status

Start reviewing a task

Submit review decision

Claim reviews for current user

Skip claimed reviews

Timeout a review

Get User Reviews

Get User Review Statistics

List Project Members

Add Project Member

Update Member

Remove Project Member

Get Current User Membership

List Invitations

Create Invitation

Revoke Invitation

Resend Invitation

Start training attempt

Get user training status

Submit training task response

List training attempts

Get training attempt detail

Reset user training

Retry evaluation for failed attempt

Get training configuration

List training jobs

Register training job

Get training job details

Delete training job

Approve training job

Reject training job