The identity and technical contract details declared by the specification.
BetaBrowserGetPageTextConfig
object
getpagetext's config overrides.
2 properties
BetaIterationsUsage
Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated b…
BetaResponseCitationsConfig
object
1 property
1 required
BetaComputerCursorPositionConfig
object
cursorposition's config overrides.
2 properties
BetaTokenTaskBudget
object
User-configurable total token budget across contexts.
3 properties
2 required
BetaRequestTextEditorCodeExecutionViewResultBlock
object
6 properties
3 required
BetaResponseCodeExecutionToolResultBlock
object
3 properties
3 required
BetaResponseCodeExecutionToolResultError
object
2 properties
2 required
BetaCodeExecutionTool_20250825
object
6 properties
2 required
BetaRequestToolUseBlock
object
7 properties
4 required
BetaInputSchema
object
3 properties
1 required
BetaSkillParams
object
Specification for a skill to be loaded in a container (request model).
3 properties
2 required
BetaResponseBashCodeExecutionToolResultBlock
object
3 properties
3 required
BetaComputerWaitConfig
object
wait's config overrides.
2 properties
BetaTextEditorCodeExecutionToolResultErrorCode
string
BetaWebFetchToolResultErrorCode
string
BetaBashTool_20241022
object
7 properties
2 required
BetaCodeExecutionTool_20260521
object
Code execution tool with REPL state persistence.
6 properties
2 required
BetaRequestDocumentBlock
object
6 properties
2 required
BetaRefusalCategory
string
The policy category that triggered a refusal.
BetaUserLocation
object
5 properties
1 required
BetaTextEditor_20250429
object
7 properties
2 required
BetaResponseFallbackHopInfo
object
Identifies one hop of a fallback transition.
1 property
1 required
BetaCacheMissSystemChanged
object
2 properties
2 required
BetaDirectCaller
object
Tool invocation directly from the model.
1 property
1 required
BetaComputerUseTool_20251124
object
11 properties
4 required
BetaBrowserReadConsoleConfig
object
readconsole's config overrides.
2 properties
BetaRequestCitationsConfig
object
1 property
BetaBrowserWaitConfig
object
wait's config overrides.
2 properties
BetaOutputTokensDetails
object
1 property
1 required
BetaComputerToolsetConfigs
object
Per-member configuration for computertoolset20260801: one optional field per member tool, keyed by the member name — the same name the member's tooluse blocks…
17 properties
BetaResponseWebFetchToolResultError
object
2 properties
2 required
BetaResponseToolSearchToolResultError
object
3 properties
3 required
BetaComputerLeftMouseUpConfig
object
leftmouseup's config overrides.
2 properties
BetaRequestMCPToolUseBlock
object
6 properties
5 required
BetaRequestToolSearchToolSearchResultBlock
object
2 properties
2 required
BetaResponseAdvisorRedactedResultBlock
object
3 properties
3 required
BetaRefusalStopDetails
object
Structured information about a refusal.
6 properties
6 required
BetaBrowserJavascriptExecConfig
object
javascriptexec's config overrides.
2 properties
BetaInputMessage
object
2 properties
2 required
BetaAllThinkingTurns
object
1 property
1 required
BetaWebFetchTool_20260309
object
Web fetch tool with usecache parameter for bypassing cached content.
12 properties
2 required
BetaToolChoiceAny
object
The model will use any available tools.
2 properties
1 required
BetaComputerLeftClickConfig
object
leftclick's config overrides.
2 properties
BetaFileDocumentSource
object
2 properties
2 required
BetaResponseToolSearchToolResultBlock
object
3 properties
3 required
BetaResponseSearchResultLocationCitation
object
7 properties
7 required
BetaMessageIterationUsage
object
Token usage for a sampling iteration.
7 properties
7 required
BetaWebSearchTool_20260318
object
11 properties
2 required
BetaResponseContentBlockLocationCitation
object
7 properties
7 required
BetaResponsePageLocationCitation
object
7 properties
7 required
BetaBrowserReadNetworkConfig
object
readnetwork's config overrides.
2 properties
BetaComputerLeftMouseDownConfig
object
leftmousedown's config overrides.
2 properties
BetaComputerScreenshotConfig
object
screenshot's config overrides.
2 properties
BetaRequestToolAdditionBlock
object
Mid-conversation directive to surface a declared tool. tool references a tool (or MCP toolset) by name from the request's tools; it is offered to the model fro…
3 properties
2 required
BetaCacheCreation
object
2 properties
2 required
BetaRequestToolRemovalBlock
object
Mid-conversation directive to withdraw a tool. tool references a tool (or MCP toolset) by name from the request's tools; it is no longer offered to the model f…
3 properties
2 required
BetaFallbackRefusalTrigger
object
The from model declined for policy reasons.
2 properties
2 required
BetaResponseWebSearchToolResultBlock
object
4 properties
3 required
BetaComputerUseTool_20241022
object
10 properties
4 required
BetaThinkingConfigAdaptive
object
2 properties
1 required
BetaCacheMissMessagesChanged
object
2 properties
2 required
BetaFallbackMessageIterationUsage
object
Token usage for the fallback-model attempt of a server-side fallback request. Produced in place of a message entry for whichever hop served the response. A dec…
7 properties
7 required
BetaBrowserRightClickConfig
object
rightclick's config overrides.
2 properties
BetaCacheControlEphemeral
object
2 properties
1 required
BetaCreateMessageParams
object
25 properties
3 required
BetaBrowserTypeConfig
object
type's config overrides.
2 properties
BetaContentBlockSource
object
2 properties
2 required
BetaMemoryTool_20250818
object
7 properties
2 required
BetaRequestToolResultBlock
object
6 properties
2 required
BetaGatewayTimeoutError
object
2 properties
2 required
BetaComputerTypeConfig
object
type's config overrides.
2 properties
BetaResponseWebFetchResultBlock
object
4 properties
4 required
BetaDiagnostics
object
Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied diagnostics on the request.
1 property
1 required
BetaResponseWebSearchToolResultError
object
2 properties
2 required
BetaRequestImageBlock
object
4 properties
2 required
BetaJsonOutputFormat
object
2 properties
2 required
BetaRequestTextEditorCodeExecutionCreateResultBlock
object
2 properties
2 required
BetaBashTool_20250124
object
7 properties
2 required
BetaResponseWebSearchResultLocationCitation
object
5 properties
5 required
BetaInputTokensTrigger
object
2 properties
2 required
BetaComputerScrollConfig
object
scroll's config overrides.
2 properties
BetaWebFetchTool_20260318
object
13 properties
2 required
BetaBase64PDFSource
object
3 properties
3 required
BetaInputTokensClearAtLeast
object
2 properties
2 required
BetaRequestTextEditorCodeExecutionToolResultBlock
object
4 properties
3 required
BetaBrowserStateChangeDownloadFailed
object
A file download that failed — or was cancelled — during this call.
4 properties
3 required
BetaResponseTextEditorCodeExecutionToolResultBlock
object
3 properties
3 required
BetaBrowserLeftMouseUpConfig
object
leftmouseup's config overrides.
2 properties
BetaRequestEncryptedCodeExecutionResultBlock
object
Code execution result with encrypted stdout for PFC + websearch results.
5 properties
5 required
BetaToolSearchToolRegex_20251119
object
6 properties
2 required
BetaCacheMissToolsChanged
object
2 properties
2 required
BetaResponseThinkingBlock
object
3 properties
3 required
BetaServerToolCaller_20260120
object
2 properties
2 required
BetaRequestBashCodeExecutionOutputBlock
object
2 properties
2 required
BetaClearThinking20251015
object
2 properties
1 required
BetaRequestAdvisorRedactedResultBlock
object
3 properties
2 required
BetaWebSearchTool_20260209
object
10 properties
2 required
BetaUsage
object
12 properties
12 required
BetaRequestBashCodeExecutionResultBlock
object
5 properties
5 required
BetaRequestBrowserStateBlock
object
The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, downl…
4 properties
2 required
BetaRequestAdvisorToolResultBlock
object
4 properties
3 required
BetaMCPToolConfig
object
Configuration for a specific tool in an MCP toolset.
2 properties
BetaComputerRightClickConfig
object
rightclick's config overrides.
2 properties
BetaRequestWebSearchResultBlock
object
5 properties
4 required
BetaRequestWebSearchToolResultError
object
2 properties
2 required
BetaRequestWebSearchResultLocationCitation
object
5 properties
5 required
BetaComputerHoldKeyConfig
object
holdkey's config overrides.
2 properties
BetaWebSearchTool_20250305
object
10 properties
2 required
BetaFallbackCreditUsage
object
Outcome of the fallbackcredittoken presented on this request.
1 property
1 required
BetaToolChangeToolReference
object
Reference to a single tool the caller declared directly in tools[]. Does not accept the composed {server}{name} form the server assigns to MCP-resolved tools —…
2 properties
2 required
BetaCacheMissModelChanged
object
2 properties
2 required
BetaURLPDFSource
object
2 properties
2 required
BetaRequestContainerUploadBlock
object
A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.
3 properties
2 required
BetaResponseTextEditorCodeExecutionStrReplaceResultBlock
object
6 properties
6 required
BetaResponseTextBlock
object
3 properties
3 required
BetaRequestToolSearchToolResultBlock
object
4 properties
3 required
BetaToolSearchToolResultErrorCode
string
BetaRequestMCPServerURLDefinition
object
5 properties
3 required
BetaRequestThinkingBlock
object
3 properties
3 required
BetaResponseWebSearchResultBlock
object
5 properties
5 required
BetaFallbackConfigV2
object
One entry in the fallbacks chain on a /v1/messages request. model is required. The override fields (maxtokens, thinking, outputconfig, and speed) set the corre…
5 properties
1 required
BetaComputerMiddleClickConfig
object
middleclick's config overrides.
2 properties
BetaAdvisorMessageIterationUsage
object
Token usage for an advisor sub-inference iteration.
7 properties
7 required
BetaBrowserTripleClickConfig
object
tripleclick's config overrides.
2 properties
Model
The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
BetaResponseTextEditorCodeExecutionViewResultBlock
object
6 properties
6 required
BetaWebSearchToolResultErrorCode
string
BetaResponseContextManagement
object
1 property
1 required
BetaAPIError
object
2 properties
2 required
BetaThinkingConfigParam
Configuration for enabling Claude's extended thinking. When enabled, responses include thinking content blocks showing Claude's thinking process before the fin…
BetaComputerToolset_20260801
object
The computer toolset: a single tools[] entry (carrying no name) that declares the computer tool family. The model is served the family's tool with any members…
4 properties
1 required
BetaBase64ImageSource
object
3 properties
3 required
BetaRequestRedactedThinkingBlock
object
2 properties
2 required
BetaCompact20260112
object
Automatically compact older context when reaching the configured trigger threshold.
4 properties
1 required
BetaRateLimitError
object
2 properties
2 required
BetaRequestContentBlockLocationCitation
object
6 properties
6 required
BetaRequestCompactionBlock
object
A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context acros…
4 properties
1 required
BetaRequestAdvisorToolResultError
object
2 properties
2 required
BetaBrowserStateChangeTabOpened
object
A tab this call's execution opened that remains open at its end — the creation delta of the tabs inventory, not an event log. Carries only the tabid; the tab's…
2 properties
2 required
BetaRequestMCPServerToolConfiguration
object
2 properties
BetaCodeExecutionTool_20250522
object
6 properties
2 required
BetaEffortLevel
string
All possible effort levels.
BetaResponseAdvisorToolResultBlock
object
3 properties
3 required
BetaResponseMCPToolResultBlock
object
4 properties
4 required
BetaResponseDocumentBlock
object
4 properties
4 required
BetaComputerKeyConfig
object
key's config overrides.
2 properties
BetaBrowserNewTabConfig
object
newtab's config overrides.
2 properties
BetaComputerDoubleClickConfig
object
doubleclick's config overrides.
2 properties
BetaContainer
object
Information about the container used in the request (for the code execution tool)
3 properties
3 required
BetaComputerTripleClickConfig
object
tripleclick's config overrides.
2 properties
BetaToolUsesTrigger
object
2 properties
2 required
BetaTextEditor_20250728
object
8 properties
2 required
BetaResponseCompactionBlock
object
A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed…
3 properties
3 required
BetaRequestImageTransformations
object
Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its…
1 property
BetaComputerMouseMoveConfig
object
mousemove's config overrides.
2 properties
BetaResponseCharLocationCitation
object
7 properties
7 required
BetaResponseMCPToolUseBlock
object
5 properties
5 required
BetaResponseServerToolUseBlock
object
5 properties
4 required
BetaResponseFallbackBlock
object
Marks the point in content where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and decline…
4 properties
4 required
BetaToolChangeMCPToolReference
object
Reference to a single MCP tool by its server and remote name — the same servername/name pair mcptooluse carries.
3 properties
3 required
BetaCacheMissPreviousMessageNotFound
object
1 property
1 required
BetaResponseCodeExecutionOutputBlock
object
2 properties
2 required
BetaTool
object
10 properties
2 required
BetaPlainTextSource
object
3 properties
3 required
BetaResponseCodeExecutionResultBlock
object
5 properties
5 required
BetaBrowserHoldKeyConfig
object
holdkey's config overrides.
2 properties
BetaInvalidRequestError
object
2 properties
2 required
BetaRequestServerToolUseBlock
object
6 properties
4 required
BetaBashCodeExecutionToolResultErrorCode
string
BetaRequestToolSearchToolResultError
object
3 properties
2 required
BetaBrowserToolsetConfigs
object
Per-member configuration for browsertoolset20260801: one optional field per member tool, keyed by the member name — the same name the member's tooluse blocks c…
31 properties
BetaBrowserKeyConfig
object
key's config overrides.
2 properties
BetaThinkingDisplayMode
string
BetaWebFetchTool_20250910
object
11 properties
2 required
BetaToolSearchToolBM25_20251119
object
6 properties
2 required
BetaBrowserMiddleClickConfig
object
middleclick's config overrides.
2 properties
BetaRequestPageLocationCitation
object
6 properties
6 required
BetaToolChoiceAuto
object
The model will automatically decide whether to use tools.
2 properties
1 required
BetaComputerUseTool_20250124
object
10 properties
4 required
BetaBrowserHoverConfig
object
hover's config overrides.
2 properties
BetaResponseEncryptedCodeExecutionResultBlock
object
Code execution result with encrypted stdout for PFC + websearch results.
5 properties
5 required
BetaResponseBashCodeExecutionOutputBlock
object
2 properties
2 required
BetaBrowserFileUploadConfig
object
fileupload's config overrides.
2 properties
BetaRequestTextBlock
object
4 properties
2 required
BetaCodeExecutionTool_20260120
object
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
6 properties
2 required
BetaFallbackCreditRedeemed
object
The reprice was applied: the retry is billed as if the conversation had been on the retry model all along.
1 property
1 required
BetaResponseToolSearchToolSearchResultBlock
object
2 properties
2 required
BetaResponseAdvisorToolResultError
object
2 properties
2 required
BetaBrowserLeftClickDragConfig
object
leftclickdrag's config overrides.
2 properties
BetaBrowserLeftMouseDownConfig
object
leftmousedown's config overrides.
2 properties
BetaCacheMissUnavailable
object
1 property
1 required
BetaBrowserToolset_20260801
object
The browser toolset: a single tools[] entry (carrying no name) that declares the browser tool family. The model is served the family's tool with any members di…
4 properties
1 required
BetaMetadata
object
1 property
BetaSkill
object
A skill that was loaded in a container (response model).
3 properties
3 required
BetaRequestMCPToolResultBlock
object
5 properties
2 required
BetaAdvisorTool_20260301
object
10 properties
3 required
BetaBrowserZoomConfig
object
zoom's config overrides.
2 properties
BetaRequestFallbackHopInfo
object
Identifies one hop of a fallback transition.
1 property
1 required
BetaSpeed
string
Inference speed mode. fast provides significantly faster output token generation at premium pricing. Not all models support fast; invalid combinations are reje…
BetaToolChangeMCPToolsetReference
object
Reference to every tool in the named MCP server's toolset.
2 properties
2 required
BetaToolChoiceNone
object
The model will not be allowed to use tools.
1 property
1 required
BetaResponseClearThinking20251015Edit
object
3 properties
3 required
BetaResponseTextEditorCodeExecutionCreateResultBlock
object
2 properties
2 required
BetaResponseTextEditorCodeExecutionToolResultError
object
3 properties
3 required
BetaRequestToolReferenceBlock
object
Tool reference block that can be included in toolresult content.
3 properties
2 required
BetaResponseClearToolUses20250919Edit
object
3 properties
3 required
BetaRequestBashCodeExecutionToolResultError
object
2 properties
2 required
BetaBrowserCloseTabConfig
object
closetab's config overrides.
2 properties
BetaRequestSearchResultLocationCitation
object
7 properties
7 required
BetaBrowserStateChangeDownloadCompleted
object
A file download that finished during this call, reported with the same downloadid as its downloadstarted — or without a prior downloadstarted, when the downloa…
5 properties
3 required
BetaRequestWebFetchToolResultError
object
2 properties
2 required
BetaRequestWebSearchToolResultBlock
object
5 properties
3 required
BetaOverloadedError
object
2 properties
2 required
BetaBrowserFindConfig
object
find's config overrides.
2 properties
BetaBillingError
object
2 properties
2 required
BetaRequestWebFetchResultBlock
object
4 properties
3 required
BetaFallbackCreditNotApplied
object
No reprice was applied; reason says why.
3 properties
2 required
BetaOutputConfig
object
3 properties
BetaAdvisorToolResultErrorCode
string
BetaRequestCodeExecutionOutputBlock
object
2 properties
2 required
BetaResponseToolReferenceBlock
object
2 properties
2 required
BetaResponseBashCodeExecutionToolResultError
object
2 properties
2 required
BetaRequestAdvisorResultBlock
object
3 properties
2 required
BetaContainerParams
object
Container parameters with skills to be loaded.
2 properties
BetaResponseToolUseBlock
object
6 properties
4 required
BetaRequestWebFetchToolResultBlock
object
5 properties
3 required
BetaBrowserScreenshotConfig
object
screenshot's config overrides.
2 properties
BetaCompactionIterationUsage
object
Token usage for a compaction iteration.
6 properties
6 required
BetaRequestCodeExecutionToolResultError
object
2 properties
2 required
BetaResponseBashCodeExecutionResultBlock
object
5 properties
5 required
BetaAllowedCaller
string
Specifies who can invoke a tool. Values: direct: The model can call this tool directly. codeexecution20250825: The tool can be called from the code execution e…
BetaBrowserDoubleClickConfig
object
doubleclick's config overrides.
2 properties
BetaRequestCodeExecutionResultBlock
object
5 properties
5 required
BetaAuthenticationError
object
2 properties
2 required
BetaRequestCodeExecutionToolResultBlock
object
4 properties
3 required
BetaNotFoundError
object
2 properties
2 required
BetaComputerZoomConfig
object
zoom's config overrides.
2 properties
BetaRequestBashCodeExecutionToolResultBlock
object
4 properties
3 required
BetaBrowserListTabsConfig
object
listtabs's config overrides.
2 properties
BetaBrowserMouseMoveConfig
object
mousemove's config overrides.
2 properties
BetaClearToolUses20250919
object
6 properties
1 required
BetaWebFetchTool_20260209
object
11 properties
2 required
BetaResponseRedactedThinkingBlock
object
2 properties
2 required
BetaToolChoiceTool
object
The model will use the specified tool with toolchoice.name.
3 properties
2 required
BetaURLImageSource
object
2 properties
2 required
BetaBrowserStateChangeDownloadStarted
object
A file download that started during this call.
3 properties
3 required
BetaPermissionError
object
2 properties
2 required
BetaTextEditor_20250124
object
7 properties
2 required
BetaResponseContainerUploadBlock
object
Response model for a file uploaded to the container.
2 properties
2 required
BetaRequestTextEditorCodeExecutionToolResultError
object
3 properties
2 required
BetaBrowserFormInputConfig
object
forminput's config overrides.
2 properties
BetaThinkingConfigEnabled
object
3 properties
2 required
BetaTextEditor_20241022
object
7 properties
2 required
BetaBrowserScrollConfig
object
scroll's config overrides.
2 properties
BetaToolChoice
How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.
BetaMCPToolset
object
Configuration for a group of tools from an MCP server. Allows configuring enabled status and deferloading for all tools from an MCP server, with optional per-t…
5 properties
2 required
BetaContextManagementConfig
object
1 property
BetaRequestTextEditorCodeExecutionStrReplaceResultBlock
object
6 properties
1 required
BetaServerToolUsage
object
2 properties
2 required
BetaCodeExecutionToolResultErrorCode
string
BetaThinkingConfigDisabled
object
1 property
1 required
BetaBrowserScrollToConfig
object
scrollto's config overrides.
2 properties
BetaBrowserStateTabEntry
object
One open browser tab reported in a browserstate block's tabs inventory. tabid is the caller-assigned identifier for the tab; title and url describe the page th…
4 properties
3 required
BetaFallbackCreditTokenParam
object
Object form of fallbackcredittoken: the token plus a redemption mode. Requires anthropic-beta: fallback-credit-2026-07-01; without that header the field accept…
2 properties
1 required
BetaServerToolCaller
object
Tool invocation generated by a server-side tool.
2 properties
2 required
BetaFileImageSource
object
2 properties
2 required
BetaBrowserNavigateConfig
object
navigate's config overrides.
2 properties
BetaComputerLeftClickDragConfig
object
leftclickdrag's config overrides.
2 properties
BetaRequestCharLocationCitation
object
6 properties
6 required
BetaBrowserReadPageConfig
object
readpage's config overrides.
2 properties
BetaMCPToolDefaultConfig
object
Default configuration for tools in an MCP toolset.
2 properties
BetaRequestSearchResultBlock
object
6 properties
4 required
BetaBrowserSwitchTabConfig
object
switchtab's config overrides.
2 properties
BetaErrorResponse
object
3 properties
3 required
BetaThinkingTurns
object
2 properties
2 required
BetaResponseWebFetchToolResultBlock
object
4 properties
3 required
BetaResponseAdvisorResultBlock
object
3 properties
3 required
BetaRequestFallbackBlock
object
A fallback block echoed back from a prior response. Accepted in messages[].content and not rendered into the prompt; not validated against the request's fallba…
4 properties
3 required
BetaBrowserLeftClickConfig
object
leftclick's config overrides.
2 properties
BetaMessage
object
12 properties
12 required
BetaDiagnosticsParam
object
Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting.
1 property
BetaToolUsesKeep
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Anthropic publishes across the network.