Filter model status

POST

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

POST

/api/models/:model_name/status/

$ curl -X POST https://api.respan.ai/api/models/model_name/status/ \
>      -H "Authorization: Bearer <respanApiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "start_time": "string",
>   "end_time": "string"
> }'

1 {
2   "model": "string",
3   "provider_id": "string",
4   "time_tick": "minute",
5   "start_time": "2024-01-15T09:30:00Z",
6   "end_time": "2024-01-15T09:30:00Z",
7   "data": [
8     {
9       "date_group": "2024-01-15T09:30:00Z",
10       "uptime": 1.1,
11       "total_count": 1,
12       "down_count": 1
13     }
14   ],
15   "metrics_series": [
16     {
17       "date_group": "2024-01-15T09:30:00Z",
18       "average_tps": 1.1,
19       "average_ttft": 1.1,
20       "average_latency": 1.1,
21       "cache_hit_percentage": 1.1,
22       "number_of_requests": 1,
23       "cost": 1.1
24     }
25   ],
26   "respan_uptime": [
27     {
28       "date_group": "2024-01-15T09:30:00Z",
29       "uptime": 1.1,
30       "total_count": 1,
31       "down_count": 1
32     }
33   ],
34   "status": {
35     "uptime_percent": 1.1,
36     "average_tps": 1.1,
37     "average_ttft": 1.1,
38     "average_latency": 1.1,
39     "cache_hit_percentage": 1.1,
40     "input_cost": 1.1,
41     "number_of_requests": 1,
42     "cost": 1.1,
43     "prompt_tokens": 1,
44     "completion_tokens": 1,
45     "prompt_cache_hit_tokens": 1,
46     "prompt_cache_creation_tokens": 1
47   }
48 }

POST-for-filtering model status. Manually supplied query parameters override the same body values.

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.

AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Path parameters

model_namestringRequired

Exact logged model string; provider-prefixed values may contain a slash.

Request

This endpoint expects an object.

start_timestringRequired

ISO-8601 or epoch timestamp. Raw window max 90 days.

end_timestringRequired

Timestamp after start_time.

provider_idstring or nullOptional>=1 character

time_tickenumOptionalDefaults to day

Allowed values:

Response

Model status series. Unknown model names return empty series rather than 404.

modelstring

provider_idstring or null

time_tickenum

start_timedatetime

end_timedatetime

datalist of objects

metrics_serieslist of objects

respan_uptimelist of objectsOptional

Omitted when provider_id is supplied.

statusobjectOptional

Omitted when provider_id is supplied. Volume fields are staff-only.

Errors

400

Bad Request Error

429

Too Many Requests Error