Get model status
https://api.respan.ai/api/models/{model_name}/status/Get public uptime and normalized performance metrics for an exact logged model string. Authentication is optional. Public callers receive redacted volume fields.
Servers
https://api.respan.ai: Respan API Server
Authentication
Authentication is optional.
RespanApiKey
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.
HTTP scheme: bearer; format: Respan API key.
Authorization: Bearer $RESPAN_API_KEYOr:
DashboardJwt
Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.
HTTP scheme: bearer; format: Dashboard JWT.
Authorization: Bearer $RESPAN_DASHBOARD_JWTPath parameters
model_name string RequiredQuery parameters
provider_id string or null Optional1start_time string Requiredend_time string Requiredtime_tick string Optional"minute", "hour", "day"Default:
dayResponses
200
Model status series. Unknown model names return empty series rather than 404.
application/json
$ object Body
#/components/schemas/ModelStatusResponsemodel string Required in parentprovider_id string or null Required in parenttime_tick string Required in parent"minute", "hour", "day"start_time string Required in parentdate-timeend_time string Required in parentdate-timedata array<object> Required in parent
data[] object Array item
#/components/schemas/ModelStatusUptimeBucketdata[].date_group string Required in parentdate-timedata[].uptime number or null Required in parentdata[].total_count integer Optionaldata[].down_count integer Optionalrespan_uptime array<object> Optional
respan_uptime[] object Array item
#/components/schemas/ModelStatusUptimeBucketrespan_uptime[].date_group string Required in parentdate-timerespan_uptime[].uptime number or null Required in parentrespan_uptime[].total_count integer Optionalrespan_uptime[].down_count integer Optionalmetrics_series array<object> Required in parent
metrics_series[] object Array item
#/components/schemas/ModelStatusMetricBucketmetrics_series[].date_group string Required in parentdate-timemetrics_series[].average_tps number or null Optionalmetrics_series[].average_ttft number or null Optionalmetrics_series[].average_latency number or null Optionalmetrics_series[].cache_hit_percentage number or null Optionalmetrics_series[].number_of_requests integer Optionalmetrics_series[].cost number or null Optionalstatus object Optional
status.uptime_percent number or null Optionalstatus.average_tps number or null Optionalstatus.average_ttft number or null Optionalstatus.average_latency number or null Optionalstatus.cache_hit_percentage number or null Optionalstatus.input_cost number or null Optionalstatus.number_of_requests integer Optionalstatus.cost number or null Optionalstatus.prompt_tokens integer Optionalstatus.completion_tokens integer Optionalstatus.prompt_cache_hit_tokens integer Optionalstatus.prompt_cache_creation_tokens integer OptionalOpenAPI response schema
{
"$ref": "#/components/schemas/ModelStatusResponse"
}400
Invalid timestamps, range, provider, or time tick.
application/json
$ object BodyOpenAPI response schema
{
"type": "object",
"additionalProperties": true
}429
Anonymous callers are limited to 30 requests per minute per IP.
application/json
$ object BodyOpenAPI response schema
{
"type": "object",
"additionalProperties": true
}OpenAPI source
The operation and referenced components below retain the complete OpenAPI definitions, including constraints and examples.
OpenAPI operation
{
"summary": "Get model status",
"operationId": "api_models_status_retrieve",
"tags": [
"Models"
],
"description": "Get public uptime and normalized performance metrics for an exact logged model string. Authentication is optional. Public callers receive redacted volume fields.",
"parameters": [
{
"name": "model_name",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Exact logged model string; provider-prefixed values may contain a slash."
},
{
"name": "provider_id",
"in": "query",
"required": false,
"schema": {
"type": "string",
"nullable": true,
"minLength": 1
}
},
{
"name": "start_time",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "ISO-8601 or epoch timestamp. Raw window max 90 days."
}
},
{
"name": "end_time",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "Timestamp after start_time."
}
},
{
"name": "time_tick",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"minute",
"hour",
"day"
],
"default": "day"
}
}
],
"responses": {
"200": {
"description": "Model status series. Unknown model names return empty series rather than 404.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelStatusResponse"
}
}
}
},
"400": {
"description": "Invalid timestamps, range, provider, or time tick.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"429": {
"description": "Anonymous callers are limited to 30 requests per minute per IP.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"security": [
{},
{
"RespanApiKey": []
},
{
"DashboardJwt": []
}
]
}OpenAPI path metadata
{}Referenced OpenAPI components
{
"schemas": {
"ModelStatusMetricBucket": {
"type": "object",
"required": [
"date_group"
],
"properties": {
"date_group": {
"type": "string",
"format": "date-time"
},
"average_tps": {
"type": "number",
"nullable": true
},
"average_ttft": {
"type": "number",
"nullable": true
},
"average_latency": {
"type": "number",
"nullable": true
},
"cache_hit_percentage": {
"type": "number",
"nullable": true
},
"number_of_requests": {
"type": "integer",
"description": "Staff-only."
},
"cost": {
"type": "number",
"nullable": true,
"description": "Staff-only."
}
}
},
"ModelStatusResponse": {
"type": "object",
"required": [
"model",
"provider_id",
"time_tick",
"start_time",
"end_time",
"data",
"metrics_series"
],
"properties": {
"model": {
"type": "string"
},
"provider_id": {
"type": "string",
"nullable": true
},
"time_tick": {
"type": "string",
"enum": [
"minute",
"hour",
"day"
]
},
"start_time": {
"type": "string",
"format": "date-time"
},
"end_time": {
"type": "string",
"format": "date-time"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelStatusUptimeBucket"
}
},
"respan_uptime": {
"type": "array",
"description": "Omitted when provider_id is supplied.",
"items": {
"$ref": "#/components/schemas/ModelStatusUptimeBucket"
}
},
"metrics_series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ModelStatusMetricBucket"
}
},
"status": {
"type": "object",
"description": "Omitted when provider_id is supplied. Volume fields are staff-only.",
"properties": {
"uptime_percent": {
"type": "number",
"nullable": true
},
"average_tps": {
"type": "number",
"nullable": true
},
"average_ttft": {
"type": "number",
"nullable": true
},
"average_latency": {
"type": "number",
"nullable": true
},
"cache_hit_percentage": {
"type": "number",
"nullable": true
},
"input_cost": {
"type": "number",
"nullable": true
},
"number_of_requests": {
"type": "integer"
},
"cost": {
"type": "number",
"nullable": true
},
"prompt_tokens": {
"type": "integer"
},
"completion_tokens": {
"type": "integer"
},
"prompt_cache_hit_tokens": {
"type": "integer"
},
"prompt_cache_creation_tokens": {
"type": "integer"
}
}
}
}
},
"ModelStatusUptimeBucket": {
"type": "object",
"required": [
"date_group",
"uptime"
],
"properties": {
"date_group": {
"type": "string",
"format": "date-time"
},
"uptime": {
"type": "number",
"nullable": true
},
"total_count": {
"type": "integer",
"description": "Staff-only."
},
"down_count": {
"type": "integer",
"description": "Staff-only."
}
}
}
},
"securitySchemes": {
"DashboardJwt": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "Dashboard JWT",
"description": "Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.",
"x-fern-bearer": {
"name": "dashboardJwt",
"env": "RESPAN_DASHBOARD_JWT"
}
},
"RespanApiKey": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "Respan API key",
"description": "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.",
"x-fern-bearer": {
"name": "respanApiKey",
"env": "RESPAN_API_KEY"
}
}
}
}