Retrieve a model

GET

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

GET

/api/models/:model_name/

$ curl https://api.respan.ai/api/models/model_name/ \
>      -H "Authorization: Bearer <respanApiKey>" \
>      -H "Content-Type: application/json"

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     "temperature": true,
20     "max_tokens": true,
21     "top_p": true,
22     "frequency_penalty": true,
23     "presence_penalty": true
24   },
25   "throughput": {
26     "average_tps": 12.5,
27     "average_ttft": 0.85,
28     "average_latency": 1.2,
29     "number_of_requests": 3450
30   },
31   "provider": {
32     "id": "my-vllm",
33     "provider_id": "my-vllm",
34     "provider_name": "My vLLM Server",
35     "extra_kwargs": {
36       "base_url": "https://vllm.example.com/v1",
37       "timeout_seconds": 30
38     },
39     "created_at": "2024-01-15T09:30:00Z",
40     "updated_at": "2024-04-10T16:45:00Z"
41   },
42   "created_at": "2024-01-15T09:30:00Z",
43   "updated_at": "2024-04-10T16:45:00Z"
44 }

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

Path parameters

model_namestringRequired

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

Response

Model details.

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.

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.

function_callenum

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

image_supportenum

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

sourceenum

Source of the model definition.

model_typeenum

Model type.

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

401

Unauthorized Error

404

Not Found Error