Skip to main content
GET
Get a model's full metadata
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/getDetail?id=<modelId> returns one catalog model’s full metadata, as the Console’s model detail page shows it.

Authority

You need agents:read at the platform scope; a grant only at an org unit is a recorded 403. id is required once and is at most 128 characters: a missing, repeated or longer id is 400 bad_request. An unknown model is 404 resource_missing (Model not found); an unavailable catalog is a 500, never a 404.

What it returns

  • The seven Model fields GET /api/v2/models/get returns: modelId, provider, displayName, contextWindow, maxTokens, isActive, status.
  • brand, description, family, releaseDate, reasoning, inputTypes, outputTypes, supportedFeatures (vision, codeExecution, toolUse, structuredOutput, streaming, extendedThinking), deprecationDate, tags, createdAt, updatedAt, and synced (a provider sync maintains the row).
  • pricing: costInput, costOutput, costCachedInput (per 1M tokens) and pricingVerifiedAt, only when you also hold gateway:read at the platform scope. Otherwise pricing is null.
An unset value is null (a list is []). Never the row’s storage id, provider attributes, sync source or pricing provenance. Which agents use the model is GET /api/v2/agents/list?modelId=.

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

The model's modelId, for example anthropic/claude-opus-4.

Required string length: 1 - 128

Response

Model detail

data
object
required
meta
object
required