--- title: Models url: https://platform.claude.com/docs/en/api/php/beta/models --- # Models ## List Models `$client->beta->models->list(?string afterID, ?string beforeID, ?list lifecycle, ?int limit, ?list betas, ?string workspaceID): Page` **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. ### Parameters - `afterID?: optional string` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `beforeID?: optional string` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `lifecycle?: optional list` (query parameter) Filter the list to models in any of the given lifecycle stages (`active`, `deprecated`, or `retired`). Up to 3 values. When omitted, the list contains the `active` and `deprecated` models; `retired` models appear only when `retired` is requested explicitly. - `limit?: optional int` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. default: 20 - `betas?: optional list` (header parameter) Optional header to specify the beta version(s) you want to use. - `workspaceID?: optional string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaModelInfo` - `"model" type` Object type. For Models, this is always `"model"`. - `string id` Unique model identifier. - `?list allowedFallbackModels` 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. - `?BetaModelCapabilities capabilities` Object mapping capability names to their support details. Keys are always present for all known capabilities. - `\Datetime createdAt` 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. - `?\Datetime deprecatedAt` RFC 3339 datetime string representing the time of the model's most recent deprecation. Populated for `deprecated` and `retired` models; `null` while the model is `active`. - `string displayName` A human-readable name for the model. - `Lifecycle lifecycle` The model's current lifecycle stage. - `active`: The model is available for use, open to new adopters, and not scheduled for retirement. - `deprecated`: The model remains callable for organizations with existing access, but is headed for retirement and closed to new adopters. - `retired`: The model is no longer available for use; inference requests naming it fail. It remains in the catalogue as the historical record of its retirement. - `?BetaModelLine line` The model line this model belongs to, such as `opus` for both Claude Opus 4.5 and Claude Opus 4.6. More lines may be added. `null` when the model belongs to no line; do not infer a line from the `id`. - `?int maxInputTokens` Maximum input context window size in tokens for this model. - `?int maxTokens` Maximum value for the `max_tokens` parameter when using this model. - `?\Datetime retiresAt` RFC 3339 datetime string representing the model's currently scheduled retirement date. The schedule can be revised until retirement occurs; `null` while the model is `active` or while no retirement is scheduled. A past date on a `deprecated` model means retirement is overdue, not that it has occurred: `lifecycle` is the retirement signal. ### Example ```php beta->models->list( afterID: 'after_id', beforeID: 'before_id', lifecycle: ['active'], limit: 1, betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy', ); var_dump($page); ``` #### Response (200) ```json { "data": [ { "id": "claude-opus-5-5", "allowed_fallback_models": [ "string" ], "capabilities": { "batch": { "supported": true }, "citations": { "supported": true }, "code_execution": { "supported": true }, "compaction": { "summarize": { "supported": true }, "supported": true }, "context_management": { "clear_thinking_20251015": { "supported": true }, "clear_tool_uses_20250919": { "supported": true }, "compact_20260112": { "supported": true }, "supported": true }, "effort": { "high": { "supported": true }, "low": { "supported": true }, "max": { "supported": true }, "medium": { "supported": true }, "supported": true, "xhigh": { "supported": true } }, "image_input": { "supported": true }, "pdf_input": { "supported": true }, "server_tools": { "code_execution": { "supported": true }, "supported": true, "web_search": { "supported": true } }, "structured_outputs": { "supported": true }, "thinking": { "supported": true, "types": { "adaptive": { "supported": true }, "between_tools": { "supported": true }, "disabled": { "supported": true }, "enabled": { "supported": true } } } }, "created_at": "2026-09-21T00:00:00Z", "deprecated_at": "2019-12-27T18:11:19.117Z", "display_name": "Claude Opus 5.5", "lifecycle": "active", "line": "opus", "max_input_tokens": 0, "max_tokens": 0, "retires_at": "2019-12-27T18:11:19.117Z", "type": "model" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ## Get a Model `$client->beta->models->retrieve(string modelID, ?list betas, ?string workspaceID): BetaModelInfo` **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. ### Parameters - `modelID: string` (path parameter) Model identifier or alias. - `betas?: optional list` (header parameter) Optional header to specify the beta version(s) you want to use. - `workspaceID?: optional string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaModelInfo` - `"model" type` Object type. For Models, this is always `"model"`. - `string id` Unique model identifier. - `?list allowedFallbackModels` 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. - `?BetaModelCapabilities capabilities` Object mapping capability names to their support details. Keys are always present for all known capabilities. - `\Datetime createdAt` 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. - `?\Datetime deprecatedAt` RFC 3339 datetime string representing the time of the model's most recent deprecation. Populated for `deprecated` and `retired` models; `null` while the model is `active`. - `string displayName` A human-readable name for the model. - `Lifecycle lifecycle` The model's current lifecycle stage. - `active`: The model is available for use, open to new adopters, and not scheduled for retirement. - `deprecated`: The model remains callable for organizations with existing access, but is headed for retirement and closed to new adopters. - `retired`: The model is no longer available for use; inference requests naming it fail. It remains in the catalogue as the historical record of its retirement. - `?BetaModelLine line` The model line this model belongs to, such as `opus` for both Claude Opus 4.5 and Claude Opus 4.6. More lines may be added. `null` when the model belongs to no line; do not infer a line from the `id`. - `?int maxInputTokens` Maximum input context window size in tokens for this model. - `?int maxTokens` Maximum value for the `max_tokens` parameter when using this model. - `?\Datetime retiresAt` RFC 3339 datetime string representing the model's currently scheduled retirement date. The schedule can be revised until retirement occurs; `null` while the model is `active` or while no retirement is scheduled. A past date on a `deprecated` model means retirement is overdue, not that it has occurred: `lifecycle` is the retirement signal. ### Example ```php beta->models->retrieve( 'model_id', betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy', ); var_dump($betaModelInfo); ``` #### Response (200) ```json { "id": "claude-opus-5-5", "allowed_fallback_models": [ "string" ], "capabilities": { "batch": { "supported": true }, "citations": { "supported": true }, "code_execution": { "supported": true }, "compaction": { "summarize": { "supported": true }, "supported": true }, "context_management": { "clear_thinking_20251015": { "supported": true }, "clear_tool_uses_20250919": { "supported": true }, "compact_20260112": { "supported": true }, "supported": true }, "effort": { "high": { "supported": true }, "low": { "supported": true }, "max": { "supported": true }, "medium": { "supported": true }, "supported": true, "xhigh": { "supported": true } }, "image_input": { "supported": true }, "pdf_input": { "supported": true }, "server_tools": { "code_execution": { "supported": true }, "supported": true, "web_search": { "supported": true } }, "structured_outputs": { "supported": true }, "thinking": { "supported": true, "types": { "adaptive": { "supported": true }, "between_tools": { "supported": true }, "disabled": { "supported": true }, "enabled": { "supported": true } } } }, "created_at": "2026-09-21T00:00:00Z", "deprecated_at": "2019-12-27T18:11:19.117Z", "display_name": "Claude Opus 5.5", "lifecycle": "active", "line": "opus", "max_input_tokens": 0, "max_tokens": 0, "retires_at": "2019-12-27T18:11:19.117Z", "type": "model" } ``` ## Domain types ### Beta Capability Support - `class BetaCapabilitySupport` - `bool supported` Whether this capability is supported by the model. ### Beta Compaction Capability - `class BetaCompactionCapability` - `BetaCapabilitySupport summarize` Whether the summarize compaction type is supported. - `bool supported` Whether this capability is supported by the model. ### Beta Context Management Capability - `class BetaContextManagementCapability` - `?BetaCapabilitySupport clearThinking20251015` Whether the clear_thinking_20251015 strategy is supported. - `?BetaCapabilitySupport clearToolUses20250919` Whether the clear_tool_uses_20250919 strategy is supported. - `?BetaCapabilitySupport compact20260112` Whether the compact_20260112 strategy is supported. - `bool supported` Whether this capability is supported by the model. ### Beta Effort Capability - `class BetaEffortCapability` - `BetaCapabilitySupport high` Whether the model supports high effort level. - `BetaCapabilitySupport low` Whether the model supports low effort level. - `BetaCapabilitySupport max` Whether the model supports max effort level. - `BetaCapabilitySupport medium` Whether the model supports medium effort level. - `bool supported` Whether this capability is supported by the model. - `?BetaCapabilitySupport xhigh` Whether the model supports xhigh effort level. ### Beta Model Capabilities - `class BetaModelCapabilities` - `BetaCapabilitySupport batch` Whether the model supports the Batch API. - `BetaCapabilitySupport citations` Whether the model supports citation generation. - `BetaCapabilitySupport codeExecution` Whether code that the model runs in the code execution tool can call the request's other tools, as in programmatic tool calling and dynamic filtering for web search and web fetch. Support for the code execution tool itself is in `server_tools.code_execution`. - `?BetaCompactionCapability compaction` Server-side compaction support (the top-level `compaction` parameter) and the accepted `compaction.type` values. - `BetaContextManagementCapability contextManagement` Context management support and available strategies. - `BetaEffortCapability effort` Effort (reasoning_effort) support and available levels. - `BetaCapabilitySupport imageInput` Whether the model accepts image content blocks. - `BetaCapabilitySupport pdfInput` Whether the model accepts PDF content blocks. - `BetaServerToolsCapability serverTools` Whether this model supports the web search and code execution server tools. `supported` is true when the model supports at least one of the tools. A supported tool can still be rejected for your organization, for example when an admin has turned web search off. - `BetaCapabilitySupport structuredOutputs` Whether the model supports structured output / JSON mode / strict tool schemas. - `BetaThinkingCapability thinking` Thinking capability and supported type configurations. ### Beta Model Info - `class BetaModelInfo` - `"model" type` Object type. For Models, this is always `"model"`. - `string id` Unique model identifier. - `?list allowedFallbackModels` 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. - `?BetaModelCapabilities capabilities` Object mapping capability names to their support details. Keys are always present for all known capabilities. - `\Datetime createdAt` 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. - `?\Datetime deprecatedAt` RFC 3339 datetime string representing the time of the model's most recent deprecation. Populated for `deprecated` and `retired` models; `null` while the model is `active`. - `string displayName` A human-readable name for the model. - `Lifecycle lifecycle` The model's current lifecycle stage. - `active`: The model is available for use, open to new adopters, and not scheduled for retirement. - `deprecated`: The model remains callable for organizations with existing access, but is headed for retirement and closed to new adopters. - `retired`: The model is no longer available for use; inference requests naming it fail. It remains in the catalogue as the historical record of its retirement. - `?BetaModelLine line` The model line this model belongs to, such as `opus` for both Claude Opus 4.5 and Claude Opus 4.6. More lines may be added. `null` when the model belongs to no line; do not infer a line from the `id`. - `?int maxInputTokens` Maximum input context window size in tokens for this model. - `?int maxTokens` Maximum value for the `max_tokens` parameter when using this model. - `?\Datetime retiresAt` RFC 3339 datetime string representing the model's currently scheduled retirement date. The schedule can be revised until retirement occurs; `null` while the model is `active` or while no retirement is scheduled. A past date on a `deprecated` model means retirement is overdue, not that it has occurred: `lifecycle` is the retirement signal. ### Beta Model Line - `enum BetaModelLine` - `"haiku"` - `"sonnet"` - `"opus"` - `"fable"` - `"mythos"` ### Beta Server Tools Capability - `class BetaServerToolsCapability` - `BetaCapabilitySupport codeExecution` Whether the model supports the code execution tool: true when the model supports at least one version of the tool, not necessarily every version. - `bool supported` Whether this capability is supported by the model. - `BetaCapabilitySupport webSearch` Whether the model supports the web search tool: true when the model supports at least one version of the tool, not necessarily every version. ### Beta Thinking Capability - `class BetaThinkingCapability` - `bool supported` Whether this capability is supported by the model. - `BetaThinkingTypes types` Supported thinking type configurations. ### Beta Thinking Types - `class BetaThinkingTypes` - `BetaCapabilitySupport adaptive` Whether the model accepts thinking with type 'adaptive' (the model decides whether and how much to think). - `BetaCapabilitySupport betweenTools` Whether the model accepts thinking with type 'between_tools' (thinking turned off, and any short progress updates the model writes between tool calls come back as thinking blocks). False exactly when a request that sends it gets a 400 from this model. A request that sends 'between_tools' can still be rejected for another reason, such as an effort level the model does not allow with thinking off. - `BetaCapabilitySupport disabled` Whether the model accepts thinking with type 'disabled' (thinking turned off). False exactly when a request that sends it gets a 400 from this model. True on a model that does not support thinking. A request that sends 'disabled' can still be rejected for another reason, such as an effort level the model does not allow with thinking off. - `BetaCapabilitySupport enabled` Whether the model accepts thinking with type 'enabled' (extended thinking with a caller-set `budget_tokens`).