KEkeywordsai
Models

Create a custom provider

Changed on

To update an existing provider, use PATCH /api/providers/{provider_id}/.

post/api/providers/

Request

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

Request body

provider_idstring required

Unique provider identifier within your organization.

provider_namestring required

Human-readable provider name.

extra_kwargsobject

Provider configuration. Put provider credentials under extra_kwargs.api_key.

Example request

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

Response

Created 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_createCustomProvider removed and replaced with createCustomProvider

    • info

      the endpoint scheme security DashboardJwt was added to the API

    • info

      api tag Models added

    • info

      api tag models removed

  • b830b79cfd52Revision changes
    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status