Create or update a custom model

POST

https://api.respan.ai/api/models/

POST

/api/models/

$ curl -X POST https://api.respan.ai/api/models/ \
>      -H "Authorization: Bearer <respanApiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "model_name": "my-custom-gpt-4o"
> }'

1 {
2   "id": "my-custom-gpt-4o",
3   "model_name": "my-custom-gpt-4o",
4   "display_name": "My Custom GPT-4o",
5   "base_model_name": "gpt-4o",
6   "affiliation_category": "custom",
7   "is_called_by_custom_name": false,
8   "input_cost": 2.5,
9   "output_cost": 10,
10   "cache_hit_input_cost": 0.5,
11   "cache_creation_input_cost": 3,
12   "max_context_window": 128000,
13   "streaming_support": 1,
14   "function_call": 1,
15   "image_support": 1,
16   "source": "db",
17   "model_type": "chat",
18   "supported_params": {},
19   "throughput": {
20     "average_tps": 1.1,
21     "average_ttft": 1.1,
22     "average_latency": 1.1,
23     "number_of_requests": 1
24   },
25   "provider": {
26     "id": "my-vllm",
27     "provider_id": "my-vllm",
28     "provider_name": "My vLLM Server",
29     "extra_kwargs": {
30       "base_url": "https://vllm.example.com/v1"
31     },
32     "created_at": "2024-01-15T09:30:00Z",
33     "updated_at": "2024-01-15T09:30:00Z"
34   },
35   "created_at": "2024-01-15T09:30:00Z",
36   "updated_at": "2024-01-15T09:30:00Z"
37 }

Create an organization-specific custom model. If a model with the same model_name already exists in your organization, it is updated and the endpoint returns 200.

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

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.

model_namestringRequired

Unique model name within your organization.

base_model_namestringOptional

Base model to inherit properties from.

display_namestringOptional

Human-readable display name.

custom_provider_idstringOptional

Custom provider string ID or provider identifier to associate.

provider_idstringOptional

Alternative to custom_provider_id.

input_costdoubleOptional

Cost per 1M input tokens in USD.

output_costdoubleOptional

Cost per 1M output tokens in USD.

cache_hit_input_costdoubleOptional

Cost per 1M cached input tokens in USD.

cache_creation_input_costdoubleOptional

Cost per 1M cache creation input tokens in USD.

max_context_windowintegerOptional

Maximum context window size.

streaming_supportenumOptional

Allowed values:

function_callenumOptional

Allowed values:

image_supportenumOptional

Allowed values:

supported_params_overridemap from strings to anyOptional

Partial override for model parameter support. The response returns computed supported_params.

Response

Updated existing model.

idstring

Model string ID. Same value as model_name.

model_namestring

Model name used in API calls.

display_namestringOptional

Human-readable model name.

base_model_namestringOptional

Base model inherited from, when configured.

affiliation_categoryenumOptional

Whether the model is built in or organization-specific.

is_called_by_custom_namebooleanOptional

Whether requests are sent upstream using this custom model name.

input_costdoubleOptional

Cost per 1M input tokens in USD.

output_costdoubleOptional

Cost per 1M output tokens in USD.

cache_hit_input_costdoubleOptional

Cost per 1M cached input tokens in USD.

cache_creation_input_costdoubleOptional

Cost per 1M cache creation input tokens in USD.

max_context_windowintegerOptional

Maximum context window size.

streaming_supportenumOptional

Streaming support. 0 = no, 1 = yes.

function_callenumOptional

Function/tool calling support. 0 = no, 1 = yes.

image_supportenumOptional

Vision input support. 0 = no, 1 = yes.

sourceenumOptional

Source of the model definition.

model_typeenumOptional

Model type.

supported_paramsmap from strings to anyOptional

Computed parameter support after applying model-specific overrides.

throughputobject or nullOptional

providerobjectOptional

created_atdatetime or nullOptional

updated_atdatetime or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error