API ReferenceModels

Update a custom provider

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

Authentication

AuthorizationBearer

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, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

OR
AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Path parameters

provider_idstringRequired

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

Request

This endpoint expects an object.
provider_namestringOptional

Human-readable provider name.

extra_kwargsmap from strings to anyOptional

Provider configuration. Put provider credentials under extra_kwargs.api_key.

Response

Updated provider.
idstring

Provider string ID. Same value as provider_id.

provider_idstring
Unique provider identifier within your organization.
provider_namestring

Human-readable provider name.

extra_kwargsmap from strings to anyOptional

Stored provider configuration. The current backend returns this object, including credentials it contains; handle the response as sensitive.

created_atdatetime or nullOptional
updated_atdatetime or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error