Create a custom provider

POST

https://api.respan.ai/api/providers/

Create a custom provider. Use PATCH /api/providers/{provider_id}/ to update an existing provider.

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.

AuthorizationBearer

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

Request

This endpoint expects an object.

provider_idstringRequired

Unique provider identifier within your organization.

provider_namestringRequired

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

Created 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

$	curl -X POST https://api.respan.ai/api/providers/ \
>	-H "Authorization: Bearer <respanApiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"provider_id": "my-vllm",
>	"provider_name": "My vLLM Server"
>	}'

1	{
2	"id": "my-vllm",
3	"provider_id": "my-vllm",
4	"provider_name": "My vLLM Server",
5	"extra_kwargs": {
6	"base_url": "https://vllm.example.com/v1"
7	},
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z"
10	}