For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Replace editable fields for a custom model. The model_name path value remains the identifier.
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.
OR
AuthorizationBearer
Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.
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_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.
Allowed values:
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.
Allowed values:
function_callenumOptional
Function/tool calling support. 0 = no, 1 = yes.
Allowed values:
image_supportenumOptional
Vision input support. 0 = no, 1 = yes.
Allowed values:
sourceenumOptional
Source of the model definition.
Allowed values:
model_typeenumOptional
Model type.
Allowed values:
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
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.
