List models | Respan Docs

curl -G https://api.respan.ai/api/models/ \
     -H "Authorization: Bearer sk_live_xxxxx" \
     -H "Content-Type: application/json" \
     -d sort_by=model_name

[
  {
    "id": "my-custom-gpt-4o",
    "model_name": "my-custom-gpt-4o",
    "display_name": "My Custom GPT-4o",
    "base_model_name": "gpt-4o",
    "affiliation_category": "custom",
    "is_called_by_custom_name": false,
    "input_cost": 2.5,
    "output_cost": 10,
    "cache_hit_input_cost": 0.5,
    "cache_creation_input_cost": 3,
    "max_context_window": 128000,
    "streaming_support": 1,
    "function_call": 1,
    "image_support": 1,
    "source": "db",
    "model_type": "chat",
    "supported_params": {
      "temperature": true,
      "max_tokens": true,
      "top_p": true,
      "frequency_penalty": true,
      "presence_penalty": true
    },
    "throughput": {
      "average_tps": 12.5,
      "average_ttft": 0.75,
      "average_latency": 1.2,
      "number_of_requests": 3500
    },
    "provider": {
      "id": "my-vllm",
      "provider_id": "my-vllm",
      "provider_name": "My vLLM Server",
      "extra_kwargs": {
        "base_url": "https://vllm.example.com/v1",
        "timeout_seconds": 30
      },
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-04-10T14:45:00Z"
    },
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-04-10T14:45:00Z"
  }
]

List all models accessible to the authenticated organization, including built-in models and organization-specific custom models. For paginated filtering with throughput metrics, use /api/models/list/.

Query parameters

sort_bystringOptionalDefaults to model_name

Field to sort by. Prefix with - for descending order.

allbooleanOptionalDefaults to false

If true, return all matching models without pagination for routes that support it.

Response

List of models.

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

Headers

Query parameters

Response

Errors