Models
>-
List the public model catalogue without authentication. With an API key, return only models and provider mappings allowed by its organization compliance policy, IAM rules, and project access, including accessible custom models. Set include_restricted=true to return the public catalogue regardless of these restrictions.
Authorization
bearerAuth Bearer token authentication using API keys
In: header
Query Parameters
Return the public catalogue instead of the authenticated caller's accessible models. Other query filters still apply. Does not grant permission to call restricted models or include private custom models.
Include deactivated models in the response
Exclude deprecated models from the response
Only return models and provider mappings whose provider does not train on API data
Return one entry per provider mapping with provider/model-id ids (the gateway's provider-pinned request format) instead of one aggregated entry per model. Each entry carries that specific mapping's pricing, context length, and capabilities.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/models"{
"data": [
{
"id": "string",
"name": "string",
"display_name": "string",
"aliases": [
"string"
],
"created": 0,
"description": "string",
"family": "string",
"architecture": {
"input_modalities": [
"text"
],
"output_modalities": [
"text"
],
"tokenizer": "string"
},
"top_provider": {
"is_moderated": true
},
"providers": [
{
"providerId": "string",
"externalId": "string",
"supportedVideoSizes": [
"string"
],
"supportsVideoAudio": true,
"supportsVideoWithoutAudio": true,
"pricing": {
"prompt": "string",
"completion": "string",
"image": "string",
"input_audio": "string",
"input_audio_cache_read": "string",
"output_audio": "string",
"per_second": {
"property1": "string",
"property2": "string"
},
"per_image": {
"property1": "string",
"property2": "string"
},
"request": "string",
"input_cache_read": "string",
"input_cache_write": "string",
"input_cache_write_1h": "string",
"ocr_page": "string",
"input_audio_hour": "string"
},
"streaming": true,
"vision": true,
"realtime": true,
"cancellation": true,
"tools": true,
"parallelToolCalls": true,
"reasoning": true,
"reasoning_efforts": [
"none"
],
"min_cacheable_tokens": 0,
"max_output": 0,
"stability": "stable"
}
],
"pricing": {
"prompt": "string",
"completion": "string",
"image": "string",
"input_audio": "string",
"input_audio_cache_read": "string",
"output_audio": "string",
"per_second": {
"property1": "string",
"property2": "string"
},
"per_image": {
"property1": "string",
"property2": "string"
},
"request": "string",
"input_cache_read": "string",
"input_cache_write": "string",
"input_cache_write_1h": "string",
"web_search": "string",
"internal_reasoning": "string",
"ocr_page": "string",
"input_audio_hour": "string"
},
"context_length": 0,
"max_output": 0,
"per_request_limits": {
"property1": "string",
"property2": "string"
},
"supported_parameters": [
"string"
],
"json_output": true,
"structured_outputs": true,
"free": true,
"deprecated_at": "string",
"deactivated_at": "string",
"stability": "stable"
}
]
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}{
"error": {
"message": "string",
"type": "string",
"param": "string",
"code": "string"
}
}How is this guide?