Skip to main content
GET
List model catalog entries
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/models/list returns the catalog entries in data, with meta.requestId, in one response without limit, or in pages of limit with cursor. The catalog is global: every caller with agents:read sees the same entries. Optional parameters filter like the Console’s models page: provider and status (active, deprecated, preview; each repeatable), isActive (true or false) and search (matched against the model id, display name, description and tags). status=active means active and neither deprecated nor preview. sort=name orders by display name (else model id); createdAt and updatedAt order newest first. Without sort, the catalog order is kept. A repeated isActive, search or sort, or an unknown value, is 400 bad_request. Each item in data is a Model object: exactly modelId, provider, displayName, contextWindow, maxTokens, isActive, and status. Every field is present; displayName, contextWindow, maxTokens, and status are null when the catalog records no value. isActive and status are recorded catalog state, not a guarantee that an agent can run on the model. Pricing, pricing provenance, provider attributes, synchronization details, internal identifiers (including the former id), and agent usage (assignedAgents, agentCount) are not returned. See Models.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

provider
string[]

Only models from one of these providers. Repeatable.

Required string length: 1 - 128
status
enum<string>[]

Only models in one of these states, as the Console's filter. Repeatable.

Available options:
active,
deprecated,
preview
isActive
boolean

Only active (true) or inactive (false) models.

A case-insensitive substring of the model id, name, description or tags.

Required string length: 1 - 200
sort
enum<string>

The order; without it the catalog order is kept.

Available options:
name,
createdAt,
updatedAt
limit
integer

Items per page, 1 to 1000; a larger value is a 400 too_big. Omitted, the page is the whole list. The list is read whole.

Required range: 1 <= x <= 1000
cursor
string

The previous page's meta.nextCursor; any other value is 400.

Minimum string length: 1

Response

Model list

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.