SPB Git
spboucher.ai

Repository Public

spbdoc-api

models.md 26.0 KB

# title: Models url: https://platform.claude.com/docs/en/api/beta/models

# Models

# List 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

  • after_id: optional string

    ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.

  • before_id: optional string

    ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

  • limit: optional number

    Number of items to return per page.

    Defaults to 20. Ranges from 1 to 1000.

    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.

    • string

    • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more

      • "message-batches-2024-09-24"

      • "prompt-caching-2024-07-31"

      • "computer-use-2024-10-22"

      • "computer-use-2025-01-24"

      • "pdfs-2024-09-25"

      • "token-counting-2024-11-01"

      • "token-efficient-tools-2025-02-19"

      • "output-128k-2025-02-19"

      • "files-api-2025-04-14"

      • "mcp-client-2025-04-04"

      • "mcp-client-2025-11-20"

      • "dev-full-thinking-2025-05-14"

      • "interleaved-thinking-2025-05-14"

      • "code-execution-2025-05-22"

      • "extended-cache-ttl-2025-04-11"

      • "context-1m-2025-08-07"

      • "context-management-2025-06-27"

      • "model-context-window-exceeded-2025-08-26"

      • "skills-2025-10-02"

      • "fast-mode-2026-02-01"

      • "output-300k-2026-03-24"

      • "user-profiles-2026-03-24"

      • "user-profiles-2026-08-18"

      • "user-profiles-2026-09-04"

      • "advisor-tool-2026-03-01"

      • "managed-agents-2026-04-01"

      • "cache-diagnosis-2026-04-07"

      • "dreaming-2026-04-21"

      • "thinking-token-count-2026-05-13"

      • "server-side-fallback-2026-06-01"

      • "server-side-fallback-2026-07-01"

      • "fallback-credit-2026-06-01"

      • "fallback-credit-2026-07-01"

      • "agent-memory-2026-07-22"

      • "mid-conversation-tool-changes-2026-07-01"

      • "compact-2026-01-12"

      • "computer-use-2025-11-24"

      • "mcp-tunnels-2026-06-22"

      • "structured-outputs-2025-11-13"

      • "task-budgets-2026-03-13"

      • "thinking-display-updates-2026-08-18"

      • "ce-user-management-2026-07-13"

      • "mid-conversation-output-config-2026-07-01"

      • "thinking-binding-controls-2026-08-01"

      • "mid-conversation-system-clear-at-2026-08-21"

      • "compact-2026-09-04"

  • "anthropic-workspace-id": optional string

# Returns

  • data: array of BetaModelInfo

    • type: "model"

      Object type.

      For Models, this is always "model".

      default: model

    • id: string

      Unique model identifier.

    • allowed_fallback_models: array of string or null

      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.

    • capabilities: BetaModelCapabilities or null

      Model capability information.

      • batch: BetaCapabilitySupport

        Whether the model supports the Batch API.

        • supported: boolean

          Whether this capability is supported by the model.

      • citations: BetaCapabilitySupport

        Whether the model supports citation generation.

      • code_execution: BetaCapabilitySupport

        Whether the model supports code execution tools.

      • compaction: BetaCompactionCapability or null

        Compaction capability details: whether the model accepts the top-level compaction request parameter, with one entry per supported compaction.type value.

        • summarize: BetaCapabilitySupport

          Whether the summarize compaction type is supported.

        • supported: boolean

          Whether this capability is supported by the model.

      • context_management: BetaContextManagementCapability

        Context management support and available strategies.

        • clear_thinking_20251015: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

        • clear_tool_uses_20250919: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

        • compact_20260112: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

        • supported: boolean

          Whether this capability is supported by the model.

      • effort: BetaEffortCapability

        Effort (reasoning_effort) support and available levels.

        • high: BetaCapabilitySupport

          Whether the model supports high effort level.

        • low: BetaCapabilitySupport

          Whether the model supports low effort level.

        • max: BetaCapabilitySupport

          Whether the model supports max effort level.

        • medium: BetaCapabilitySupport

          Whether the model supports medium effort level.

        • supported: boolean

          Whether this capability is supported by the model.

        • xhigh: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

      • image_input: BetaCapabilitySupport

        Whether the model accepts image content blocks.

      • pdf_input: BetaCapabilitySupport

        Whether the model accepts PDF content blocks.

      • structured_outputs: BetaCapabilitySupport

        Whether the model supports structured output / JSON mode / strict tool schemas.

      • thinking: BetaThinkingCapability

        Thinking capability and supported type configurations.

        • supported: boolean

          Whether this capability is supported by the model.

        • types: BetaThinkingTypes

          Supported thinking type configurations.

          • adaptive: BetaCapabilitySupport

            Whether the model supports thinking with type 'adaptive' (auto).

          • enabled: BetaCapabilitySupport

            Whether the model supports thinking with type 'enabled'.

    • created_at: 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.

    • max_input_tokens: number or null

      Maximum input context window size in tokens for this model.

    • max_tokens: number or null

      Maximum value for the max_tokens parameter when using this model.

  • first_id: string or null

    First ID in the data list. Can be used as the before_id for the previous page.

  • has_more: boolean

    Indicates if there are more results in the requested page direction.

  • last_id: string or null

    Last ID in the data list. Can be used as the after_id for the next page.

# Example

bash
curl https://api.anthropic.com/v1/models \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

# Response (200)

json
{
  "data": [
    {
      "id": "claude-opus-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
        },
        "structured_outputs": {
          "supported": true
        },
        "thinking": {
          "supported": true,
          "types": {
            "adaptive": {
              "supported": true
            },
            "enabled": {
              "supported": true
            }
          }
        }
      },
      "created_at": "2026-07-24T00:00:00Z",
      "display_name": "Claude Opus 5",
      "max_input_tokens": 0,
      "max_tokens": 0,
      "type": "model"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

# Get a Model

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

  • model_id: string

    Model identifier or alias.

# Headers

  • "anthropic-beta": optional array of AnthropicBeta

    Optional header to specify the beta version(s) you want to use.

    • string

    • "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 43 more

      • "message-batches-2024-09-24"

      • "prompt-caching-2024-07-31"

      • "computer-use-2024-10-22"

      • "computer-use-2025-01-24"

      • "pdfs-2024-09-25"

      • "token-counting-2024-11-01"

      • "token-efficient-tools-2025-02-19"

      • "output-128k-2025-02-19"

      • "files-api-2025-04-14"

      • "mcp-client-2025-04-04"

      • "mcp-client-2025-11-20"

      • "dev-full-thinking-2025-05-14"

      • "interleaved-thinking-2025-05-14"

      • "code-execution-2025-05-22"

      • "extended-cache-ttl-2025-04-11"

      • "context-1m-2025-08-07"

      • "context-management-2025-06-27"

      • "model-context-window-exceeded-2025-08-26"

      • "skills-2025-10-02"

      • "fast-mode-2026-02-01"

      • "output-300k-2026-03-24"

      • "user-profiles-2026-03-24"

      • "user-profiles-2026-08-18"

      • "user-profiles-2026-09-04"

      • "advisor-tool-2026-03-01"

      • "managed-agents-2026-04-01"

      • "cache-diagnosis-2026-04-07"

      • "dreaming-2026-04-21"

      • "thinking-token-count-2026-05-13"

      • "server-side-fallback-2026-06-01"

      • "server-side-fallback-2026-07-01"

      • "fallback-credit-2026-06-01"

      • "fallback-credit-2026-07-01"

      • "agent-memory-2026-07-22"

      • "mid-conversation-tool-changes-2026-07-01"

      • "compact-2026-01-12"

      • "computer-use-2025-11-24"

      • "mcp-tunnels-2026-06-22"

      • "structured-outputs-2025-11-13"

      • "task-budgets-2026-03-13"

      • "thinking-display-updates-2026-08-18"

      • "ce-user-management-2026-07-13"

      • "mid-conversation-output-config-2026-07-01"

      • "thinking-binding-controls-2026-08-01"

      • "mid-conversation-system-clear-at-2026-08-21"

      • "compact-2026-09-04"

  • "anthropic-workspace-id": optional string

# Returns

  • BetaModelInfo object

    • type: "model"

      Object type.

      For Models, this is always "model".

      default: model

    • id: string

      Unique model identifier.

    • allowed_fallback_models: array of string or null

      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.

    • capabilities: BetaModelCapabilities or null

      Model capability information.

      • batch: BetaCapabilitySupport

        Whether the model supports the Batch API.

        • supported: boolean

          Whether this capability is supported by the model.

      • citations: BetaCapabilitySupport

        Whether the model supports citation generation.

      • code_execution: BetaCapabilitySupport

        Whether the model supports code execution tools.

      • compaction: BetaCompactionCapability or null

        Compaction capability details: whether the model accepts the top-level compaction request parameter, with one entry per supported compaction.type value.

        • summarize: BetaCapabilitySupport

          Whether the summarize compaction type is supported.

        • supported: boolean

          Whether this capability is supported by the model.

      • context_management: BetaContextManagementCapability

        Context management support and available strategies.

        • clear_thinking_20251015: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

        • clear_tool_uses_20250919: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

        • compact_20260112: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

        • supported: boolean

          Whether this capability is supported by the model.

      • effort: BetaEffortCapability

        Effort (reasoning_effort) support and available levels.

        • high: BetaCapabilitySupport

          Whether the model supports high effort level.

        • low: BetaCapabilitySupport

          Whether the model supports low effort level.

        • max: BetaCapabilitySupport

          Whether the model supports max effort level.

        • medium: BetaCapabilitySupport

          Whether the model supports medium effort level.

        • supported: boolean

          Whether this capability is supported by the model.

        • xhigh: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

      • image_input: BetaCapabilitySupport

        Whether the model accepts image content blocks.

      • pdf_input: BetaCapabilitySupport

        Whether the model accepts PDF content blocks.

      • structured_outputs: BetaCapabilitySupport

        Whether the model supports structured output / JSON mode / strict tool schemas.

      • thinking: BetaThinkingCapability

        Thinking capability and supported type configurations.

        • supported: boolean

          Whether this capability is supported by the model.

        • types: BetaThinkingTypes

          Supported thinking type configurations.

          • adaptive: BetaCapabilitySupport

            Whether the model supports thinking with type 'adaptive' (auto).

          • enabled: BetaCapabilitySupport

            Whether the model supports thinking with type 'enabled'.

    • created_at: 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.

    • max_input_tokens: number or null

      Maximum input context window size in tokens for this model.

    • max_tokens: number or null

      Maximum value for the max_tokens parameter when using this model.

# Example

bash
curl https://api.anthropic.com/v1/models/$MODEL_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

# Response (200)

json
{
  "id": "claude-opus-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
    },
    "structured_outputs": {
      "supported": true
    },
    "thinking": {
      "supported": true,
      "types": {
        "adaptive": {
          "supported": true
        },
        "enabled": {
          "supported": true
        }
      }
    }
  },
  "created_at": "2026-07-24T00:00:00Z",
  "display_name": "Claude Opus 5",
  "max_input_tokens": 0,
  "max_tokens": 0,
  "type": "model"
}

# Domain types

# Beta Capability Support

  • BetaCapabilitySupport object

    Indicates whether a capability is supported.

    • supported: boolean

      Whether this capability is supported by the model.

# Beta Compaction Capability

  • BetaCompactionCapability object

    Compaction capability details: whether the model accepts the top-level compaction request parameter, with one entry per supported compaction.type value.

    • summarize: BetaCapabilitySupport

      Whether the summarize compaction type is supported.

      • supported: boolean

        Whether this capability is supported by the model.

    • supported: boolean

      Whether this capability is supported by the model.

# Beta Context Management Capability

  • BetaContextManagementCapability object

    Context management capability details.

    • clear_thinking_20251015: BetaCapabilitySupport or null

      Indicates whether a capability is supported.

      • supported: boolean

        Whether this capability is supported by the model.

    • clear_tool_uses_20250919: BetaCapabilitySupport or null

      Indicates whether a capability is supported.

    • compact_20260112: BetaCapabilitySupport or null

      Indicates whether a capability is supported.

    • supported: boolean

      Whether this capability is supported by the model.

# Beta Effort Capability

  • BetaEffortCapability object

    Effort (reasoning_effort) capability details.

    • high: BetaCapabilitySupport

      Whether the model supports high effort level.

      • supported: boolean

        Whether this capability is supported by the model.

    • low: BetaCapabilitySupport

      Whether the model supports low effort level.

    • max: BetaCapabilitySupport

      Whether the model supports max effort level.

    • medium: BetaCapabilitySupport

      Whether the model supports medium effort level.

    • supported: boolean

      Whether this capability is supported by the model.

    • xhigh: BetaCapabilitySupport or null

      Indicates whether a capability is supported.

# Beta Model Capabilities

  • BetaModelCapabilities object

    Model capability information.

    • batch: BetaCapabilitySupport

      Whether the model supports the Batch API.

      • supported: boolean

        Whether this capability is supported by the model.

    • citations: BetaCapabilitySupport

      Whether the model supports citation generation.

    • code_execution: BetaCapabilitySupport

      Whether the model supports code execution tools.

    • compaction: BetaCompactionCapability or null

      Compaction capability details: whether the model accepts the top-level compaction request parameter, with one entry per supported compaction.type value.

      • summarize: BetaCapabilitySupport

        Whether the summarize compaction type is supported.

      • supported: boolean

        Whether this capability is supported by the model.

    • context_management: BetaContextManagementCapability

      Context management support and available strategies.

      • clear_thinking_20251015: BetaCapabilitySupport or null

        Indicates whether a capability is supported.

      • clear_tool_uses_20250919: BetaCapabilitySupport or null

        Indicates whether a capability is supported.

      • compact_20260112: BetaCapabilitySupport or null

        Indicates whether a capability is supported.

      • supported: boolean

        Whether this capability is supported by the model.

    • effort: BetaEffortCapability

      Effort (reasoning_effort) support and available levels.

      • high: BetaCapabilitySupport

        Whether the model supports high effort level.

      • low: BetaCapabilitySupport

        Whether the model supports low effort level.

      • max: BetaCapabilitySupport

        Whether the model supports max effort level.

      • medium: BetaCapabilitySupport

        Whether the model supports medium effort level.

      • supported: boolean

        Whether this capability is supported by the model.

      • xhigh: BetaCapabilitySupport or null

        Indicates whether a capability is supported.

    • image_input: BetaCapabilitySupport

      Whether the model accepts image content blocks.

    • pdf_input: BetaCapabilitySupport

      Whether the model accepts PDF content blocks.

    • structured_outputs: BetaCapabilitySupport

      Whether the model supports structured output / JSON mode / strict tool schemas.

    • thinking: BetaThinkingCapability

      Thinking capability and supported type configurations.

      • supported: boolean

        Whether this capability is supported by the model.

      • types: BetaThinkingTypes

        Supported thinking type configurations.

        • adaptive: BetaCapabilitySupport

          Whether the model supports thinking with type 'adaptive' (auto).

        • enabled: BetaCapabilitySupport

          Whether the model supports thinking with type 'enabled'.

# Beta Model Info

  • BetaModelInfo object

    • type: "model"

      Object type.

      For Models, this is always "model".

      default: model

    • id: string

      Unique model identifier.

    • allowed_fallback_models: array of string or null

      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.

    • capabilities: BetaModelCapabilities or null

      Model capability information.

      • batch: BetaCapabilitySupport

        Whether the model supports the Batch API.

        • supported: boolean

          Whether this capability is supported by the model.

      • citations: BetaCapabilitySupport

        Whether the model supports citation generation.

      • code_execution: BetaCapabilitySupport

        Whether the model supports code execution tools.

      • compaction: BetaCompactionCapability or null

        Compaction capability details: whether the model accepts the top-level compaction request parameter, with one entry per supported compaction.type value.

        • summarize: BetaCapabilitySupport

          Whether the summarize compaction type is supported.

        • supported: boolean

          Whether this capability is supported by the model.

      • context_management: BetaContextManagementCapability

        Context management support and available strategies.

        • clear_thinking_20251015: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

        • clear_tool_uses_20250919: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

        • compact_20260112: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

        • supported: boolean

          Whether this capability is supported by the model.

      • effort: BetaEffortCapability

        Effort (reasoning_effort) support and available levels.

        • high: BetaCapabilitySupport

          Whether the model supports high effort level.

        • low: BetaCapabilitySupport

          Whether the model supports low effort level.

        • max: BetaCapabilitySupport

          Whether the model supports max effort level.

        • medium: BetaCapabilitySupport

          Whether the model supports medium effort level.

        • supported: boolean

          Whether this capability is supported by the model.

        • xhigh: BetaCapabilitySupport or null

          Indicates whether a capability is supported.

      • image_input: BetaCapabilitySupport

        Whether the model accepts image content blocks.

      • pdf_input: BetaCapabilitySupport

        Whether the model accepts PDF content blocks.

      • structured_outputs: BetaCapabilitySupport

        Whether the model supports structured output / JSON mode / strict tool schemas.

      • thinking: BetaThinkingCapability

        Thinking capability and supported type configurations.

        • supported: boolean

          Whether this capability is supported by the model.

        • types: BetaThinkingTypes

          Supported thinking type configurations.

          • adaptive: BetaCapabilitySupport

            Whether the model supports thinking with type 'adaptive' (auto).

          • enabled: BetaCapabilitySupport

            Whether the model supports thinking with type 'enabled'.

    • created_at: 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.

    • max_input_tokens: number or null

      Maximum input context window size in tokens for this model.

    • max_tokens: number or null

      Maximum value for the max_tokens parameter when using this model.

# Beta Thinking Capability

  • BetaThinkingCapability object

    Thinking capability details.

    • supported: boolean

      Whether this capability is supported by the model.

    • types: BetaThinkingTypes

      Supported thinking type configurations.

      • adaptive: BetaCapabilitySupport

        Whether the model supports thinking with type 'adaptive' (auto).

        • supported: boolean

          Whether this capability is supported by the model.

      • enabled: BetaCapabilitySupport

        Whether the model supports thinking with type 'enabled'.

# Beta Thinking Types

  • BetaThinkingTypes object

    Supported thinking type configurations.

    • adaptive: BetaCapabilitySupport

      Whether the model supports thinking with type 'adaptive' (auto).

      • supported: boolean

        Whether this capability is supported by the model.

    • enabled: BetaCapabilitySupport

      Whether the model supports thinking with type 'enabled'.

Files main
Menu

Theme
↑↓navigate ↵open escclose /⌘Kanywhere