Sign in
models

Update a custom provider

Partially update editable fields for a custom provider. The provider_id field is read-only.

patch/api/providers/{provider_id}/

Path parameters

provider_idstring required

Custom provider string ID returned as id and provider_id in provider responses.

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth field.

Request body

provider_namestring

Human-readable provider name.

api_keystring

Provider API key. This field is write-only and is never returned.

extra_kwargsobject

Additional provider configuration.

Response

Updated provider.

idstring required

Provider string ID. Same value as provider_id.

provider_idstring required

Unique provider identifier within your organization.

provider_namestring required

Human-readable provider name.

extra_kwargsobject

Provider configuration such as base_url and timeout values. Secret values are not returned here.

created_atstring date-time nullable
updated_atstring date-time nullable

Changes