For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DiscordPlatform
DocumentationIntegrationsAPI referenceSDKsChangelog
DocumentationIntegrationsAPI referenceSDKsChangelog
  • API Reference
      • GETGet models summary
      • POSTFilter models summary
      • GETList models with filters
      • POSTFilter models
      • GETList public model catalog
      • GETList models
      • POSTCreate or update a custom model
      • GETRetrieve a model
      • PATCHUpdate a custom model
      • DELDelete a custom model
      • GETList custom providers
      • POSTCreate a custom provider
      • GETRetrieve a custom provider
      • PATCHUpdate a custom provider
      • DELDelete a custom provider
      • PUTReplace a custom model
      • PUTReplace a custom provider
  • Reference
    • Filters API Reference
LogoLogo
DiscordPlatform
API ReferenceModels

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 sk_live_xxxxx" \
>     -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": 45.7,
27    "average_ttft": 0.85,
28    "average_latency": 1.2,
29    "number_of_requests": 1245
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-10T11:45:00Z"
41  },
42  "created_at": "2024-01-15T09:30:00Z",
43  "updated_at": "2024-04-10T11:45:00Z"
44}

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

Was this page helpful?
Previous

Update a custom model

Next
Built with

Path parameters

model_namestringRequired

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

Headers

AuthorizationstringRequired

Bearer token. Use Bearer YOUR_API_KEY for API key auth or Bearer <JWT> for dashboard auth.

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.

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

401
Unauthorized Error
404
Not Found Error