Anthropic Messages API
Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation. The Messages API supports text, images, tool use, extended thinking, streaming, structured outputs, prompt caching, compaction, and the new advisor tool for pairing executor and higher-intelligence advisor models.
Anthropic Messages API is one of 29 APIs that Anthropic publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Artificial Intelligence and Message. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, an AsyncAPI specification, a JSON-LD context, and 2 JSON Schemas.
This API exposes 16 operations across 12 paths, and defines 532 schemas. It is described by OpenAPI 3.2.0.
Requests are made against a single base URL, https://api.anthropic.com.
16 operations
12 paths
532 schemas
2 DELETE6 GET8 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 16
Across 12 paths, the API surfaces 16 operations — 2 DELETE, 6 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.
Messages 16
POST
/v1/messages
Create a Message
POST
/v1/messages/batches
Create a Message Batch
GET
/v1/messages/batches
List Message Batches
GET
/v1/messages/batches/{message_batch_id}
Retrieve a Message Batch
DELETE
/v1/messages/batches/{message_batch_id}
Delete a Message Batch
POST
/v1/messages/batches/{message_batch_id}/cancel
Cancel a Message Batch
POST
/v1/messages/batches/{message_batch_id}/cancel?beta=true
Cancel a Message Batch
GET
/v1/messages/batches/{message_batch_id}/results
Retrieve Message Batch results
GET
/v1/messages/batches/{message_batch_id}/results?beta=true
Retrieve Message Batch results
GET
/v1/messages/batches/{message_batch_id}?beta=true
Retrieve a Message Batch
DELETE
/v1/messages/batches/{message_batch_id}?beta=true
Delete a Message Batch
POST
/v1/messages/batches?beta=true
Create a Message Batch
GET
/v1/messages/batches?beta=true
List Message Batches
POST
/v1/messages/count_tokens
Count tokens in a Message
POST
/v1/messages/count_tokens?beta=true
Count tokens in a Message
POST
/v1/messages?beta=true
Create a Message
Schemas 532
The contract defines 532 schemas that model the data the API accepts and returns. The most detailed are BrowserToolsetConfigs (31 properties), BetaBrowserToolsetConfigs (31 properties), BetaCreateMessageParams (25 properties), CreateMessageParams (18 properties). Each schema is shown below with its type and property counts.
RequestWebFetchToolResultError
object
2 properties
2 required
InputContentBlock
BetaTool
object
10 properties
2 required
ResponseBashCodeExecutionResultBlock
object
5 properties
5 required
BetaResponseWebFetchResultBlock
object
4 properties
4 required
BetaRequestToolUseBlock
object
7 properties
4 required
BetaRateLimitError
object
2 properties
2 required
BetaComputerMouseMoveConfig
object
mousemove's config overrides.
2 properties
BetaRequestWebFetchToolResultBlock
object
5 properties
3 required
RequestToolResultBlock
object
6 properties
2 required
BrowserNavigateConfig
object
navigate's config overrides.
2 properties
WebFetchTool_20260318
object
13 properties
2 required
ResponseWebSearchResultLocationCitation
object
5 properties
5 required
ErroredResult
object
2 properties
2 required
BetaContentBlock
BetaResponseMCPToolUseBlock
object
5 properties
5 required
ResponseBashCodeExecutionToolResultError
object
2 properties
2 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
ResponseToolReferenceBlock
object
2 properties
2 required
BetaResponseClearToolUses20250919Edit
object
3 properties
3 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
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
BetaBrowserMiddleClickConfig
object
middleclick's config overrides.
2 properties
ResponseContainerUploadBlock
object
Response model for a file uploaded to the container.
2 properties
2 required
BetaCacheMissUnavailable
object
1 property
1 required
ResponseCodeExecutionResultBlock
object
5 properties
5 required
BetaContainerParams
object
Container parameters with skills to be loaded.
2 properties
BetaRequestPageLocationCitation
object
6 properties
6 required
BillingError
object
2 properties
2 required
ComputerWaitConfig
object
wait's config overrides.
2 properties
ResponsePageLocationCitation
object
7 properties
7 required
BetaWebSearchToolResultErrorCode
string
OutputTokensDetails
object
1 property
1 required
BetaResponseTextEditorCodeExecutionToolResultError
object
3 properties
3 required
ResponseCharLocationCitation
object
7 properties
7 required
RequestBashCodeExecutionToolResultError
object
2 properties
2 required
RequestSearchResultLocationCitation
object
7 properties
7 required
RequestCharLocationCitation
object
6 properties
6 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
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
WebFetchTool_20250910
object
11 properties
2 required
BetaCacheCreation
object
2 properties
2 required
BetaRequestToolResultBlock
object
6 properties
2 required
BetaAuthenticationError
object
2 properties
2 required
ComputerZoomConfig
object
zoom's config overrides.
2 properties
BrowserHoverConfig
object
hover's config overrides.
2 properties
BetaResponseEncryptedCodeExecutionResultBlock
object
Code execution result with encrypted stdout for PFC + websearch results.
5 properties
5 required
BetaResponseToolSearchToolResultBlock
object
3 properties
3 required
BetaThinkingConfigDisabled
object
1 property
1 required
BetaResponseBashCodeExecutionToolResultError
object
2 properties
2 required
BetaRefusalStopDetails
object
Structured information about a refusal.
6 properties
6 required
BetaRequestTextEditorCodeExecutionCreateResultBlock
object
2 properties
2 required
ResponseBashCodeExecutionOutputBlock
object
2 properties
2 required
BetaToolChoiceAny
object
The model will use any available tools.
2 properties
1 required
BetaBashCodeExecutionToolResultErrorCode
string
BetaToolChangeMCPToolsetReference
object
Reference to every tool in the named MCP server's toolset.
2 properties
2 required
BetaResponseWebFetchToolResultBlock
object
4 properties
3 required
RequestThinkingBlock
object
3 properties
3 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
BetaRequestMCPServerURLDefinition
object
5 properties
3 required
BetaResponseThinkingBlock
object
3 properties
3 required
RequestBashCodeExecutionToolResultBlock
object
4 properties
3 required
BetaBrowserNavigateConfig
object
navigate's config overrides.
2 properties
BrowserTypeConfig
object
type's config overrides.
2 properties
BrowserHoldKeyConfig
object
holdkey's config overrides.
2 properties
BetaWebFetchTool_20260309
object
Web fetch tool with usecache parameter for bypassing cached content.
12 properties
2 required
BetaResponseWebSearchToolResultBlock
object
4 properties
3 required
DirectCaller
object
Tool invocation directly from the model.
1 property
1 required
TextEditorCodeExecutionToolResultErrorCode
string
RequestBashCodeExecutionOutputBlock
object
2 properties
2 required
ThinkingConfigAdaptive
object
2 properties
1 required
BetaCanceledResult
object
1 property
1 required
BetaRequestTextEditorCodeExecutionToolResultError
object
3 properties
2 required
BetaRequestAdvisorRedactedResultBlock
object
3 properties
2 required
RequestTextEditorCodeExecutionToolResultError
object
3 properties
2 required
BrowserListTabsConfig
object
listtabs's config overrides.
2 properties
BetaClearToolUses20250919
object
6 properties
1 required
URLImageSource
object
2 properties
2 required
Base64ImageSource
object
3 properties
3 required
BetaRequestAdvisorToolResultBlock
object
4 properties
3 required
BetaBrowserReadConsoleConfig
object
readconsole's config overrides.
2 properties
BetaContextManagementResponse
object
1 property
1 required
RequestImageBlock
object
4 properties
2 required
BetaCompact20260112
object
Automatically compact older context when reaching the configured trigger threshold.
4 properties
1 required
BetaRequestCodeExecutionResultBlock
object
5 properties
5 required
BetaComputerLeftMouseUpConfig
object
leftmouseup's config overrides.
2 properties
RequestDocumentBlock
object
6 properties
2 required
RequestCitationsConfig
object
1 property
BetaResponsePageLocationCitation
object
7 properties
7 required
BetaBrowserListTabsConfig
object
listtabs's config overrides.
2 properties
InputSchema
object
3 properties
1 required
BetaResponseContainerUploadBlock
object
Response model for a file uploaded to the container.
2 properties
2 required
RefusalStopDetails
object
Structured information about a refusal.
3 properties
3 required
BetaOutputTokensDetails
object
1 property
1 required
BetaToolChoiceTool
object
The model will use the specified tool with toolchoice.name.
3 properties
2 required
TextEditor_20250429
object
7 properties
2 required
BetaPlainTextSource
object
3 properties
3 required
RequestToolSearchToolResultBlock
object
4 properties
3 required
BetaCountMessageTokensResponse
object
2 properties
2 required
PlainTextSource
object
3 properties
3 required
BetaToolChoiceAuto
object
The model will automatically decide whether to use tools.
2 properties
1 required
ResponseTextEditorCodeExecutionCreateResultBlock
object
2 properties
2 required
BetaRequestWebFetchResultBlock
object
4 properties
3 required
MessageBatchIndividualRequestParams
object
2 properties
2 required
ToolChoice
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.
BetaBrowserMouseMoveConfig
object
mousemove's config overrides.
2 properties
BetaSkill
object
A skill that was loaded in a container (response model).
3 properties
3 required
RequestToolSearchToolSearchResultBlock
object
2 properties
2 required
WebFetchToolResultErrorCode
string
BetaResponseAdvisorToolResultError
object
2 properties
2 required
Container
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
BetaCodeExecutionTool_20250825
object
6 properties
2 required
BetaComputerLeftClickDragConfig
object
leftclickdrag's config overrides.
2 properties
BetaMessageBatchIndividualResponse
object
This is a single line in the response .jsonl file and does not represent the response as a whole.
2 properties
2 required
BetaFallbackCreditNotApplied
object
No reprice was applied; reason says why.
3 properties
2 required
RequestContainerUploadBlock
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
CodeExecutionTool_20250522
object
6 properties
2 required
BetaRequestDocumentBlock
object
6 properties
2 required
BetaResponseWebSearchToolResultError
object
2 properties
2 required
BetaRequestRedactedThinkingBlock
object
2 properties
2 required
BrowserScrollConfig
object
scroll's config overrides.
2 properties
CodeExecutionTool_20250825
object
6 properties
2 required
RequestTextEditorCodeExecutionStrReplaceResultBlock
object
6 properties
1 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…
BetaCacheMissModelChanged
object
2 properties
2 required
BetaContextManagementConfig
object
1 property
BetaPermissionError
object
2 properties
2 required
BetaRequestToolSearchToolResultBlock
object
4 properties
3 required
WebFetchTool_20260209
object
11 properties
2 required
BetaBrowserHoverConfig
object
hover's config overrides.
2 properties
BrowserGetPageTextConfig
object
getpagetext's config overrides.
2 properties
BetaResponseAdvisorToolResultBlock
object
3 properties
3 required
BetaComputerScrollConfig
object
scroll's config overrides.
2 properties
ResponseToolSearchToolResultError
object
3 properties
3 required
BetaRequestToolReferenceBlock
object
Tool reference block that can be included in toolresult content.
3 properties
2 required
BetaRequestSearchResultBlock
object
6 properties
4 required
BrowserZoomConfig
object
zoom's config overrides.
2 properties
BetaBrowserScreenshotConfig
object
screenshot's config overrides.
2 properties
BetaCacheMissPreviousMessageNotFound
object
1 property
1 required
BetaFileImageSource
object
2 properties
2 required
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
BetaResponseServerToolUseBlock
object
5 properties
4 required
BrowserStateChangeDownloadCompleted
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
BetaAPIError
object
2 properties
2 required
WebSearchToolResultErrorCode
string
BrowserScreenshotConfig
object
screenshot'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.
BetaServerToolUsage
object
2 properties
2 required
BetaCacheControlEphemeral
object
2 properties
1 required
BetaBrowserFormInputConfig
object
forminput's config overrides.
2 properties
ComputerLeftMouseUpConfig
object
leftmouseup's config overrides.
2 properties
RequestContentBlockLocationCitation
object
6 properties
6 required
ResponseTextEditorCodeExecutionToolResultError
object
3 properties
3 required
BetaEffortLevel
string
All possible effort levels.
BetaCodeExecutionTool_20250522
object
6 properties
2 required
RequestEncryptedCodeExecutionResultBlock
object
Code execution result with encrypted stdout for PFC + websearch results.
5 properties
5 required
BrowserStateTabEntry
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
BetaRequestWebSearchResultLocationCitation
object
5 properties
5 required
JsonOutputFormat
object
2 properties
2 required
BetaRequestAdvisorResultBlock
object
3 properties
2 required
ResponseContentBlockLocationCitation
object
7 properties
7 required
BetaBrowserZoomConfig
object
zoom's config overrides.
2 properties
RequestCounts
object
5 properties
5 required
MemoryTool_20250818
object
7 properties
2 required
BetaRequestBashCodeExecutionToolResultBlock
object
4 properties
3 required
ResponseTextEditorCodeExecutionStrReplaceResultBlock
object
6 properties
6 required
ComputerMiddleClickConfig
object
middleclick's config overrides.
2 properties
ThinkingConfigEnabled
object
3 properties
2 required
BetaBashTool_20241022
object
7 properties
2 required
BetaComputerScreenshotConfig
object
screenshot's config overrides.
2 properties
BetaToolUsesKeep
object
2 properties
2 required
RequestWebSearchToolResultBlock
object
5 properties
3 required
BetaComputerWaitConfig
object
wait's config overrides.
2 properties
BetaTextEditor_20241022
object
7 properties
2 required
BetaMCPToolConfig
object
Configuration for a specific tool in an MCP toolset.
2 properties
ToolSearchToolRegex_20251119
object
6 properties
2 required
BetaAdvisorMessageIterationUsage
object
Token usage for an advisor sub-inference iteration.
7 properties
7 required
BetaBrowserRightClickConfig
object
rightclick's config overrides.
2 properties
BetaThinkingDisplayMode
string
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
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
ServerToolCaller
object
Tool invocation generated by a server-side tool.
2 properties
2 required
TextEditor_20250728
object
8 properties
2 required
BetaInputSchema
object
3 properties
1 required
ResponseWebSearchResultBlock
object
5 properties
5 required
BetaResponseTextEditorCodeExecutionViewResultBlock
object
6 properties
6 required
BetaInvalidRequestError
object
2 properties
2 required
URLPDFSource
object
2 properties
2 required
BetaMessageIterationUsage
object
Token usage for a sampling iteration.
7 properties
7 required
AllowedCaller
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…
BrowserMiddleClickConfig
object
middleclick's config overrides.
2 properties
BetaResponseFallbackHopInfo
object
Identifies one hop of a fallback transition.
1 property
1 required
BetaComputerUseTool_20251124
object
11 properties
4 required
BetaNotFoundError
object
2 properties
2 required
BetaFallbackRefusalTrigger
object
The from model declined for policy reasons.
2 properties
2 required
BetaWebSearchTool_20250305
object
10 properties
2 required
BetaBrowserReadNetworkConfig
object
readnetwork's config overrides.
2 properties
ComputerRightClickConfig
object
rightclick's config overrides.
2 properties
BetaFileDocumentSource
object
2 properties
2 required
BetaRequestWebSearchToolResultError
object
2 properties
2 required
StopReason
string
ServerToolCaller_20260120
object
2 properties
2 required
APIError
object
2 properties
2 required
ResponseEncryptedCodeExecutionResultBlock
object
Code execution result with encrypted stdout for PFC + websearch results.
5 properties
5 required
Metadata
object
1 property
BetaBrowserDoubleClickConfig
object
doubleclick's config overrides.
2 properties
ResponseBashCodeExecutionToolResultBlock
object
3 properties
3 required
BetaMCPToolDefaultConfig
object
Default configuration for tools in an MCP toolset.
2 properties
CodeExecutionTool_20260120
object
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
6 properties
2 required
RefusalCategory
string
The policy category that triggered a refusal.
BetaJsonValue
BetaResponseToolUseBlock
object
6 properties
4 required
BetaWebFetchToolResultErrorCode
string
BrowserLeftMouseUpConfig
object
leftmouseup's config overrides.
2 properties
ErrorResponse
object
3 properties
3 required
BetaBrowserLeftClickDragConfig
object
leftclickdrag's config overrides.
2 properties
BetaRequestBashCodeExecutionOutputBlock
object
2 properties
2 required
NotFoundError
object
2 properties
2 required
ComputerScreenshotConfig
object
screenshot's config overrides.
2 properties
BetaRequestEncryptedCodeExecutionResultBlock
object
Code execution result with encrypted stdout for PFC + websearch results.
5 properties
5 required
BetaToolSearchToolBM25_20251119
object
6 properties
2 required
BetaSkillParams
object
Specification for a skill to be loaded in a container (request model).
3 properties
2 required
RequestTextEditorCodeExecutionToolResultBlock
object
4 properties
3 required
BetaToolChoiceNone
object
The model will not be allowed to use tools.
1 property
1 required
BetaResponseTextEditorCodeExecutionToolResultBlock
object
3 properties
3 required
BetaWebFetchTool_20260209
object
11 properties
2 required
ResponseWebSearchToolResultError
object
2 properties
2 required
BetaRequestTextEditorCodeExecutionToolResultBlock
object
4 properties
3 required
BetaRefusalCategory
string
The policy category that triggered a refusal.
BetaBrowserWaitConfig
object
wait's config overrides.
2 properties
BrowserNewTabConfig
object
newtab's config overrides.
2 properties
BetaThinkingConfigEnabled
object
3 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…
CanceledResult
object
1 property
1 required
BrowserWaitConfig
object
wait's config overrides.
2 properties
BetaErroredResult
object
2 properties
2 required
BetaBillingError
object
2 properties
2 required
BetaGatewayTimeoutError
object
2 properties
2 required
RequestCodeExecutionOutputBlock
object
2 properties
2 required
ToolChoiceNone
object
The model will not be allowed to use tools.
1 property
1 required
BetaRequestCodeExecutionOutputBlock
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
BetaRequestToolSearchToolResultError
object
3 properties
2 required
BetaBrowserStateChangeDownloadFailed
object
A file download that failed — or was cancelled — during this call.
4 properties
3 required
Model
The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options.
FileImageSource
object
2 properties
2 required
WebSearchTool_20250305
object
10 properties
2 required
ComputerDoubleClickConfig
object
doubleclick's config overrides.
2 properties
BetaComputerDoubleClickConfig
object
doubleclick's config overrides.
2 properties
ResponseToolSearchToolResultBlock
object
3 properties
3 required
BetaDeleteMessageBatchResponse
object
2 properties
2 required
BetaBrowserReadPageConfig
object
readpage's config overrides.
2 properties
BetaBrowserHoldKeyConfig
object
holdkey'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
BetaJsonOutputFormat
object
2 properties
2 required
BetaRequestImageBlock
object
4 properties
2 required
BetaRequestTextEditorCodeExecutionStrReplaceResultBlock
object
6 properties
1 required
CodeExecutionToolResultErrorCode
string
RequestCodeExecutionToolResultError
object
2 properties
2 required
BetaComputerUseTool_20241022
object
10 properties
4 required
BetaToolSearchToolRegex_20251119
object
6 properties
2 required
BetaRequestCodeExecutionToolResultBlock
object
4 properties
3 required
ThinkingConfigDisabled
object
1 property
1 required
ResponseThinkingBlock
object
3 properties
3 required
ComputerLeftClickConfig
object
leftclick's config overrides.
2 properties
BrowserScrollToConfig
object
scrollto's config overrides.
2 properties
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
BrowserFileUploadConfig
object
fileupload's config overrides.
2 properties
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
BetaRequestContentBlockLocationCitation
object
6 properties
6 required
ComputerCursorPositionConfig
object
cursorposition's config overrides.
2 properties
BetaWebFetchTool_20250910
object
11 properties
2 required
BetaDiagnosticsParam
object
Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting.
1 property
BetaAdvisorTool_20260301
object
10 properties
3 required
RequestTextEditorCodeExecutionCreateResultBlock
object
2 properties
2 required
BrowserTripleClickConfig
object
tripleclick's config overrides.
2 properties
ContentBlock
Tool
object
10 properties
2 required
BetaBrowserLeftMouseUpConfig
object
leftmouseup's config overrides.
2 properties
TextEditor_20250124
object
7 properties
2 required
BrowserReadConsoleConfig
object
readconsole's config overrides.
2 properties
ResponseCitationsConfig
object
1 property
1 required
BetaTokenTaskBudget
object
User-configurable total token budget across contexts.
3 properties
2 required
BetaContainer
object
Information about the container used in the request (for the code execution tool)
3 properties
3 required
BetaFallbackCreditUsage
object
Outcome of the fallbackcredittoken presented on this request.
1 property
1 required
ComputerToolsetConfigs
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
BrowserLeftClickDragConfig
object
leftclickdrag's config overrides.
2 properties
BetaWebFetchTool_20260318
object
13 properties
2 required
SkillParams
object
Specification for a skill to be loaded in a container (request model).
3 properties
2 required
BetaBrowserLeftClickConfig
object
leftclick's config overrides.
2 properties
BashTool_20250124
object
7 properties
2 required
ListResponse_MessageBatch_
object
4 properties
4 required
ToolChoiceAuto
object
The model will automatically decide whether to use tools.
2 properties
1 required
BetaUsage
object
12 properties
12 required
OverloadedError
object
2 properties
2 required
BetaIterationsUsage
Per-iteration token usage breakdown. Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated b…
ToolChoiceTool
object
The model will use the specified tool with toolchoice.name.
3 properties
2 required
BetaRequestMCPToolResultBlock
object
5 properties
2 required
BetaBrowserKeyConfig
object
key's config overrides.
2 properties
BetaSpeed
string
Inference speed mode. fast provides significantly faster output token generation at premium pricing. Not all models support fast; invalid combinations are reje…
BrowserFindConfig
object
find's config overrides.
2 properties
MessageBatch
object
10 properties
10 required
BetaRequestWebSearchResultBlock
object
5 properties
4 required
ThinkingConfigParam
Configuration for enabling Claude's extended thinking. When enabled, responses include thinking content blocks showing Claude's thinking process before the fin…
ComputerLeftMouseDownConfig
object
leftmousedown's config overrides.
2 properties
BetaMessage
object
12 properties
12 required
BetaResponseClearThinking20251015Edit
object
3 properties
3 required
ComputerTypeConfig
object
type's config overrides.
2 properties
BetaResponseCitationsConfig
object
1 property
1 required
BetaServerToolCaller
object
Tool invocation generated by a server-side tool.
2 properties
2 required
BetaResponseDocumentBlock
object
4 properties
4 required
BrowserRightClickConfig
object
rightclick's config overrides.
2 properties
BetaCreateMessageBatchParams
object
1 property
1 required
BetaBrowserFileUploadConfig
object
fileupload's config overrides.
2 properties
OutputConfig
object
2 properties
BetaRequestFallbackHopInfo
object
Identifies one hop of a fallback transition.
1 property
1 required
RequestWebSearchToolResultError
object
2 properties
2 required
BetaCreateMessageParams
object
25 properties
3 required
RequestSearchResultBlock
object
6 properties
4 required
FileDocumentSource
object
2 properties
2 required
ToolSearchToolBM25_20251119
object
6 properties
2 required
BetaServerToolCaller_20260120
object
2 properties
2 required
BrowserMouseMoveConfig
object
mousemove's config overrides.
2 properties
CreateMessageParams
object
18 properties
3 required
BrowserReadNetworkConfig
object
readnetwork's config overrides.
2 properties
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
CacheControlEphemeral
object
2 properties
1 required
BetaBrowserScrollConfig
object
scroll's config overrides.
2 properties
BetaWebSearchTool_20260318
object
11 properties
2 required
BetaSucceededResult
object
2 properties
2 required
BetaComputerKeyConfig
object
key's config overrides.
2 properties
BrowserStateChangeDownloadStarted
object
A file download that started during this call.
3 properties
3 required
BetaResponseCodeExecutionToolResultBlock
object
3 properties
3 required
BetaResponseCharLocationCitation
object
7 properties
7 required
CountMessageTokensResponse
object
1 property
1 required
BetaRequestWebSearchToolResultBlock
object
5 properties
3 required
BetaBase64PDFSource
object
3 properties
3 required
BetaResponseCodeExecutionResultBlock
object
5 properties
5 required
ResponseWebSearchToolResultBlock
object
4 properties
4 required
BetaRequestCodeExecutionToolResultError
object
2 properties
2 required
BetaResponseAdvisorResultBlock
object
3 properties
3 required
BrowserDoubleClickConfig
object
doubleclick's config overrides.
2 properties
ResponseCodeExecutionToolResultError
object
2 properties
2 required
ResponseDocumentBlock
object
4 properties
4 required
BetaResponseBashCodeExecutionResultBlock
object
5 properties
5 required
ComputerMouseMoveConfig
object
mousemove's config overrides.
2 properties
BetaResponseToolReferenceBlock
object
2 properties
2 required
ResponseWebFetchToolResultBlock
object
4 properties
4 required
BetaRequestTextEditorCodeExecutionViewResultBlock
object
6 properties
3 required
SucceededResult
object
2 properties
2 required
BrowserFormInputConfig
object
forminput's config overrides.
2 properties
BetaResponseTextBlock
object
3 properties
3 required
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
RequestToolReferenceBlock
object
Tool reference block that can be included in toolresult content.
3 properties
2 required
RequestBashCodeExecutionResultBlock
object
5 properties
5 required
ResponseTextBlock
object
3 properties
3 required
BetaTextEditorCodeExecutionToolResultErrorCode
string
AnthropicBeta
ServerToolUsage
object
2 properties
2 required
RateLimitError
object
2 properties
2 required
BetaRequestWebFetchToolResultError
object
2 properties
2 required
BrowserToolset_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
ComputerScrollConfig
object
scroll's config overrides.
2 properties
ContentBlockSource
object
2 properties
2 required
BetaOutputConfig
object
3 properties
BetaBrowserJavascriptExecConfig
object
javascriptexec's config overrides.
2 properties
BetaExpiredResult
object
1 property
1 required
BetaMessageBatchIndividualRequestParams
object
2 properties
2 required
BetaCacheMissMessagesChanged
object
2 properties
2 required
BetaResponseCodeExecutionOutputBlock
object
2 properties
2 required
BetaAllThinkingTurns
object
1 property
1 required
BrowserJavascriptExecConfig
object
javascriptexec's config overrides.
2 properties
BetaRequestMCPServerToolConfiguration
object
2 properties
BetaStopReason
string
BetaAdvisorToolResultErrorCode
string
BetaBrowserLeftMouseDownConfig
object
leftmousedown's config overrides.
2 properties
BetaTextEditor_20250429
object
7 properties
2 required
WebSearchTool_20260318
object
11 properties
2 required
Usage
object
9 properties
9 required
BrowserLeftClickConfig
object
leftclick's config overrides.
2 properties
BetaResponseAdvisorRedactedResultBlock
object
3 properties
3 required
BetaResponseWebSearchResultLocationCitation
object
5 properties
5 required
RequestPageLocationCitation
object
6 properties
6 required
UserLocation
object
5 properties
1 required
GatewayTimeoutError
object
2 properties
2 required
ResponseSearchResultLocationCitation
object
7 properties
7 required
BetaRequestMCPToolUseBlock
object
6 properties
5 required
BetaInputTokensClearAtLeast
object
2 properties
2 required
RequestServerToolUseBlock
object
6 properties
4 required
InputMessage
object
2 properties
2 required
BetaInputMessage
object
2 properties
2 required
ResponseWebFetchToolResultError
object
2 properties
2 required
ResponseTextEditorCodeExecutionViewResultBlock
object
6 properties
6 required
BrowserLeftMouseDownConfig
object
leftmousedown's config overrides.
2 properties
BetaRequestServerToolUseBlock
object
6 properties
4 required
BetaRequestSearchResultLocationCitation
object
7 properties
7 required
BetaResponseBashCodeExecutionOutputBlock
object
2 properties
2 required
BetaContentBlockSource
object
2 properties
2 required
BetaRequestCitationsConfig
object
1 property
BetaThinkingTurns
object
2 properties
2 required
RequestWebFetchToolResultBlock
object
5 properties
3 required
BetaRequestTextBlock
object
4 properties
2 required
CountMessageTokensParams
object
8 properties
2 required
BetaRequestAdvisorToolResultError
object
2 properties
2 required
BetaCodeExecutionTool_20260521
object
Code execution tool with REPL state persistence.
6 properties
2 required
BrowserStateChangeDownloadFailed
object
A file download that failed — or was cancelled — during this call.
4 properties
3 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
ComputerTripleClickConfig
object
tripleclick's config overrides.
2 properties
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
BetaCacheMissToolsChanged
object
2 properties
2 required
BetaResponseMCPToolResultBlock
object
4 properties
4 required
ResponseTextEditorCodeExecutionToolResultBlock
object
3 properties
3 required
BetaComputerRightClickConfig
object
rightclick's config overrides.
2 properties
BetaDiagnostics
object
Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied diagnostics on the request.
1 property
1 required
BetaComputerCursorPositionConfig
object
cursorposition's config overrides.
2 properties
PermissionError
object
2 properties
2 required
BetaResponseTextEditorCodeExecutionCreateResultBlock
object
2 properties
2 required
ResponseWebFetchResultBlock
object
4 properties
4 required
BetaTextEditor_20250124
object
7 properties
2 required
BetaComputerMiddleClickConfig
object
middleclick's config overrides.
2 properties
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
Message
object
10 properties
10 required
CacheCreation
object
2 properties
2 required
BetaResponseWebSearchResultBlock
object
5 properties
5 required
BetaResponseWebFetchToolResultError
object
2 properties
2 required
BetaRequestToolSearchToolSearchResultBlock
object
2 properties
2 required
ComputerLeftClickDragConfig
object
leftclickdrag's config overrides.
2 properties
BetaMetadata
object
1 property
RequestToolSearchToolResultError
object
3 properties
2 required
BetaInputContentBlock
ContainerParams
object
Container parameters with skills to be loaded.
2 properties
BetaResponseCodeExecutionToolResultError
object
2 properties
2 required
CodeExecutionTool_20260521
object
Code execution tool with REPL state persistence.
6 properties
2 required
BetaComputerLeftMouseDownConfig
object
leftmousedown's config overrides.
2 properties
BetaErrorResponse
object
3 properties
3 required
BetaRequestBashCodeExecutionResultBlock
object
5 properties
5 required
JsonValue
BetaCountMessageTokensParams
object
12 properties
2 required
BetaRequestCharLocationCitation
object
6 properties
6 required
DeleteMessageBatchResponse
object
2 properties
2 required
RequestWebFetchResultBlock
object
4 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
BetaBrowserStateChangeDownloadStarted
object
A file download that started during this call.
3 properties
3 required
RequestToolUseBlock
object
7 properties
4 required
ThinkingDisplayMode
string
BetaMessageBatch
object
10 properties
10 required
BetaComputerUseTool_20250124
object
10 properties
4 required
BetaComputerHoldKeyConfig
object
holdkey's config overrides.
2 properties
BetaResponseBashCodeExecutionToolResultBlock
object
3 properties
3 required
CreateMessageBatchParams
object
1 property
1 required
ComputerKeyConfig
object
key's config overrides.
2 properties
BetaResponseToolSearchToolResultError
object
3 properties
3 required
BrowserSwitchTabConfig
object
switchtab's config overrides.
2 properties
BetaBashTool_20250124
object
7 properties
2 required
BetaBrowserFindConfig
object
find's config overrides.
2 properties
RequestCodeExecutionResultBlock
object
5 properties
5 required
RequestWebSearchResultLocationCitation
object
5 properties
5 required
WebFetchTool_20260309
object
Web fetch tool with usecache parameter for bypassing cached content.
12 properties
2 required
BetaURLPDFSource
object
2 properties
2 required
BetaBase64ImageSource
object
3 properties
3 required
BetaBrowserNewTabConfig
object
newtab's config overrides.
2 properties
BetaThinkingConfigAdaptive
object
2 properties
1 required
BetaResponseSearchResultLocationCitation
object
7 properties
7 required
BetaBrowserTripleClickConfig
object
tripleclick's config overrides.
2 properties
WebSearchTool_20260209
object
10 properties
2 required
BrowserKeyConfig
object
key's config overrides.
2 properties
ToolSearchToolResultErrorCode
string
BetaToolSearchToolResultErrorCode
string
BetaComputerTypeConfig
object
type's config overrides.
2 properties
RequestCodeExecutionToolResultBlock
object
4 properties
3 required
BetaTextEditor_20250728
object
8 properties
2 required
RequestTextEditorCodeExecutionViewResultBlock
object
6 properties
3 required
RequestImageTransformations
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
BetaResponseToolSearchToolSearchResultBlock
object
2 properties
2 required
RequestBrowserStateBlock
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
BetaCodeExecutionToolResultErrorCode
string
ResponseCodeExecutionToolResultBlock
object
3 properties
3 required
BashCodeExecutionToolResultErrorCode
string
BetaRequestCounts
object
5 properties
5 required
BetaBrowserScrollToConfig
object
scrollto's config overrides.
2 properties
BetaToolUsesTrigger
object
2 properties
2 required
BetaResponseRedactedThinkingBlock
object
2 properties
2 required
BetaCacheMissSystemChanged
object
2 properties
2 required
BetaResponseContentBlockLocationCitation
object
7 properties
7 required
ToolChoiceAny
object
The model will use any available tools.
2 properties
1 required
ResponseServerToolUseBlock
object
5 properties
5 required
Base64PDFSource
object
3 properties
3 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
ResponseCodeExecutionOutputBlock
object
2 properties
2 required
MessageBatchIndividualResponse
object
This is a single line in the response .jsonl file and does not represent the response as a whole.
2 properties
2 required
BetaURLImageSource
object
2 properties
2 required
BetaBrowserSwitchTabConfig
object
switchtab's config overrides.
2 properties
RequestWebSearchResultBlock
object
5 properties
4 required
BetaInputTokensTrigger
object
2 properties
2 required
BetaWebSearchTool_20260209
object
10 properties
2 required
BetaCompactionIterationUsage
object
Token usage for a compaction iteration.
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
BetaResponseContextManagement
object
1 property
1 required
BetaResponseTextEditorCodeExecutionStrReplaceResultBlock
object
6 properties
6 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
ComputerHoldKeyConfig
object
holdkey's config overrides.
2 properties
AuthenticationError
object
2 properties
2 required
ResponseToolUseBlock
object
6 properties
5 required
BetaDirectCaller
object
Tool invocation directly from the model.
1 property
1 required
BetaMemoryTool_20250818
object
7 properties
2 required
BetaBrowserCloseTabConfig
object
closetab's config overrides.
2 properties
BetaComputerZoomConfig
object
zoom's config overrides.
2 properties
RequestTextBlock
object
4 properties
2 required
InvalidRequestError
object
2 properties
2 required
BetaUserLocation
object
5 properties
1 required
BetaCodeExecutionTool_20260120
object
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
6 properties
2 required
EffortLevel
string
All possible effort levels.
BetaBrowserGetPageTextConfig
object
getpagetext's config overrides.
2 properties
BetaRequestBashCodeExecutionToolResultError
object
2 properties
2 required
ComputerToolset_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
BetaOverloadedError
object
2 properties
2 required
BrowserReadPageConfig
object
readpage's config overrides.
2 properties
ResponseToolSearchToolSearchResultBlock
object
2 properties
2 required
ContainerSkill
object
A skill that was loaded in a container (response model).
3 properties
3 required
BrowserToolsetConfigs
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
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
BetaRequestThinkingBlock
object
3 properties
3 required
RequestRedactedThinkingBlock
object
2 properties
2 required
BrowserStateChangeTabOpened
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
BetaComputerLeftClickConfig
object
leftclick's config overrides.
2 properties
BrowserCloseTabConfig
object
closetab's config overrides.
2 properties
BetaBrowserTypeConfig
object
type's config overrides.
2 properties
BetaClearThinking20251015
object
2 properties
1 required
ResponseRedactedThinkingBlock
object
2 properties
2 required
BetaListResponse_MessageBatch_
object
4 properties
4 required
ExpiredResult
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Anthropic 12
Other APIs Anthropic publishes across the network.
Anthropic Models API
Anthropic Files API
Anthropic Skills API
Anthropic Agents API
Anthropic Api Keys API
Anthropic Cost API
Anthropic Environments API
Anthropic Events API
Anthropic Organization API
Anthropic Organization Invites API
Anthropic Organization Members API
Anthropic Prompt Generation API
#Artificial Intelligence#Message
Where this information came from
This is an independent, third-party profile of Anthropic Messages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.