Models
api/models
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/models Changed · +30 / -27 lines
### Query parameters ### Headers #### Response (200) ### Path parameters ### Headers #### Response (200) ## Domain types ### Query Parameters ### Header Parameters #### Response ### Path Parameters ### Header Parameters #### Response ## Domain Types
---- -title: Models -url: https://platform.claude.com/docs/en/api/models ---- - # Models ## List Models -**get** `/v1/models` +**GET** `/v1/models` List available models. The Models API response can be used to determine which models are available for use in the API. More recently released models are listed first. -### Query Parameters +### Query parameters - `after_id: optional string`
Defaults to `20`. Ranges from `1` to `1000`. -### Header Parameters + default: 20, maximum: 1000, minimum: 1 +### Headers + - `"anthropic-beta": optional array of AnthropicBeta` Optional header to specify the beta version(s) you want to use.
RFC 3339 datetime string representing the time at which the model was released. May be set to an epoch value if the release date is unknown. + format: date-time + - `display_name: string` A human-readable name for the model.
For Models, this is always `"model"`. - - `"model"` + default: model - `first_id: string or null`
### Example -```http +```bash curl https://api.anthropic.com/v1/models \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +#### Response (200) ```json {
## Get a Model -**get** `/v1/models/{model_id}` +**GET** `/v1/models/{model_id}` Get a specific model. The Models API response can be used to determine information about a specific model or resolve a model alias to a model ID. -### Path Parameters +### Path parameters - `model_id: string` Model identifier or alias. -### Header Parameters +### Headers - `"anthropic-beta": optional array of AnthropicBeta`
### Returns -- `ModelInfo object { id, capabilities, created_at, 4 more }` +- `ModelInfo object` - `id: string`
RFC 3339 datetime string representing the time at which the model was released. May be set to an epoch value if the release date is unknown. + format: date-time + - `display_name: string` A human-readable name for the model.
For Models, this is always `"model"`. - - `"model"` + default: model ### Example -```http +```bash curl https://api.anthropic.com/v1/models/$MODEL_ID \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_API_KEY" ``` -#### Response +#### Response (200) ```json {
} ``` -## Domain Types +## Domain types ### Capability Support -- `CapabilitySupport object { supported }` +- `CapabilitySupport object` Indicates whether a capability is supported.
### Context Management Capability -- `ContextManagementCapability object { clear_thinking_20251015, clear_tool_uses_20250919, compact_20260112, supported }` +- `ContextManagementCapability object` Context management capability details.
### Effort Capability -- `EffortCapability object { high, low, max, 3 more }` +- `EffortCapability object` Effort (reasoning_effort) capability details.
### Model Capabilities -- `ModelCapabilities object { batch, citations, code_execution, 6 more }` +- `ModelCapabilities object` Model capability information.
### Model Info -- `ModelInfo object { id, capabilities, created_at, 4 more }` +- `ModelInfo object` - `id: string`
RFC 3339 datetime string representing the time at which the model was released. May be set to an epoch value if the release date is unknown. + format: date-time + - `display_name: string` A human-readable name for the model.
For Models, this is always `"model"`. - - `"model"` + default: model ### Thinking Capability -- `ThinkingCapability object { supported, types }` +- `ThinkingCapability object` Thinking capability details.
### Thinking Types -- `ThinkingTypes object { adaptive, enabled }` +- `ThinkingTypes object` Supported thinking type configurations.