Filter models

POST

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

POST

/api/models/list/

$ curl -X POST "https://api.respan.ai/api/models/list/?sort_by=model_name" \
>      -H "Authorization: Bearer <respanApiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "filters": {
>     "affiliation_category": {
>       "operator": "in",
>       "value": [
>         "custom"
>       ]
>     }
>   }
> }'

1 {
2   "count": 150,
3   "results": [
4     {
5       "id": "my-custom-gpt-4o",
6       "model_name": "my-custom-gpt-4o",
7       "display_name": "My Custom GPT-4o",
8       "base_model_name": "gpt-4o",
9       "affiliation_category": "custom",
10       "is_called_by_custom_name": false,
11       "input_cost": 2.5,
12       "output_cost": 10,
13       "cache_hit_input_cost": 0.5,
14       "cache_creation_input_cost": 3,
15       "max_context_window": 128000,
16       "streaming_support": 1,
17       "function_call": 1,
18       "image_support": 1,
19       "source": "db",
20       "model_type": "chat",
21       "supported_params": {},
22       "throughput": {
23         "average_tps": 1.1,
24         "average_ttft": 0.9,
25         "average_latency": 1.3,
26         "number_of_requests": 1250
27       },
28       "provider": {
29         "id": "my-vllm",
30         "provider_id": "my-vllm",
31         "provider_name": "My vLLM Server",
32         "extra_kwargs": {
33           "base_url": "https://vllm.example.com/v1"
34         },
35         "created_at": "2024-01-15T09:30:00Z",
36         "updated_at": "2024-04-10T12:00:00Z"
37       },
38       "created_at": "2024-01-15T09:30:00Z",
39       "updated_at": "2024-04-10T12:00:00Z"
40     }
41   ],
42   "next": "https://api.respan.ai/api/models/list/?page=2&page_size=20",
43   "previous": "https://api.respan.ai/api/models/list/?page=1&page_size=20",
44   "current_filters": {}
45 }

List models using POST-for-filtering.

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.

Query parameters

pageintegerOptional>=1

Page number.

page_sizeintegerOptional1-100

Number of results to return per page. Maximum 100.

sort_bystringOptionalDefaults to model_name

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

Request

This endpoint expects an object.

filtersobjectOptional

Filter criteria using the standard Respan filter format.

is_exportingbooleanOptionalDefaults to false

Reserved for dashboard exports.

Response

Paginated filtered list of models.

countinteger

Total number of matching models.

resultslist of objects

nextstring or null

URL for the next page, if any.

previousstring or null

URL for the previous page, if any.

current_filtersobject

Normalized filters applied to this request.

Errors

400

Bad Request Error

401

Unauthorized Error