4e064cf81dae

latestOpenAPI 3.1.02026-08-131831,331960.0 KB

models

Replace a custom provider

Replace editable fields for a custom provider. The provider_id path value remains the identifier.

put/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, 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.

Request body

provider_namestring

Human-readable provider name.

extra_kwargsobject

Provider configuration. Put provider credentials under extra_kwargs.api_key.

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

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

created_atstring date-time nullable

updated_atstring date-time nullable