Claude Platform Docs

Messages

Create a Message
messages.create(**kwargs) -> Message
POST/v1/messages
Count tokens in a Message
messages.count_tokens(**kwargs) -> MessageTokensCount
POST/v1/messages/count_tokens
Models
class Base64ImageSource { data, media_type, type }
data: String
formatbyte
media_type: :"image/jpeg" | :"image/png" | :"image/gif" | :"image/webp"
One of the following:
:"image/jpeg"
:"image/png"
:"image/gif"
:"image/webp"
type: :base64
class Base64PDFSource { data, media_type, type }
data: String
formatbyte
media_type: :"application/pdf"
type: :base64
class BashCodeExecutionOutputBlock { file_id, type }
file_id: String
type: :bash_code_execution_output
class BashCodeExecutionOutputBlockParam { file_id, type }
file_id: String
type: :bash_code_execution_output
class BashCodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: Array[BashCodeExecutionOutputBlock { file_id, type }]
file_id: String
type: :bash_code_execution_output
return_code: Integer
stderr: String
stdout: String
type: :bash_code_execution_result
class BashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
content: Array[BashCodeExecutionOutputBlockParam { file_id, type }]
file_id: String
type: :bash_code_execution_output
return_code: Integer
stderr: String
stdout: String
type: :bash_code_execution_result
class BashCodeExecutionToolResultBlock { content, tool_use_id, type }
class BashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
class BashCodeExecutionToolResultError { error_code, type }
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
:output_file_too_large
type: :bash_code_execution_tool_result_error
BashCodeExecutionToolResultErrorCode = :invalid_tool_input | :unavailable | :too_many_requests | 2 more
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
:output_file_too_large
class BashCodeExecutionToolResultErrorParam { error_code, type }
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
:output_file_too_large
type: :bash_code_execution_tool_result_error
class BrowserCloseTabConfig { defer_loading, enabled }

close_tab's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserDoubleClickConfig { defer_loading, enabled }

double_click's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserFileUploadConfig { defer_loading, enabled }

file_upload's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserFindConfig { defer_loading, enabled }

find's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserFormInputConfig { defer_loading, enabled }

form_input's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserGetPageTextConfig { defer_loading, enabled }

get_page_text's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserHoldKeyConfig { defer_loading, enabled }

hold_key's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserHoverConfig { defer_loading, enabled }

hover's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserJavascriptExecConfig { defer_loading, enabled }

javascript_exec's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserKeyConfig { defer_loading, enabled }

key's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserLeftClickConfig { defer_loading, enabled }

left_click's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserLeftClickDragConfig { defer_loading, enabled }

left_click_drag's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserLeftMouseDownConfig { defer_loading, enabled }

left_mouse_down's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserLeftMouseUpConfig { defer_loading, enabled }

left_mouse_up's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserListTabsConfig { defer_loading, enabled }

list_tabs's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserMiddleClickConfig { defer_loading, enabled }

middle_click's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserMouseMoveConfig { defer_loading, enabled }

mouse_move's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserNavigateConfig { defer_loading, enabled }

navigate's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserNewTabConfig { defer_loading, enabled }

new_tab's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserReadConsoleConfig { defer_loading, enabled }

read_console's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserReadNetworkConfig { defer_loading, enabled }

read_network's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserReadPageConfig { defer_loading, enabled }

read_page's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserRightClickConfig { defer_loading, enabled }

right_click's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserScreenshotConfig { defer_loading, enabled }

screenshot's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserScrollConfig { defer_loading, enabled }

scroll's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserScrollToConfig { defer_loading, enabled }

scroll_to's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserStateBlockParam { tabs, type, cache_control, state_changes }

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, download state changes) the call produced.

At most one per tool_result, only on a non-error result answering a browser toolset member tool_use. The server renders the model-visible text from it; the model never sees the raw fields.

BrowserStateChange = BrowserStateChangeTabOpened { tab_id, type } | BrowserStateChangeDownloadStarted { download_id, type, url } | BrowserStateChangeDownloadCompleted { download_id, type, url, 2 more } | BrowserStateChangeDownloadFailed { download_id, type, url, error }

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 tab_id; the tab's title and url live on its tabs entry, which must include the same tab_id. A tab opened during a failed call gets no deferred tab_opened; it simply appears in the next result's tabs inventory.

One of the following:
class BrowserStateChangeDownloadCompleted { download_id, type, url, 2 more }

A file download that finished during this call, reported with the same download_id as its download_started — or without a prior download_started, when the download finished during the call that started it (at most one state change per download_id per result).

download_id: String

The caller-assigned identifier for this download, stable across the state changes reporting it.

maxLength4096
minLength1
pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
type: :download_completed
url: String

The final post-redirect URL the download was served from.

maxLength4096
pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
path: String

Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path.

pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
maxLength4096
size_bytes: Integer

The completed download's size.

minimum0
class BrowserStateChangeDownloadFailed { download_id, type, url, error }

A file download that failed — or was cancelled — during this call.

download_id: String

The caller-assigned identifier for this download, stable across the state changes reporting it.

maxLength4096
minLength1
pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
type: :download_failed
url: String

The final post-redirect URL the download was served from.

maxLength4096
pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
error: String

The failure or cancellation detail, when known.

pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
maxLength4096
class BrowserStateChangeDownloadStarted { download_id, type, url }

A file download that started during this call.

download_id: String

The caller-assigned identifier for this download, stable across the state changes reporting it.

maxLength4096
minLength1
pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
type: :download_started
url: String

The final post-redirect URL the download was served from.

maxLength4096
pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
class BrowserStateChangeTabOpened { tab_id, type }

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 tab_id; the tab's title and url live on its tabs entry, which must include the same tab_id. A tab opened during a failed call gets no deferred tab_opened; it simply appears in the next result's tabs inventory.

tab_id: String

The tab_id of the opened tab, present in tabs.

maxLength4096
minLength1
pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
type: :tab_opened
class BrowserStateTabEntry { tab_id, title, url, active }

One open browser tab reported in a browser_state block's tabs inventory.

tab_id is the caller-assigned identifier for the tab; title and url describe the page the tab is currently showing and may be empty strings (a blank tab legitimately has both empty). active marks the tab that is active after this call; whenever tabs is non-empty, exactly one entry is marked.

tab_id: String

The caller-assigned identifier for this tab, unique within the inventory.

maxLength4096
minLength1
pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
title: String

The title of the page the tab is showing. May be empty.

maxLength4096
pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
url: String

The URL of the page the tab is showing. May be empty.

maxLength4096
pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
active: bool

Whether this tab is the active tab after this call. Whenever tabs is non-empty, exactly one entry is marked active: true.

class BrowserSwitchTabConfig { defer_loading, enabled }

switch_tab's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserToolset20260801 { type, allowed_callers, cache_control, configs }

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 disabled via configs removed from its schema.

class BrowserToolsetConfigs { close_tab, double_click, file_upload, 28 more }

Per-member configuration for browser_toolset_20260801: one optional field per member tool, keyed by the member name — the same name the member's tool_use blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set.

class BrowserTripleClickConfig { defer_loading, enabled }

triple_click's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserTypeConfig { defer_loading, enabled }

type's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserWaitConfig { defer_loading, enabled }

wait's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class BrowserZoomConfig { defer_loading, enabled }

zoom's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class CacheControlEphemeral { type, ttl }
type: :ephemeral
ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
:"5m"
:"1h"
class CacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }
ephemeral_1h_input_tokens: Integer

The number of input tokens used to create the 1 hour cache entry.

minimum0
ephemeral_5m_input_tokens: Integer

The number of input tokens used to create the 5 minute cache entry.

minimum0
class CitationCharLocation { cited_text, document_index, document_title, 4 more }
cited_text: String
document_index: Integer
minimum0
document_title: String
end_char_index: Integer
file_id: String
start_char_index: Integer
minimum0
type: :char_location
class CitationCharLocationParam { cited_text, document_index, document_title, 3 more }
cited_text: String
document_index: Integer
minimum0
document_title: String
maxLength500
minLength1
end_char_index: Integer
start_char_index: Integer
minimum0
type: :char_location
class CitationContentBlockLocation { cited_text, document_index, document_title, 4 more }
cited_text: String

The full text of the cited block range, concatenated.

Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

document_index: Integer
minimum0
document_title: String
end_block_index: Integer

Exclusive 0-based end index of the cited block range in the source's content array.

Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.

file_id: String
start_block_index: Integer

0-based index of the first cited block in the source's content array.

minimum0
type: :content_block_location
class CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }
cited_text: String

The full text of the cited block range, concatenated.

Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

document_index: Integer
minimum0
document_title: String
maxLength500
minLength1
end_block_index: Integer

Exclusive 0-based end index of the cited block range in the source's content array.

Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.

start_block_index: Integer

0-based index of the first cited block in the source's content array.

minimum0
type: :content_block_location
class CitationPageLocation { cited_text, document_index, document_title, 4 more }
cited_text: String
document_index: Integer
minimum0
document_title: String
end_page_number: Integer
file_id: String
start_page_number: Integer
minimum1
type: :page_location
class CitationPageLocationParam { cited_text, document_index, document_title, 3 more }
cited_text: String
document_index: Integer
minimum0
document_title: String
maxLength500
minLength1
end_page_number: Integer
start_page_number: Integer
minimum1
type: :page_location
class CitationSearchResultLocationParam { cited_text, end_block_index, search_result_index, 4 more }
cited_text: String

The full text of the cited block range, concatenated.

Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

end_block_index: Integer

Exclusive 0-based end index of the cited block range in the source's content array.

Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.

search_result_index: Integer

0-based index of the cited search result among all search_result content blocks in the request, in the order they appear across messages and tool results.

Counted separately from document_index; server-side web search results are not included in this count.

minimum0
source: String
start_block_index: Integer

0-based index of the first cited block in the source's content array.

minimum0
title: String
type: :search_result_location
class CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }
cited_text: String
encrypted_index: String
title: String
maxLength512
minLength1
type: :web_search_result_location
url: String
minLength1
class CitationsConfig { enabled }
enabled: bool
class CitationsConfigParam { enabled }
enabled: bool
class CitationsDelta { citation, type }
class CitationsSearchResultLocation { cited_text, end_block_index, search_result_index, 4 more }
cited_text: String

The full text of the cited block range, concatenated.

Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

end_block_index: Integer

Exclusive 0-based end index of the cited block range in the source's content array.

Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.

search_result_index: Integer

0-based index of the cited search result among all search_result content blocks in the request, in the order they appear across messages and tool results.

Counted separately from document_index; server-side web search results are not included in this count.

minimum0
source: String
start_block_index: Integer

0-based index of the first cited block in the source's content array.

minimum0
title: String
type: :search_result_location
class CitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }
cited_text: String
encrypted_index: String
title: String
maxLength512
type: :web_search_result_location
url: String
class CodeExecutionOutputBlock { file_id, type }
file_id: String
type: :code_execution_output
class CodeExecutionOutputBlockParam { file_id, type }
file_id: String
type: :code_execution_output
class CodeExecutionResultBlock { content, return_code, stderr, 2 more }
content: Array[CodeExecutionOutputBlock { file_id, type }]
file_id: String
type: :code_execution_output
return_code: Integer
stderr: String
stdout: String
type: :code_execution_result
class CodeExecutionResultBlockParam { content, return_code, stderr, 2 more }
content: Array[CodeExecutionOutputBlockParam { file_id, type }]
file_id: String
type: :code_execution_output
return_code: Integer
stderr: String
stdout: String
type: :code_execution_result
class CodeExecutionTool20250522 { name, type, allowed_callers, 3 more }
class CodeExecutionTool20250825 { name, type, allowed_callers, 3 more }
class CodeExecutionTool20260120 { name, type, allowed_callers, 3 more }

Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).

class CodeExecutionTool20260521 { name, type, allowed_callers, 3 more }

Code execution tool with REPL state persistence.

class CodeExecutionToolResultBlock { content, tool_use_id, type }

Code execution result with encrypted stdout for PFC + web_search results.

One of the following:
tool_use_id: String
pattern^srvtoolu_[a-zA-Z0-9_]+$
type: :code_execution_tool_result
CodeExecutionToolResultBlockContent = CodeExecutionToolResultError { error_code, type } | CodeExecutionResultBlock { content, return_code, stderr, 2 more } | EncryptedCodeExecutionResultBlock { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

One of the following:
class CodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

Code execution result with encrypted stdout for PFC + web_search results.

One of the following:
tool_use_id: String
pattern^srvtoolu_[a-zA-Z0-9_]+$
type: :code_execution_tool_result
cache_control: CacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral
ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
:"5m"
:"1h"
CodeExecutionToolResultBlockParamContent = CodeExecutionToolResultErrorParam { error_code, type } | CodeExecutionResultBlockParam { content, return_code, stderr, 2 more } | EncryptedCodeExecutionResultBlockParam { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

One of the following:
class CodeExecutionToolResultError { error_code, type }
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
type: :code_execution_tool_result_error
CodeExecutionToolResultErrorCode = :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
class CodeExecutionToolResultErrorParam { error_code, type }
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
type: :code_execution_tool_result_error
class ComputerCursorPositionConfig { defer_loading, enabled }

cursor_position's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerDoubleClickConfig { defer_loading, enabled }

double_click's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerHoldKeyConfig { defer_loading, enabled }

hold_key's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerKeyConfig { defer_loading, enabled }

key's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerLeftClickConfig { defer_loading, enabled }

left_click's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerLeftClickDragConfig { defer_loading, enabled }

left_click_drag's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerLeftMouseDownConfig { defer_loading, enabled }

left_mouse_down's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerLeftMouseUpConfig { defer_loading, enabled }

left_mouse_up's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerMiddleClickConfig { defer_loading, enabled }

middle_click's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerMouseMoveConfig { defer_loading, enabled }

mouse_move's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerRightClickConfig { defer_loading, enabled }

right_click's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerScreenshotConfig { defer_loading, enabled }

screenshot's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerScrollConfig { defer_loading, enabled }

scroll's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerToolset20260801 { type, allowed_callers, cache_control, configs }

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 disabled via configs removed from its schema. Every member is enabled by default, zoom included. The single-tool options display_number and enable_zoom are not fields of a toolset entry — it carries only type, configs, and cache_control; zoom is controlled via configs.zoom.enabled.

class ComputerToolsetConfigs { cursor_position, double_click, hold_key, 14 more }

Per-member configuration for computer_toolset_20260801: one optional field per member tool, keyed by the member name — the same name the member's tool_use blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set.

class ComputerTripleClickConfig { defer_loading, enabled }

triple_click's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerTypeConfig { defer_loading, enabled }

type's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerWaitConfig { defer_loading, enabled }

wait's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class ComputerZoomConfig { defer_loading, enabled }

zoom's config overrides.

defer_loading: bool

Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.

enabled: bool

Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema.

class Container { id, expires_at, skills }

Information about the container used in the request (for the code execution tool)

id: String

Identifier for the container used in this request

expires_at: Time

The time at which the container will expire.

formatdate-time
skills: Array[ContainerSkill { skill_id, type, version }]

Skills loaded in the container

skill_id: String

Skill ID

maxLength64
minLength1
type: :anthropic | :custom

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

One of the following:
:anthropic
:custom
version: String

The resolved version: a skill version ID for custom skills.

maxLength64
minLength1
class ContainerParams { id, skills }

Container parameters with skills to be loaded.

id: String

Container id

skills: Array[SkillParams { skill_id, type, version }]

List of skills to load in the container

maxItems20
skill_id: String

Skill ID

maxLength64
minLength1
type: :anthropic | :custom

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

One of the following:
:anthropic
:custom
version: String

Skill version or 'latest' for most recent version

maxLength64
minLength1
class ContainerSkill { skill_id, type, version }

A skill that was loaded in a container (response model).

skill_id: String

Skill ID

maxLength64
minLength1
type: :anthropic | :custom

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

One of the following:
:anthropic
:custom
version: String

The resolved version: a skill version ID for custom skills.

maxLength64
minLength1
class ContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: String
type: :container_upload
class ContainerUploadBlockParam { file_id, type, cache_control }

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.

file_id: String
type: :container_upload
cache_control: CacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral
ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
:"5m"
:"1h"
ContentBlock = TextBlock { citations, text, type } | ThinkingBlock { signature, thinking, type } | RedactedThinkingBlock { data, type } | 9 more

Response model for a file uploaded to the container.

One of the following:
ContentBlockParam = TextBlockParam { text, type, cache_control, citations } | ImageBlockParam { source, type, cache_control, transformations } | DocumentBlockParam { source, type, cache_control, 3 more } | 13 more

Regular text content.

One of the following:
class ContentBlockSource { content, type }
content: String | Array[ContentBlockSourceContent]
One of the following:
String = String
ContentBlockSourceContent = Array[ContentBlockSourceContent]
One of the following:
class TextBlockParam { text, type, cache_control, citations }
class ImageBlockParam { source, type, cache_control, transformations }
type: :content
ContentBlockSourceContent = TextBlockParam { text, type, cache_control, citations } | ImageBlockParam { source, type, cache_control, transformations }
One of the following:
class TextBlockParam { text, type, cache_control, citations }
class ImageBlockParam { source, type, cache_control, transformations }
class DirectCaller { type }

Tool invocation directly from the model.

type: :direct
class DocumentBlock { citations, source, title, type }
class DocumentBlockParam { source, type, cache_control, 3 more }
class EncryptedCodeExecutionResultBlock { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

content: Array[CodeExecutionOutputBlock { file_id, type }]
file_id: String
type: :code_execution_output
encrypted_stdout: String
return_code: Integer
stderr: String
type: :encrypted_code_execution_result
class EncryptedCodeExecutionResultBlockParam { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

content: Array[CodeExecutionOutputBlockParam { file_id, type }]
file_id: String
type: :code_execution_output
encrypted_stdout: String
return_code: Integer
stderr: String
type: :encrypted_code_execution_result
class FileDocumentSource { file_id, type }
file_id: String
type: :file
class FileImageSource { file_id, type }
file_id: String
type: :file
class ImageBlockParam { source, type, cache_control, transformations }
class ImageTransformationsParam { oversized_image }

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 value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field.

oversized_image: :downsize | :error

What the server does when this image exceeds the model's maximum image size. "downsize" (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. "error" instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down.

One of the following:
:downsize
:error
class InputJSONDelta { partial_json, type }
partial_json: String
type: :input_json_delta
class JSONOutputFormat { schema, type }
schema: Hash[Symbol, untyped]

The JSON schema of the format

type: :json_schema
class MemoryTool20250818 { name, type, allowed_callers, 4 more }
class Message { id, container, content, 7 more }
MessageCountTokensTool = Tool { input_schema, name, allowed_callers, 7 more } | ToolBash20250124 { name, type, allowed_callers, 4 more } | CodeExecutionTool20250522 { name, type, allowed_callers, 3 more } | 18 more

Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).

One of the following:
MessageCreateParamsContainer = ContainerParams { id, skills } | String

Container identifier for reuse across requests.

One of the following:
class ContainerParams { id, skills }

Container parameters with skills to be loaded.

id: String

Container id

skills: Array[SkillParams { skill_id, type, version }]

List of skills to load in the container

maxItems20
skill_id: String

Skill ID

maxLength64
minLength1
type: :anthropic | :custom

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

One of the following:
:anthropic
:custom
version: String

Skill version or 'latest' for most recent version

maxLength64
minLength1
String = String
class MessageDeltaUsage { cache_creation_input_tokens, cache_read_input_tokens, input_tokens, 3 more }
class MessageParam { content, role }
class MessageTokensCount { input_tokens }
input_tokens: Integer

The total number of tokens across the provided list of messages, system prompt, and tools.

class Metadata { user_id }
user_id: String

An external identifier for the user who is associated with the request.

This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number.

maxLength512
Model = :"claude-sonnet-5" | :"claude-fable-5" | :"claude-mythos-5" | 12 more | String

The model that will complete your prompt.

See models for additional details and options.

One of the following:
class OutputConfig { effort, format_ }
effort: :low | :medium | :high | 2 more

All possible effort levels.

One of the following:
:low
:medium
:high
:xhigh
:max
format_: JSONOutputFormat { schema, type }

A schema to specify Claude's output format in responses. See structured outputs

schema: Hash[Symbol, untyped]

The JSON schema of the format

type: :json_schema
class OutputTokensDetails { thinking_tokens }
thinking_tokens: Integer

Number of output tokens the model generated as internal reasoning, including the thinking-block delimiter tokens.

Reflects the raw reasoning the model produced, not the (possibly shorter) summarized thinking text returned in the response body. Computed by re-tokenizing the raw reasoning text, so it may differ from the model's exact generation count by a small number of tokens. Always ≤ output_tokens; output_tokens - thinking_tokens approximates the non-reasoning output.

minimum0
class PlainTextSource { data, media_type, type }
data: String
media_type: :"text/plain"
type: :text
RawContentBlockDelta = TextDelta { text, type } | InputJSONDelta { partial_json, type } | CitationsDelta { citation, type } | 2 more
One of the following:
class RawContentBlockDeltaEvent { delta, index, type }
One of the following:
index: Integer
type: :content_block_delta
class RawContentBlockStartEvent { content_block, index, type }
class RawContentBlockStopEvent { index, type }
index: Integer
type: :content_block_stop
class RawMessageDeltaEvent { delta, type, usage }
class RawMessageStartEvent { message, type }
message: Message { id, container, content, 7 more }
type: :message_start
class RawMessageStopEvent { type }
type: :message_stop
RawMessageStreamEvent = RawMessageStartEvent { message, type } | RawMessageDeltaEvent { delta, type, usage } | RawMessageStopEvent { type } | 3 more
One of the following:
class RedactedThinkingBlock { data, type }
data: String

The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content.

Pass redacted_thinking blocks back to the API unchanged when continuing a multi-turn conversation.

See extended thinking for details.

type: :redacted_thinking
class RedactedThinkingBlockParam { data, type }
data: String

The data value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.

type: :redacted_thinking
class RefusalStopDetails { category, explanation, type }

Structured information about a refusal.

category: :cyber | :bio | :frontier_llm | 2 more

The policy category that triggered a refusal.

One of the following:
:cyber

The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.

:bio

The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category.

:frontier_llm

The request could assist the development of competing AI models, which is restricted under Anthropic's commercial terms. Benign machine learning work can also trigger this category.

:reasoning_extraction

The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use adaptive thinking.

:general_harms

The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.

explanation: String

Human-readable explanation of the refusal.

This text is not guaranteed to be stable. null when no explanation is available for the category.

type: :refusal
class SearchResultBlockParam { content, source, title, 3 more }
class ServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: String
pattern^srvtoolu_[a-zA-Z0-9_]+$
type: :code_execution_20250825
class ServerToolCaller20260120 { tool_id, type }
tool_id: String
pattern^srvtoolu_[a-zA-Z0-9_]+$
type: :code_execution_20260120
class ServerToolUsage { web_fetch_requests, web_search_requests }
web_fetch_requests: Integer

The number of web fetch tool requests.

minimum0
web_search_requests: Integer

The number of web search tool requests.

minimum0
class ServerToolUseBlock { id, caller_, input, 2 more }
class ServerToolUseBlockParam { id, input, name, 3 more }
class SignatureDelta { signature, type }
signature: String

The signature for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a signature_delta event just before the block's content_block_stop event.

type: :signature_delta
class SkillParams { skill_id, type, version }

Specification for a skill to be loaded in a container (request model).

skill_id: String

Skill ID

maxLength64
minLength1
type: :anthropic | :custom

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

One of the following:
:anthropic
:custom
version: String

Skill version or 'latest' for most recent version

maxLength64
minLength1
StopReason = :end_turn | :max_tokens | :stop_sequence | 4 more
One of the following:
:end_turn
:max_tokens
:stop_sequence
:tool_use
:pause_turn
:refusal
:model_context_window_exceeded
class TextBlock { citations, text, type }
class TextBlockParam { text, type, cache_control, citations }
TextCitation = CitationCharLocation { cited_text, document_index, document_title, 4 more } | CitationPageLocation { cited_text, document_index, document_title, 4 more } | CitationContentBlockLocation { cited_text, document_index, document_title, 4 more } | 2 more
One of the following:
TextCitationParam = CitationCharLocationParam { cited_text, document_index, document_title, 3 more } | CitationPageLocationParam { cited_text, document_index, document_title, 3 more } | CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more } | 2 more
One of the following:
class TextDelta { text, type }
text: String
type: :text_delta
class TextEditorCodeExecutionCreateResultBlock { is_file_update, type }
is_file_update: bool
type: :text_editor_code_execution_create_result
class TextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }
is_file_update: bool
type: :text_editor_code_execution_create_result
class TextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }
lines: Array[String]
new_lines: Integer
new_start: Integer
old_lines: Integer
old_start: Integer
type: :text_editor_code_execution_str_replace_result
class TextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }
type: :text_editor_code_execution_str_replace_result
lines: Array[String]
new_lines: Integer
new_start: Integer
old_lines: Integer
old_start: Integer
class TextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }
class TextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }
class TextEditorCodeExecutionToolResultError { error_code, error_message, type }
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
:file_not_found
error_message: String
type: :text_editor_code_execution_tool_result_error
TextEditorCodeExecutionToolResultErrorCode = :invalid_tool_input | :unavailable | :too_many_requests | 2 more
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
:file_not_found
class TextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
:file_not_found
type: :text_editor_code_execution_tool_result_error
error_message: String
class TextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }
content: String
file_type: :text | :image | :pdf
One of the following:
:text
:image
:pdf
num_lines: Integer
start_line: Integer
total_lines: Integer
type: :text_editor_code_execution_view_result
class TextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }
content: String
file_type: :text | :image | :pdf
One of the following:
:text
:image
:pdf
type: :text_editor_code_execution_view_result
num_lines: Integer
start_line: Integer
total_lines: Integer
class ThinkingBlock { signature, thinking, type }
signature: String

A value used to verify that this thinking block was generated by Claude when it is passed back to the API.

This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact.

See extended thinking for details.

thinking: String

The text of Claude's thinking process for this block.

type: :thinking
class ThinkingBlockParam { signature, thinking, type }
signature: String

The signature value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.

Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 invalid_request_error.

thinking: String

The thinking text of this block as returned by the API.

type: :thinking
class ThinkingConfigAdaptive { type, display_ }
type: :adaptive
display_: :summarized | :omitted

Controls how thinking content appears in the response. When set to summarized, thinking is returned normally. When set to omitted, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to summarized.

One of the following:
:summarized
:omitted
class ThinkingConfigDisabled { type }
type: :disabled
class ThinkingConfigEnabled { budget_tokens, type, display_ }
budget_tokens: Integer

Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.

Must be ≥1024 and less than max_tokens.

See extended thinking for details.

minimum1024
type: :enabled
display_: :summarized | :omitted

Controls how thinking content appears in the response. When set to summarized, thinking is returned normally. When set to omitted, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to summarized.

One of the following:
:summarized
:omitted
ThinkingConfigParam = ThinkingConfigEnabled { budget_tokens, type, display_ } | ThinkingConfigDisabled { type } | ThinkingConfigAdaptive { type, display_ }

Configuration for enabling Claude's extended thinking.

When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.

See extended thinking for details.

One of the following:
class ThinkingDelta { thinking, type }
thinking: String

The incremental thinking text for this content block. Concatenate the thinking values of successive thinking_delta events to assemble the block's full thinking value.

type: :thinking_delta
class Tool { input_schema, name, allowed_callers, 7 more }
class ToolBash20250124 { name, type, allowed_callers, 4 more }
ToolChoice = ToolChoiceAuto { type, disable_parallel_tool_use } | ToolChoiceAny { type, disable_parallel_tool_use } | ToolChoiceTool { name, type, disable_parallel_tool_use } | ToolChoiceNone { type }

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.

One of the following:
class ToolChoiceAny { type, disable_parallel_tool_use }

The model will use any available tools.

type: :any
disable_parallel_tool_use: bool

Whether to disable parallel tool use.

Defaults to false. If set to true, the model will output exactly one tool use.

class ToolChoiceAuto { type, disable_parallel_tool_use }

The model will automatically decide whether to use tools.

type: :auto
disable_parallel_tool_use: bool

Whether to disable parallel tool use.

Defaults to false. If set to true, the model will output at most one tool use.

class ToolChoiceNone { type }

The model will not be allowed to use tools.

type: :none
class ToolChoiceTool { name, type, disable_parallel_tool_use }

The model will use the specified tool with tool_choice.name.

name: String

The name of the tool to use.

type: :tool
disable_parallel_tool_use: bool

Whether to disable parallel tool use.

Defaults to false. If set to true, the model will output exactly one tool use.

class ToolReferenceBlock { tool_name, type }
tool_name: String
maxLength256
minLength1
pattern^[a-zA-Z0-9_-]{1,256}$
type: :tool_reference
class ToolReferenceBlockParam { tool_name, type, cache_control }

Tool reference block that can be included in tool_result content.

tool_name: String
maxLength256
minLength1
pattern^[a-zA-Z0-9_-]{1,256}$
type: :tool_reference
cache_control: CacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral
ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
:"5m"
:"1h"
class ToolResultBlockParam { tool_use_id, type, cache_control, 3 more }
class ToolSearchToolBm25_20251119 { name, type, allowed_callers, 3 more }
class ToolSearchToolRegex20251119 { name, type, allowed_callers, 3 more }
class ToolSearchToolResultBlock { content, tool_use_id, type }
class ToolSearchToolResultBlockParam { content, tool_use_id, type, cache_control }
class ToolSearchToolResultError { error_code, error_message, type }
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
error_message: String
type: :tool_search_tool_result_error
ToolSearchToolResultErrorCode = :invalid_tool_input | :unavailable | :too_many_requests | :execution_time_exceeded
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
class ToolSearchToolResultErrorParam { error_code, type, error_message }
One of the following:
:invalid_tool_input
:unavailable
:too_many_requests
:execution_time_exceeded
type: :tool_search_tool_result_error
error_message: String
class ToolSearchToolSearchResultBlock { tool_references, type }
tool_references: Array[ToolReferenceBlock { tool_name, type }]
tool_name: String
maxLength256
minLength1
pattern^[a-zA-Z0-9_-]{1,256}$
type: :tool_reference
type: :tool_search_tool_search_result
class ToolSearchToolSearchResultBlockParam { tool_references, type }
tool_references: Array[ToolReferenceBlockParam { tool_name, type, cache_control }]
tool_name: String
maxLength256
minLength1
pattern^[a-zA-Z0-9_-]{1,256}$
type: :tool_reference
cache_control: CacheControlEphemeral { type, ttl }

Create a cache control breakpoint at this content block.

type: :ephemeral
ttl: :"5m" | :"1h"

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
:"5m"
:"1h"
type: :tool_search_tool_search_result
class ToolTextEditor20250124 { name, type, allowed_callers, 4 more }
class ToolTextEditor20250429 { name, type, allowed_callers, 4 more }
class ToolTextEditor20250728 { name, type, allowed_callers, 5 more }
ToolUnion = Tool { input_schema, name, allowed_callers, 7 more } | ToolBash20250124 { name, type, allowed_callers, 4 more } | CodeExecutionTool20250522 { name, type, allowed_callers, 3 more } | 18 more

Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).

One of the following:
class ToolUseBlock { id, caller_, input, 3 more }
class ToolUseBlockParam { id, input, name, 4 more }
class URLImageSource { type, url }
type: :url
url: String
class URLPDFSource { type, url }
type: :url
url: String
class Usage { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 6 more }
class UserLocation { type, city, country, 2 more }
type: :approximate
city: String

The city of the user.

maxLength255
minLength1
country: String

The two letter ISO country code of the user.

maxLength2
minLength2
region: String

The region of the user.

maxLength255
minLength1
timezone: String

The IANA timezone of the user.

maxLength255
minLength1
class WebFetchBlock { content, retrieved_at, type, url }
content: DocumentBlock { citations, source, title, type }
retrieved_at: String

ISO 8601 timestamp when the content was retrieved

type: :web_fetch_result
url: String

Fetched content URL

class WebFetchBlockParam { content, type, url, retrieved_at }
content: DocumentBlockParam { source, type, cache_control, 3 more }
type: :web_fetch_result
url: String

Fetched content URL

retrieved_at: String

ISO 8601 timestamp when the content was retrieved

class WebFetchTool20250910 { name, type, allowed_callers, 8 more }
class WebFetchTool20260209 { name, type, allowed_callers, 8 more }
class WebFetchTool20260309 { name, type, allowed_callers, 9 more }

Web fetch tool with use_cache parameter for bypassing cached content.

class WebFetchTool20260318 { name, type, allowed_callers, 10 more }
class WebFetchToolResultBlock { caller_, content, tool_use_id, type }
class WebFetchToolResultBlockParam { content, tool_use_id, type, 2 more }
class WebFetchToolResultErrorBlock { error_code, type }
One of the following:
:invalid_tool_input
:url_too_long
:url_not_allowed
:url_not_in_prior_context
:url_not_accessible
:unsupported_content_type
:too_many_requests
:max_uses_exceeded
:unavailable
type: :web_fetch_tool_result_error
class WebFetchToolResultErrorBlockParam { error_code, type }
One of the following:
:invalid_tool_input
:url_too_long
:url_not_allowed
:url_not_in_prior_context
:url_not_accessible
:unsupported_content_type
:too_many_requests
:max_uses_exceeded
:unavailable
type: :web_fetch_tool_result_error
WebFetchToolResultErrorCode = :invalid_tool_input | :url_too_long | :url_not_allowed | 6 more
One of the following:
:invalid_tool_input
:url_too_long
:url_not_allowed
:url_not_in_prior_context
:url_not_accessible
:unsupported_content_type
:too_many_requests
:max_uses_exceeded
:unavailable
class WebSearchResultBlock { encrypted_content, page_age, title, 2 more }
encrypted_content: String
page_age: String
title: String
type: :web_search_result
url: String
class WebSearchResultBlockParam { encrypted_content, title, type, 2 more }
encrypted_content: String
title: String
type: :web_search_result
url: String
page_age: String
class WebSearchTool20250305 { name, type, allowed_callers, 7 more }
class WebSearchTool20260209 { name, type, allowed_callers, 7 more }
class WebSearchTool20260318 { name, type, allowed_callers, 8 more }
class WebSearchToolRequestError { error_code, type }
One of the following:
:invalid_tool_input
:unavailable
:max_uses_exceeded
:too_many_requests
:query_too_long
:request_too_large
type: :web_search_tool_result_error
class WebSearchToolResultBlock { caller_, content, tool_use_id, type }
WebSearchToolResultBlockContent = WebSearchToolResultError { error_code, type } | Array[WebSearchResultBlock { encrypted_content, page_age, title, 2 more }]
One of the following:
class WebSearchToolResultBlockParam { content, tool_use_id, type, 2 more }
WebSearchToolResultBlockParamContent = Array[WebSearchResultBlockParam { encrypted_content, title, type, 2 more }] | WebSearchToolRequestError { error_code, type }
One of the following:
class WebSearchToolResultError { error_code, type }
One of the following:
:invalid_tool_input
:unavailable
:max_uses_exceeded
:too_many_requests
:query_too_long
:request_too_large
type: :web_search_tool_result_error
WebSearchToolResultErrorCode = :invalid_tool_input | :unavailable | :max_uses_exceeded | 3 more
One of the following:
:invalid_tool_input
:unavailable
:max_uses_exceeded
:too_many_requests
:query_too_long
:request_too_large

MessagesBatches

Create a Message Batch
messages.batches.create(**kwargs) -> MessageBatch
POST/v1/messages/batches
Retrieve a Message Batch
messages.batches.retrieve(message_batch_id) -> MessageBatch
GET/v1/messages/batches/{message_batch_id}
List Message Batches
messages.batches.list(**kwargs) -> Page<MessageBatch>
GET/v1/messages/batches
Cancel a Message Batch
messages.batches.cancel(message_batch_id) -> MessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel
Delete a Message Batch
messages.batches.delete(message_batch_id) -> DeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
messages.batches.results(message_batch_id) -> MessageBatchIndividualResponse
GET/v1/messages/batches/{message_batch_id}/results