API ReferenceModels

Replace a custom provider

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

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

api_keystringOptional

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

extra_kwargsmap from strings to anyOptional
Additional provider configuration.

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 any

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

created_atdatetime or null
updated_atdatetime or null

Errors

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