Provider endpoints
List owned provider endpoints, narrowed by owner when given. Keys are never returned.
Enter your API key here (sent as Otari-Key header).
Only endpoints this workspace owns.
Only endpoints this user owns.
Number of records to skip
0Maximum number of records to return
100Successful Response
Validation Error
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"
}
]
}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.
Enter your API key here (sent as Otari-Key header).
What a caller sends to create an owned endpoint. The key is stored encrypted.
Base URL of the endpoint. Refused when it resolves to a private, loopback, link-local or reserved address.
Sent to the endpoint. Never returned, only its last four.
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.
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 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 that owns the endpoint. Omit for the deployment's default workspace.
Successful Response
The API-facing shape. Never carries the key, only whether one is set.
Validation Error
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"
}Read one endpoint. The key is never returned, only its last four characters.
Enter your API key here (sent as Otari-Key header).
Successful Response
The API-facing shape. Never carries the key, only whether one is set.
Validation Error
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"
}Change an endpoint's name, provider, base URL, key or default fields. The owner cannot change.
Enter your API key here (sent as Otari-Key header).
A partial update. Only what is set is applied; an explicit null api_key clears it.
Base URL of the endpoint. Refused when it resolves to a private, loopback, link-local or reserved address.
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.
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.
Successful Response
The API-facing shape. Never carries the key, only whether one is set.
Validation Error
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 an endpoint. Its name stops resolving at once on this worker, within 30 seconds elsewhere.
Enter your API key here (sent as Otari-Key header).
Successful Response
No content
Validation Error
DELETE /api/v1/provider-endpoints/{endpoint_id} HTTP/1.1
Otari-Key: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?
