SPB Git

Repository Public

list.md 8.8 KB 397 lines markdown

1---2title: List Models3url: https://platform.claude.com/docs/en/api/beta/models/list4---56# List Models78**GET** `/v1/models`910List available models.1112The Models API response can be used to determine which models are available for use in the API. More recently released models are listed first.1314## Query parameters1516- `after_id: optional string`1718  ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.1920- `before_id: optional string`2122  ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.2324- `limit: optional number`2526  Number of items to return per page.2728  Defaults to `20`. Ranges from `1` to `1000`.2930  default: 20, maximum: 1000, minimum: 13132## Headers3334- `"anthropic-beta": optional array of AnthropicBeta`3536  Optional header to specify the beta version(s) you want to use.3738  - `string`3940  - `"message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more`4142    - `"message-batches-2024-09-24"`4344    - `"prompt-caching-2024-07-31"`4546    - `"computer-use-2024-10-22"`4748    - `"computer-use-2025-01-24"`4950    - `"pdfs-2024-09-25"`5152    - `"token-counting-2024-11-01"`5354    - `"token-efficient-tools-2025-02-19"`5556    - `"output-128k-2025-02-19"`5758    - `"files-api-2025-04-14"`5960    - `"mcp-client-2025-04-04"`6162    - `"mcp-client-2025-11-20"`6364    - `"dev-full-thinking-2025-05-14"`6566    - `"interleaved-thinking-2025-05-14"`6768    - `"code-execution-2025-05-22"`6970    - `"extended-cache-ttl-2025-04-11"`7172    - `"context-1m-2025-08-07"`7374    - `"context-management-2025-06-27"`7576    - `"model-context-window-exceeded-2025-08-26"`7778    - `"skills-2025-10-02"`7980    - `"fast-mode-2026-02-01"`8182    - `"output-300k-2026-03-24"`8384    - `"user-profiles-2026-03-24"`8586    - `"user-profiles-2026-08-18"`8788    - `"user-profiles-2026-09-04"`8990    - `"advisor-tool-2026-03-01"`9192    - `"managed-agents-2026-04-01"`9394    - `"cache-diagnosis-2026-04-07"`9596    - `"dreaming-2026-04-21"`9798    - `"thinking-token-count-2026-05-13"`99100    - `"server-side-fallback-2026-06-01"`101102    - `"server-side-fallback-2026-07-01"`103104    - `"fallback-credit-2026-06-01"`105106    - `"fallback-credit-2026-07-01"`107108    - `"agent-memory-2026-07-22"`109110    - `"mid-conversation-tool-changes-2026-07-01"`111112    - `"compact-2026-01-12"`113114    - `"computer-use-2025-11-24"`115116    - `"mcp-tunnels-2026-06-22"`117118    - `"structured-outputs-2025-11-13"`119120    - `"task-budgets-2026-03-13"`121122    - `"thinking-display-updates-2026-08-18"`123124    - `"ce-user-management-2026-07-13"`125126    - `"mid-conversation-output-config-2026-07-01"`127128    - `"thinking-binding-controls-2026-08-01"`129130    - `"mid-conversation-system-clear-at-2026-08-21"`131132    - `"compact-2026-09-04"`133134- `"anthropic-workspace-id": optional string`135136## Returns137138- `data: array of BetaModelInfo`139140  - `type: "model"`141142    Object type.143144    For Models, this is always `"model"`.145146    default: model147148  - `id: string`149150    Unique model identifier.151152  - `allowed_fallback_models: array of string or null`153154    Model IDs this model accepts as `fallbacks[i].model` on the Messages API. An empty list means the `fallbacks` parameter is not supported for this model as primary.155156  - `capabilities: BetaModelCapabilities or null`157158    Model capability information.159160    - `batch: BetaCapabilitySupport`161162      Whether the model supports the Batch API.163164      - `supported: boolean`165166        Whether this capability is supported by the model.167168    - `citations: BetaCapabilitySupport`169170      Whether the model supports citation generation.171172    - `code_execution: BetaCapabilitySupport`173174      Whether the model supports code execution tools.175176    - `compaction: BetaCompactionCapability or null`177178      Compaction capability details: whether the model accepts the top-level179      `compaction` request parameter, with one entry per supported180      `compaction.type` value.181182      - `summarize: BetaCapabilitySupport`183184        Whether the summarize compaction type is supported.185186      - `supported: boolean`187188        Whether this capability is supported by the model.189190    - `context_management: BetaContextManagementCapability`191192      Context management support and available strategies.193194      - `clear_thinking_20251015: BetaCapabilitySupport or null`195196        Indicates whether a capability is supported.197198      - `clear_tool_uses_20250919: BetaCapabilitySupport or null`199200        Indicates whether a capability is supported.201202      - `compact_20260112: BetaCapabilitySupport or null`203204        Indicates whether a capability is supported.205206      - `supported: boolean`207208        Whether this capability is supported by the model.209210    - `effort: BetaEffortCapability`211212      Effort (reasoning_effort) support and available levels.213214      - `high: BetaCapabilitySupport`215216        Whether the model supports high effort level.217218      - `low: BetaCapabilitySupport`219220        Whether the model supports low effort level.221222      - `max: BetaCapabilitySupport`223224        Whether the model supports max effort level.225226      - `medium: BetaCapabilitySupport`227228        Whether the model supports medium effort level.229230      - `supported: boolean`231232        Whether this capability is supported by the model.233234      - `xhigh: BetaCapabilitySupport or null`235236        Indicates whether a capability is supported.237238    - `image_input: BetaCapabilitySupport`239240      Whether the model accepts image content blocks.241242    - `pdf_input: BetaCapabilitySupport`243244      Whether the model accepts PDF content blocks.245246    - `structured_outputs: BetaCapabilitySupport`247248      Whether the model supports structured output / JSON mode / strict tool schemas.249250    - `thinking: BetaThinkingCapability`251252      Thinking capability and supported type configurations.253254      - `supported: boolean`255256        Whether this capability is supported by the model.257258      - `types: BetaThinkingTypes`259260        Supported thinking type configurations.261262        - `adaptive: BetaCapabilitySupport`263264          Whether the model supports thinking with type 'adaptive' (auto).265266        - `enabled: BetaCapabilitySupport`267268          Whether the model supports thinking with type 'enabled'.269270  - `created_at: string`271272    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.273274    format: date-time275276  - `display_name: string`277278    A human-readable name for the model.279280  - `max_input_tokens: number or null`281282    Maximum input context window size in tokens for this model.283284  - `max_tokens: number or null`285286    Maximum value for the `max_tokens` parameter when using this model.287288- `first_id: string or null`289290  First ID in the `data` list. Can be used as the `before_id` for the previous page.291292- `has_more: boolean`293294  Indicates if there are more results in the requested page direction.295296- `last_id: string or null`297298  Last ID in the `data` list. Can be used as the `after_id` for the next page.299300## Example301302```bash303curl https://api.anthropic.com/v1/models \304    -H 'anthropic-version: 2023-06-01' \305    -H "X-Api-Key: $ANTHROPIC_API_KEY"306```307308### Response (200)309310```json311{312  "data": [313    {314      "id": "claude-opus-5",315      "allowed_fallback_models": [316        "string"317      ],318      "capabilities": {319        "batch": {320          "supported": true321        },322        "citations": {323          "supported": true324        },325        "code_execution": {326          "supported": true327        },328        "compaction": {329          "summarize": {330            "supported": true331          },332          "supported": true333        },334        "context_management": {335          "clear_thinking_20251015": {336            "supported": true337          },338          "clear_tool_uses_20250919": {339            "supported": true340          },341          "compact_20260112": {342            "supported": true343          },344          "supported": true345        },346        "effort": {347          "high": {348            "supported": true349          },350          "low": {351            "supported": true352          },353          "max": {354            "supported": true355          },356          "medium": {357            "supported": true358          },359          "supported": true,360          "xhigh": {361            "supported": true362          }363        },364        "image_input": {365          "supported": true366        },367        "pdf_input": {368          "supported": true369        },370        "structured_outputs": {371          "supported": true372        },373        "thinking": {374          "supported": true,375          "types": {376            "adaptive": {377              "supported": true378            },379            "enabled": {380              "supported": true381            }382          }383        }384      },385      "created_at": "2026-07-24T00:00:00Z",386      "display_name": "Claude Opus 5",387      "max_input_tokens": 0,388      "max_tokens": 0,389      "type": "model"390    }391  ],392  "first_id": "first_id",393  "has_more": true,394  "last_id": "last_id"395}396```397
Files main
Menu

Theme