Skip to navigation
API ReferenceModelsCustom models

Get a model

Retrieve a built-in or custom model by model name. Custom models are only visible to the owning organization.

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

The model_name that List models returns. Built-in models are provider-prefixed, such as openai/gpt-4o-mini; bare names such as gpt-4o-mini return 404.

Response

Model details.
idstring

Model string ID. Same value as model_name.

model_namestring
Model name used in API calls.
base_model_namestringOptional
Base model inherited from, when configured.
affiliation_categoryenumOptional

keywordsai for built-in models, custom for your organization's models.

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

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

Allowed values:
image_supportenumOptional

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

Allowed values:
model_typeenumOptional
Model type.
Allowed values:
supported_paramsmap from strings to anyOptional

Computed parameter support after applying model-specific overrides.

providerobject or nullOptional

Errors

403
Forbidden Error
404
Not Found Error