Sign in
provider-endpoints

Create Provider Endpoint

Changed on

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.

post/api/v1/provider-endpoints

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Request body

api_basestring required

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

api_keystring nullable

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

default_paramsobject nullable

Fields added to every request body sent to this endpoint, beneath the caller's own: a field the caller sets wins. For fields the gateway does not model, such as vLLM's 'chat_template_kwargs'. Credential and transport fields are refused.

namestring required

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

providerstring required

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 nullable

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 nullable

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

Response

Successful Response

api_basestring required
created_atstring date-time required
default_paramsobject nullable
idstring uuid required
last4string nullable
namestring required
providerstring required
updated_atstring date-time nullable
user_idstring nullable
workspace_idstring uuid required

Changes