KEkeywordsai
Models

Replace a custom provider

Changed on

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

put/api/providers/{provider_id}/

Request

  • Base URL
    https://api.respan.ai
  • URL
    https://api.respan.ai/api/providers/{provider_id}/
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

provider_idstring required

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

Request body

provider_namestring required

Human-readable provider name.

extra_kwargsobject

Provider configuration. Put provider credentials under extra_kwargs.api_key.

Example request

{
  "provider_name": "My vLLM Server",
  "extra_kwargs": {
    "api_key": "sk_provider_xxxxx",
    "base_url": "https://vllm.example.com/v1",
    "timeout": 60
  }
}

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

Example response

{
  "id": "my-vllm",
  "provider_id": "my-vllm",
  "provider_name": "My vLLM Server",
  "extra_kwargs": {
    "base_url": "https://vllm.example.com/v1"
  }
}

Changes

  • c30bcb383ee8Revision changes
    • breaking

      request body became required

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      api operation id models_replaceCustomProvider removed and replaced with replaceCustomProvider

    • info

      the endpoint scheme security DashboardJwt was added to the API

    • info

      api tag Models added

    • info

      api tag models removed

  • b830b79cfd52Revision changes
    • breaking

      the request property became required

    • warning

      removed the optional property from the response with the status

    • info

      removed the non-success response with the status

    • info

      the response property became required for the status