For the complete documentation index, see llms.txt. This page is also available as Markdown.

Provider endpoints

List Provider Endpoints

get

List owned provider endpoints, narrowed by owner when given. Keys are never returned.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Query parameters
workspace_idstring · uuid · nullableOptional

Only endpoints this workspace owns.

user_idstring · nullableOptional

Only endpoints this user owns.

skipintegerOptional

Number of records to skip

Default: 0
limitinteger · min: 1 · max: 1000Optional

Maximum number of records to return

Default: 100
Responses
200

Successful Response

application/json
countintegerRequired
get/api/v1/provider-endpoints
GET /api/v1/provider-endpoints HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
{
  "count": 1,
  "data": [
    {
      "api_base": "text",
      "created_at": "2026-01-01T00:00:00.000Z",
      "default_params": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "last4": "text",
      "name": "text",
      "provider": "text",
      "updated_at": "2026-01-01T00:00:00.000Z",
      "user_id": "text",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Create Provider Endpoint

post

Register an endpoint for a workspace, or for one user in it.

It is reachable as <name>:<model> by its owner as soon as this returns on this worker, and on the others within 30 seconds.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Body

What a caller sends to create an owned endpoint. The key is stored encrypted.

api_basestring · max: 1024Required

Base URL of the endpoint. Refused when it resolves to a private, loopback, link-local or reserved address.

api_keystring · nullableOptional

Sent to the endpoint. Never returned, only its last four.

namestring · max: 64Required

What callers put before the colon to reach this endpoint, as ':'. Letters, digits, '.', '_' and '-', starting with a letter or digit. It may not be a provider's name or a configured instance's.

providerstring · max: 64Required

The implementation that speaks to the endpoint: 'openai' for an OpenAI-compatible server, 'anthropic' for an Anthropic-compatible one. Whichever it is, callers may use any of the chat, responses and messages routes.

user_idstring · nullableOptional

User that owns the endpoint. Omit for one every caller in the workspace reaches. A user's endpoint shadows a workspace-wide one of the same name for that user alone.

workspace_idstring · uuid · nullableOptional

Workspace that owns the endpoint. Omit for the deployment's default workspace.

Responses
201

Successful Response

application/json

The API-facing shape. Never carries the key, only whether one is set.

api_basestringRequired
created_atstring · date-timeRequired
idstring · uuidRequired
last4string · nullableOptional
namestringRequired
providerstringRequired
updated_atstring · date-time · nullableOptional
user_idstring · nullableOptional
workspace_idstring · uuidRequired
post/api/v1/provider-endpoints
POST /api/v1/provider-endpoints HTTP/1.1
Otari-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "api_base": "text",
  "api_key": "text",
  "default_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "name": "text",
  "provider": "text",
  "user_id": "text",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "api_base": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "default_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last4": "text",
  "name": "text",
  "provider": "text",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "user_id": "text",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
}

Get Provider Endpoint

get

Read one endpoint. The key is never returned, only its last four characters.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
endpoint_idstring · uuidRequired
Responses
200

Successful Response

application/json

The API-facing shape. Never carries the key, only whether one is set.

api_basestringRequired
created_atstring · date-timeRequired
idstring · uuidRequired
last4string · nullableOptional
namestringRequired
providerstringRequired
updated_atstring · date-time · nullableOptional
user_idstring · nullableOptional
workspace_idstring · uuidRequired
get/api/v1/provider-endpoints/{endpoint_id}
GET /api/v1/provider-endpoints/{endpoint_id} HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
{
  "api_base": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "default_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last4": "text",
  "name": "text",
  "provider": "text",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "user_id": "text",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
}

Update Provider Endpoint

patch

Change an endpoint's name, provider, base URL, key or default fields. The owner cannot change.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
endpoint_idstring · uuidRequired
Body

A partial update. Only what is set is applied; an explicit null api_key clears it.

api_basestring · max: 1024 · nullableOptional

Base URL of the endpoint. Refused when it resolves to a private, loopback, link-local or reserved address.

api_keystring · nullableOptional
namestring · max: 64 · nullableOptional

What callers put before the colon to reach this endpoint, as ':'. Letters, digits, '.', '_' and '-', starting with a letter or digit. It may not be a provider's name or a configured instance's.

providerstring · max: 64 · nullableOptional

The implementation that speaks to the endpoint: 'openai' for an OpenAI-compatible server, 'anthropic' for an Anthropic-compatible one. Whichever it is, callers may use any of the chat, responses and messages routes.

Responses
200

Successful Response

application/json

The API-facing shape. Never carries the key, only whether one is set.

api_basestringRequired
created_atstring · date-timeRequired
idstring · uuidRequired
last4string · nullableOptional
namestringRequired
providerstringRequired
updated_atstring · date-time · nullableOptional
user_idstring · nullableOptional
workspace_idstring · uuidRequired
patch/api/v1/provider-endpoints/{endpoint_id}
PATCH /api/v1/provider-endpoints/{endpoint_id} HTTP/1.1
Otari-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "api_base": "text",
  "api_key": "text",
  "default_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "name": "text",
  "provider": "text"
}
{
  "api_base": "text",
  "created_at": "2026-01-01T00:00:00.000Z",
  "default_params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last4": "text",
  "name": "text",
  "provider": "text",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "user_id": "text",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
}

Delete Provider Endpoint

delete

Delete an endpoint. Its name stops resolving at once on this worker, within 30 seconds elsewhere.

Authorizations
Otari-KeystringRequired

Enter your API key here (sent as Otari-Key header).

Path parameters
endpoint_idstring · uuidRequired
Responses
204

Successful Response

No content

delete/api/v1/provider-endpoints/{endpoint_id}
DELETE /api/v1/provider-endpoints/{endpoint_id} HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*

No content

Last updated

Was this helpful?