SPB Git

Repository Public

retrieve.md 6.8 KB 339 lines markdown

1---2title: Get a Model3url: https://platform.claude.com/docs/en/api/models/retrieve4---56# Get a Model78**GET** `/v1/models/{model_id}`910Get a specific model.1112The Models API response can be used to determine information about a specific model or resolve a model alias to a model ID.1314## Path parameters1516- `model_id: string`1718  Model identifier or alias.1920## Headers2122- `"anthropic-beta": optional array of AnthropicBeta`2324  Optional header to specify the beta version(s) you want to use.2526  - `string`2728  - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`2930    - `"message-batches-2024-09-24"`3132    - `"prompt-caching-2024-07-31"`3334    - `"computer-use-2024-10-22"`3536    - `"computer-use-2025-01-24"`3738    - `"pdfs-2024-09-25"`3940    - `"token-counting-2024-11-01"`4142    - `"token-efficient-tools-2025-02-19"`4344    - `"output-128k-2025-02-19"`4546    - `"files-api-2025-04-14"`4748    - `"mcp-client-2025-04-04"`4950    - `"mcp-client-2025-11-20"`5152    - `"dev-full-thinking-2025-05-14"`5354    - `"interleaved-thinking-2025-05-14"`5556    - `"code-execution-2025-05-22"`5758    - `"extended-cache-ttl-2025-04-11"`5960    - `"context-1m-2025-08-07"`6162    - `"context-management-2025-06-27"`6364    - `"model-context-window-exceeded-2025-08-26"`6566    - `"skills-2025-10-02"`6768    - `"fast-mode-2026-02-01"`6970    - `"output-300k-2026-03-24"`7172    - `"user-profiles-2026-03-24"`7374    - `"user-profiles-2026-08-18"`7576    - `"user-profiles-2026-09-04"`7778    - `"advisor-tool-2026-03-01"`7980    - `"managed-agents-2026-04-01"`8182    - `"cache-diagnosis-2026-04-07"`8384    - `"dreaming-2026-04-21"`8586    - `"thinking-token-count-2026-05-13"`8788    - `"server-side-fallback-2026-06-01"`8990    - `"server-side-fallback-2026-07-01"`9192    - `"fallback-credit-2026-06-01"`9394    - `"fallback-credit-2026-07-01"`9596    - `"agent-memory-2026-07-22"`9798    - `"mid-conversation-tool-changes-2026-07-01"`99100    - `"compact-2026-01-12"`101102    - `"computer-use-2025-11-24"`103104    - `"mcp-tunnels-2026-06-22"`105106    - `"structured-outputs-2025-11-13"`107108    - `"task-budgets-2026-03-13"`109110    - `"thinking-display-updates-2026-08-18"`111112    - `"ce-user-management-2026-07-13"`113114    - `"mid-conversation-output-config-2026-07-01"`115116    - `"thinking-binding-controls-2026-08-01"`117118    - `"mid-conversation-system-clear-at-2026-08-21"`119120    - `"compact-2026-09-04"`121122- `"anthropic-workspace-id": optional string`123124## Returns125126- `ModelInfo object`127128  - `type: "model"`129130    Object type.131132    For Models, this is always `"model"`.133134    default: model135136  - `id: string`137138    Unique model identifier.139140  - `capabilities: ModelCapabilities or null`141142    Model capability information.143144    - `batch: CapabilitySupport`145146      Whether the model supports the Batch API.147148      - `supported: boolean`149150        Whether this capability is supported by the model.151152    - `citations: CapabilitySupport`153154      Whether the model supports citation generation.155156    - `code_execution: CapabilitySupport`157158      Whether the model supports code execution tools.159160    - `context_management: ContextManagementCapability`161162      Context management support and available strategies.163164      - `clear_thinking_20251015: CapabilitySupport or null`165166        Indicates whether a capability is supported.167168      - `clear_tool_uses_20250919: CapabilitySupport or null`169170        Indicates whether a capability is supported.171172      - `compact_20260112: CapabilitySupport or null`173174        Indicates whether a capability is supported.175176      - `supported: boolean`177178        Whether this capability is supported by the model.179180    - `effort: EffortCapability`181182      Effort (reasoning_effort) support and available levels.183184      - `high: CapabilitySupport`185186        Whether the model supports high effort level.187188      - `low: CapabilitySupport`189190        Whether the model supports low effort level.191192      - `max: CapabilitySupport`193194        Whether the model supports max effort level.195196      - `medium: CapabilitySupport`197198        Whether the model supports medium effort level.199200      - `supported: boolean`201202        Whether this capability is supported by the model.203204      - `xhigh: CapabilitySupport or null`205206        Indicates whether a capability is supported.207208    - `image_input: CapabilitySupport`209210      Whether the model accepts image content blocks.211212    - `pdf_input: CapabilitySupport`213214      Whether the model accepts PDF content blocks.215216    - `structured_outputs: CapabilitySupport`217218      Whether the model supports structured output / JSON mode / strict tool schemas.219220    - `thinking: ThinkingCapability`221222      Thinking capability and supported type configurations.223224      - `supported: boolean`225226        Whether this capability is supported by the model.227228      - `types: ThinkingTypes`229230        Supported thinking type configurations.231232        - `adaptive: CapabilitySupport`233234          Whether the model supports thinking with type 'adaptive' (auto).235236        - `enabled: CapabilitySupport`237238          Whether the model supports thinking with type 'enabled'.239240  - `created_at: string`241242    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.243244    format: date-time245246  - `display_name: string`247248    A human-readable name for the model.249250  - `max_input_tokens: number or null`251252    Maximum input context window size in tokens for this model.253254  - `max_tokens: number or null`255256    Maximum value for the `max_tokens` parameter when using this model.257258## Example259260```bash261curl https://api.anthropic.com/v1/models/$MODEL_ID \262    -H 'anthropic-version: 2023-06-01' \263    -H "X-Api-Key: $ANTHROPIC_API_KEY"264```265266### Response (200)267268```json269{270  "id": "claude-opus-5",271  "capabilities": {272    "batch": {273      "supported": true274    },275    "citations": {276      "supported": true277    },278    "code_execution": {279      "supported": true280    },281    "context_management": {282      "clear_thinking_20251015": {283        "supported": true284      },285      "clear_tool_uses_20250919": {286        "supported": true287      },288      "compact_20260112": {289        "supported": true290      },291      "supported": true292    },293    "effort": {294      "high": {295        "supported": true296      },297      "low": {298        "supported": true299      },300      "max": {301        "supported": true302      },303      "medium": {304        "supported": true305      },306      "supported": true,307      "xhigh": {308        "supported": true309      }310    },311    "image_input": {312      "supported": true313    },314    "pdf_input": {315      "supported": true316    },317    "structured_outputs": {318      "supported": true319    },320    "thinking": {321      "supported": true,322      "types": {323        "adaptive": {324          "supported": true325        },326        "enabled": {327          "supported": true328        }329      }330    }331  },332  "created_at": "2026-07-24T00:00:00Z",333  "display_name": "Claude Opus 5",334  "max_input_tokens": 0,335  "max_tokens": 0,336  "type": "model"337}338```339
Files main
Menu

Theme