List models
Lists the models the caller can use right now - the platform catalog filtered to the providers the caller has a key for, their own or the platform's. Use it to choose a model by capability before calling a generation endpoint: context_window and max_output_tokens for text models, and for image models the image block, which lists the accepted size values (or the rule they must meet) and whether background, seed, quality, n and reference images are honoured. To pick the cheapest text model, compare credits_per_1m_tokens - the rate a call is billed at. The list is cached for up to a minute per caller. Cursor-paginated (see the pagination convention): pass next_cursor back as cursor until it is null. Sorted by id ascending. Authenticate with an API key (b4m_live_) carrying ai:chat or ai:generate, or a JWT.
Request
- Base URL: https://your-deployment.example.com
- URL: https://your-deployment.example.com/api/v1/models
- Auth: one of:
- HTTP bearer
- API key in header x-api-key
Query parameters
Response
One page of models, ordered by id.
Example response
{
"data": [
{
"id": "claude-sonnet-5",
"name": "Claude Sonnet 5",
"type": "text",
"backend": "anthropic",
"description": null,
"context_window": 1000000,
"max_output_tokens": 128000,
"supports_streaming": true,
"supports_thinking": true,
"reasons_within_output_budget": true,
"reasoning_efforts": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
],
"supports_tools": true,
"supports_tool_search": true,
"supports_tool_changes": false,
"supports_vision": true,
"deprecation_date": null,
"replaced_by": null,
"image": null,
"credits_per_1m_tokens": {
"input": 6000,
"output": 30000,
"cached_input": 600
}
},
{
"id": "gpt-image-1",
"name": "GPT Image 1",
"type": "image",
"backend": "openai",
"description": null,
"context_window": 0,
"max_output_tokens": 0,
"supports_streaming": false,
"supports_thinking": false,
"reasons_within_output_budget": false,
"reasoning_efforts": [],
"supports_tools": false,
"supports_tool_search": false,
"supports_tool_changes": false,
"supports_vision": false,
"deprecation_date": null,
"replaced_by": null,
"credits_per_1m_tokens": null,
"image": {
"sizing": {
"kind": "presets",
"presets": [
"1024x1024",
"1024x1536",
"1536x1024"
],
"default_size": "1024x1024"
},
"supports": {
"transparent_background": true,
"seed": false,
"qualities": [
"low",
"medium",
"high",
"auto"
],
"max_images": 10,
"max_reference_images": 15,
"edit": true,
"requires_input_image": false
}
}
}
],
"next_cursor": null
}Changes
No recorded changes to this operation across all 1 revision of this API.