Replace a custom model

Replace editable fields for a custom model. The model_name path value remains the identifier.

Path parameters

model_namestringRequired

Model name. The route supports names containing slashes, such as openai/gpt-4o-mini.

Request

This endpoint expects an object.

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

idstring

Model string ID. Same value as model_name.

model_namestring

Model name used in API calls.

display_namestring

Human-readable model name.

base_model_namestring

Base model inherited from, when configured.

affiliation_categoryenum

Whether the model is built in or organization-specific.

Allowed values:

is_called_by_custom_nameboolean

Whether requests are sent upstream using this custom model name.

input_costdouble

Cost per 1M input tokens in USD.

output_costdouble

Cost per 1M output tokens in USD.

cache_hit_input_costdouble

Cost per 1M cached input tokens in USD.

cache_creation_input_costdouble

Cost per 1M cache creation input tokens in USD.

max_context_windowinteger

Maximum context window size.

streaming_supportenum

Streaming support. 0 = no, 1 = yes.

Allowed values:

function_callenum

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

Allowed values:

image_supportenum

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

Allowed values:

sourceenum

Source of the model definition.

Allowed values:

model_typeenum

Model type.

Allowed values:

supported_paramsmap from strings to any

Computed parameter support after applying model-specific overrides.

throughputobject or null

providerobject

created_atdatetime or null

updated_atdatetime or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

1	curl -X PUT https://api.respan.ai/api/models/model_name/ \
2	-H "Authorization: Bearer sk_live_xxxxx" \
3	-H "Content-Type: application/json" \
4	-d '{}'

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	}

Path parameters

Headers

Request

Response

Errors