Sign in
provider-endpoints

Update Provider Endpoint

Changed on

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

patch/api/v1/provider-endpoints/{endpoint_id}

Request

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

Path parameters

endpoint_idstring uuid required

Request body

api_basestring nullable

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

api_keystring nullable
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 nullable

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 nullable

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.

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