Skip to main content
GET
Get a model by ID
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/get?id=<modelId> returns one catalog entry in data, with meta.requestId. A missing id or an unknown modelId answers 404 resource_missing. 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. The full metadata, and the rates for a gateway:read holder, are GET /api/v2/models/getDetail.

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.

Path Parameters

modelId
string
required

Response

Model detail

data
object
required

Public model catalog entry. isActive and status are the catalog's recorded state, not an execution guarantee for any agent. Absent optional metadata is null.

meta
object
required