Claude Platform Docs

Messages

Create a Message
beta.messages.create(MessageCreateParams**kwargs) -> BetaMessage
POST/v1/messages
Count tokens in a Message
beta.messages.count_tokens(MessageCountTokensParams**kwargs) -> BetaMessageTokensCount
POST/v1/messages/count_tokens
Models
class BetaAdvisorMessageIterationUsage:

Token usage for an advisor sub-inference iteration.

cache_creation: Optional[BetaCacheCreation]

Breakdown of cached tokens by TTL

ephemeral_1h_input_tokens: int

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

default0
minimum0
ephemeral_5m_input_tokens: int

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

default0
minimum0
cache_creation_input_tokens: int

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

default0
minimum0
cache_read_input_tokens: int

The number of input tokens read from the cache.

default0
minimum0
input_tokens: int

The number of input tokens which were used.

minimum0
model: Model

The model that will complete your prompt.

See models for additional details and options.

One of the following:
output_tokens: int

The number of output tokens which were used.

minimum0
type: Literal["advisor_message"]

Usage for an advisor sub-inference iteration

defaultadvisor_message
class BetaAdvisorRedactedResultBlock:
encrypted_content: str

Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.

stop_reason: Optional[str]

The advisor sub-inference's stop reason (same values as the top-level message stop_reason).

type: Literal["advisor_redacted_result"]
defaultadvisor_redacted_result
class BetaAdvisorRedactedResultBlockParam:
encrypted_content: str

Opaque blob produced by a prior response; must be round-tripped verbatim.

type: Literal["advisor_redacted_result"]
stop_reason: Optional[str]
class BetaAdvisorResultBlock:
stop_reason: Optional[str]

The advisor sub-inference's stop reason (same values as the top-level message stop_reason). max_tokens indicates the advisor's output was truncated at the tool's max_tokens value or the advisor model's policy cap.

text: str
type: Literal["advisor_result"]
defaultadvisor_result
class BetaAdvisorResultBlockParam:
text: str
type: Literal["advisor_result"]
stop_reason: Optional[str]
class BetaAdvisorTool20260301:
class BetaAdvisorToolResultBlock:
class BetaAdvisorToolResultBlockParam:
class BetaAdvisorToolResultError:
error_code: Literal["max_uses_exceeded", "prompt_too_long", "too_many_requests", 4 more]
One of the following:
"max_uses_exceeded"
"prompt_too_long"
"too_many_requests"
"overloaded"
"unavailable"
"execution_time_exceeded"
"model_not_found"
type: Literal["advisor_tool_result_error"]
defaultadvisor_tool_result_error
class BetaAdvisorToolResultErrorParam:
error_code: Literal["max_uses_exceeded", "prompt_too_long", "too_many_requests", 4 more]
One of the following:
"max_uses_exceeded"
"prompt_too_long"
"too_many_requests"
"overloaded"
"unavailable"
"execution_time_exceeded"
"model_not_found"
type: Literal["advisor_tool_result_error"]
class BetaAllThinkingTurns:
type: Literal["all"]
class BetaBase64ImageSource:
data: str
formatbyte
media_type: Literal["image/jpeg", "image/png", "image/gif", "image/webp"]
One of the following:
"image/jpeg"
"image/png"
"image/gif"
"image/webp"
type: Literal["base64"]
class BetaBase64PDFSource:
data: str
formatbyte
media_type: Literal["application/pdf"]
type: Literal["base64"]
class BetaBashCodeExecutionOutputBlock:
file_id: str
type: Literal["bash_code_execution_output"]
defaultbash_code_execution_output
class BetaBashCodeExecutionOutputBlockParam:
file_id: str
type: Literal["bash_code_execution_output"]
class BetaBashCodeExecutionResultBlock:
file_id: str
type: Literal["bash_code_execution_output"]
defaultbash_code_execution_output
return_code: int
stderr: str
stdout: str
type: Literal["bash_code_execution_result"]
defaultbash_code_execution_result
class BetaBashCodeExecutionResultBlockParam:
file_id: str
type: Literal["bash_code_execution_output"]
return_code: int
stderr: str
stdout: str
type: Literal["bash_code_execution_result"]
class BetaBashCodeExecutionToolResultBlock:
class BetaBashCodeExecutionToolResultBlockParam:
class BetaBashCodeExecutionToolResultError:
error_code: Literal["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"
type: Literal["bash_code_execution_tool_result_error"]
defaultbash_code_execution_tool_result_error
class BetaBashCodeExecutionToolResultErrorParam:
error_code: Literal["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"
type: Literal["bash_code_execution_tool_result_error"]
class BetaBrowserCloseTabConfig:

close_tab's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserDoubleClickConfig:

double_click's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserFileUploadConfig:

file_upload's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserFindConfig:

find's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserFormInputConfig:

form_input's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserGetPageTextConfig:

get_page_text's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserHoldKeyConfig:

hold_key's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserHoverConfig:

hover's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserJavascriptExecConfig:

javascript_exec's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserKeyConfig:

key's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserLeftClickConfig:

left_click's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserLeftClickDragConfig:

left_click_drag's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserLeftMouseDownConfig:

left_mouse_down's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserLeftMouseUpConfig:

left_mouse_up's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserListTabsConfig:

list_tabs's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserMiddleClickConfig:

middle_click's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserMouseMoveConfig:

mouse_move's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserNavigateConfig:

navigate's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserNewTabConfig:

new_tab's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserReadConsoleConfig:

read_console's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserReadNetworkConfig:

read_network's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserReadPageConfig:

read_page's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserRightClickConfig:

right_click's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserScreenshotConfig:

screenshot's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserScrollConfig:

scroll's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserScrollToConfig:

scroll_to's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserStateBlockParam:

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.

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 BetaBrowserStateChangeDownloadCompleted:

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: str

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

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

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

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

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: Optional[int]

The completed download's size.

minimum0
class BetaBrowserStateChangeDownloadFailed:

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

download_id: str

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

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

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

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

The failure or cancellation detail, when known.

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

A file download that started during this call.

download_id: str

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

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

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

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

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: str

The tab_id of the opened tab, present in tabs.

maxLength4096
minLength1
pattern^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$
type: Literal["tab_opened"]
class BetaBrowserStateTabEntry:

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: str

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

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

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

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

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

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

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

class BetaBrowserSwitchTabConfig:

switch_tab's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserToolset20260801:

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 BetaBrowserToolsetConfigs:

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 BetaBrowserTripleClickConfig:

triple_click's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserTypeConfig:

type's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserWaitConfig:

wait's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaBrowserZoomConfig:

zoom's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaCacheControlEphemeral:
type: Literal["ephemeral"]
ttl: Optional[Literal["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 BetaCacheCreation:
ephemeral_1h_input_tokens: int

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

default0
minimum0
ephemeral_5m_input_tokens: int

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

default0
minimum0
class BetaCacheMissMessagesChanged:
cache_missed_input_tokens: int

Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

type: Literal["messages_changed"]
defaultmessages_changed
class BetaCacheMissModelChanged:
cache_missed_input_tokens: int

Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

type: Literal["model_changed"]
defaultmodel_changed
class BetaCacheMissPreviousMessageNotFound:
type: Literal["previous_message_not_found"]
defaultprevious_message_not_found
class BetaCacheMissSystemChanged:
cache_missed_input_tokens: int

Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

type: Literal["system_changed"]
defaultsystem_changed
class BetaCacheMissToolsChanged:
cache_missed_input_tokens: int

Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.

type: Literal["tools_changed"]
defaulttools_changed
class BetaCacheMissUnavailable:
type: Literal["unavailable"]
defaultunavailable
class BetaCitationCharLocation:
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_char_index: int
file_id: Optional[str]
start_char_index: int
minimum0
type: Literal["char_location"]
defaultchar_location
class BetaCitationCharLocationParam:
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength500
minLength1
end_char_index: int
start_char_index: int
minimum0
type: Literal["char_location"]
class BetaCitationConfig:
enabled: bool
defaultfalse
class BetaCitationContentBlockLocation:
cited_text: str

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: int
minimum0
document_title: Optional[str]
end_block_index: int

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: Optional[str]
start_block_index: int

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

minimum0
type: Literal["content_block_location"]
defaultcontent_block_location
class BetaCitationContentBlockLocationParam:
cited_text: str

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: int
minimum0
document_title: Optional[str]
maxLength500
minLength1
end_block_index: int

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: int

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

minimum0
type: Literal["content_block_location"]
class BetaCitationPageLocation:
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
end_page_number: int
file_id: Optional[str]
start_page_number: int
minimum1
type: Literal["page_location"]
defaultpage_location
class BetaCitationPageLocationParam:
cited_text: str
document_index: int
minimum0
document_title: Optional[str]
maxLength500
minLength1
end_page_number: int
start_page_number: int
minimum1
type: Literal["page_location"]
class BetaCitationSearchResultLocation:
cited_text: str

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: int

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: int

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: str
start_block_index: int

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

minimum0
title: Optional[str]
type: Literal["search_result_location"]
defaultsearch_result_location
class BetaCitationSearchResultLocationParam:
cited_text: str

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: int

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: int

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: str
start_block_index: int

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

minimum0
title: Optional[str]
type: Literal["search_result_location"]
class BetaCitationWebSearchResultLocationParam:
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
minLength1
type: Literal["web_search_result_location"]
url: str
minLength1
class BetaCitationsConfigParam:
enabled: Optional[bool]
class BetaCitationsDelta:
class BetaCitationsWebSearchResultLocation:
cited_text: str
encrypted_index: str
title: Optional[str]
maxLength512
type: Literal["web_search_result_location"]
defaultweb_search_result_location
url: str
class BetaClearThinking20251015Edit:
type: Literal["clear_thinking_20251015"]
keep: Optional[Keep]

Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.

One of the following:
class BetaThinkingTurns:
type: Literal["thinking_turns"]
value: int
minimum1
class BetaAllThinkingTurns:
type: Literal["all"]
Literal["all"]
class BetaClearThinking20251015EditResponse:
cleared_input_tokens: int

Number of input tokens cleared by this edit.

minimum0
cleared_thinking_turns: int

Number of thinking turns that were cleared.

minimum0
type: Literal["clear_thinking_20251015"]

The type of context management edit applied.

defaultclear_thinking_20251015
class BetaClearToolUses20250919Edit:
class BetaClearToolUses20250919EditResponse:
cleared_input_tokens: int

Number of input tokens cleared by this edit.

minimum0
cleared_tool_uses: int

Number of tool uses that were cleared.

minimum0
type: Literal["clear_tool_uses_20250919"]

The type of context management edit applied.

defaultclear_tool_uses_20250919
class BetaCodeExecutionOutputBlock:
file_id: str
type: Literal["code_execution_output"]
defaultcode_execution_output
class BetaCodeExecutionOutputBlockParam:
file_id: str
type: Literal["code_execution_output"]
class BetaCodeExecutionResultBlock:
file_id: str
type: Literal["code_execution_output"]
defaultcode_execution_output
return_code: int
stderr: str
stdout: str
type: Literal["code_execution_result"]
defaultcode_execution_result
class BetaCodeExecutionResultBlockParam:
file_id: str
type: Literal["code_execution_output"]
return_code: int
stderr: str
stdout: str
type: Literal["code_execution_result"]
class BetaCodeExecutionTool20250522:
class BetaCodeExecutionTool20250825:
class BetaCodeExecutionTool20260120:

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

class BetaCodeExecutionTool20260521:

Code execution tool with REPL state persistence.

class BetaCodeExecutionToolResultBlock:

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

One of the following:
tool_use_id: str
pattern^srvtoolu_[a-zA-Z0-9_]+$
type: Literal["code_execution_tool_result"]
defaultcode_execution_tool_result

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

One of the following:
class BetaCodeExecutionToolResultBlockParam:

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

One of the following:
tool_use_id: str
pattern^srvtoolu_[a-zA-Z0-9_]+$
type: Literal["code_execution_tool_result"]
cache_control: Optional[BetaCacheControlEphemeral]

Create a cache control breakpoint at this content block.

type: Literal["ephemeral"]
ttl: Optional[Literal["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"

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

One of the following:
class BetaCodeExecutionToolResultError:
One of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
defaultcode_execution_tool_result_error
Literal["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 BetaCodeExecutionToolResultErrorParam:
One of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["code_execution_tool_result_error"]
class BetaCompact20260112Edit:

Automatically compact older context when reaching the configured trigger threshold.

type: Literal["compact_20260112"]
instructions: Optional[str]

Additional instructions for summarization.

pause_after_compaction: Optional[bool]

Whether to pause after compaction and return the compaction block to the user.

trigger: Optional[BetaInputTokensTrigger]

When to trigger compaction. Defaults to 150000 input tokens.

type: Literal["input_tokens"]
value: int
minimum1
class BetaCompactionBlock:

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 output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops.

content: Optional[str]

Summary of compacted content, or null if compaction failed

encrypted_content: Optional[str]

Opaque metadata from prior compaction, to be round-tripped verbatim

type: Literal["compaction"]
defaultcompaction
class BetaCompactionBlockParam:

A compaction block containing summary of previous context.

Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries.

When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed.

type: Literal["compaction"]
cache_control: Optional[BetaCacheControlEphemeral]

Create a cache control breakpoint at this content block.

type: Literal["ephemeral"]
ttl: Optional[Literal["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"
content: Optional[str]

Summary of previously compacted content, or null if compaction failed

encrypted_content: Optional[str]

Opaque metadata from prior compaction, to be round-tripped verbatim

class BetaCompactionContentBlockDelta:
content: Optional[str]
encrypted_content: Optional[str]

Opaque metadata from prior compaction, to be round-tripped verbatim

type: Literal["compaction_delta"]
defaultcompaction_delta
class BetaCompactionIterationUsage:

Token usage for a compaction iteration.

cache_creation: Optional[BetaCacheCreation]

Breakdown of cached tokens by TTL

ephemeral_1h_input_tokens: int

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

default0
minimum0
ephemeral_5m_input_tokens: int

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

default0
minimum0
cache_creation_input_tokens: int

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

default0
minimum0
cache_read_input_tokens: int

The number of input tokens read from the cache.

default0
minimum0
input_tokens: int

The number of input tokens which were used.

minimum0
output_tokens: int

The number of output tokens which were used.

minimum0
type: Literal["compaction"]

Usage for a compaction iteration

defaultcompaction
class BetaComputerCursorPositionConfig:

cursor_position's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerDoubleClickConfig:

double_click's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerHoldKeyConfig:

hold_key's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerKeyConfig:

key's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerLeftClickConfig:

left_click's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerLeftClickDragConfig:

left_click_drag's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerLeftMouseDownConfig:

left_mouse_down's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerLeftMouseUpConfig:

left_mouse_up's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerMiddleClickConfig:

middle_click's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerMouseMoveConfig:

mouse_move's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerRightClickConfig:

right_click's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerScreenshotConfig:

screenshot's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerScrollConfig:

scroll's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerToolset20260801:

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 BetaComputerToolsetConfigs:

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 BetaComputerTripleClickConfig:

triple_click's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerTypeConfig:

type's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerWaitConfig:

wait's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaComputerZoomConfig:

zoom's config overrides.

defer_loading: Optional[bool]

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

enabled: Optional[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 BetaContainer:

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

id: str

Identifier for the container used in this request

expires_at: datetime

The time at which the container will expire.

formatdate-time
skills: Optional[List[BetaSkill]]

Skills loaded in the container

skill_id: str

Skill ID

maxLength64
minLength1
type: Literal["anthropic", "custom"]

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

One of the following:
"anthropic"
"custom"
version: str

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

maxLength64
minLength1
class BetaContainerParams:

Container parameters with skills to be loaded.

id: Optional[str]

Container id

skills: Optional[List[BetaSkillParams]]

List of skills to load in the container

maxItems20
skill_id: str

Skill ID

maxLength64
minLength1
type: Literal["anthropic", "custom"]

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

One of the following:
"anthropic"
"custom"
version: Optional[str]

Skill version or 'latest' for most recent version

maxLength64
minLength1
class BetaContainerUploadBlock:

Response model for a file uploaded to the container.

file_id: str
type: Literal["container_upload"]
defaultcontainer_upload
class BetaContainerUploadBlockParam:

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: str
type: Literal["container_upload"]
cache_control: Optional[BetaCacheControlEphemeral]

Create a cache control breakpoint at this content block.

type: Literal["ephemeral"]
ttl: Optional[Literal["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"

Response model for a file uploaded to the container.

One of the following:

Regular text content.

One of the following:
class BetaContentBlockSource:
content: Union[str, List[BetaContentBlockSourceContent]]
One of the following:
str
One of the following:
class BetaTextBlockParam:
class BetaImageBlockParam:
type: Literal["content"]
One of the following:
class BetaTextBlockParam:
class BetaImageBlockParam:
class BetaContextManagementConfig:
class BetaContextManagementResponse:
applied_edits: List[AppliedEdit]

List of context management edits that were applied.

One of the following:
class BetaClearToolUses20250919EditResponse:
cleared_input_tokens: int

Number of input tokens cleared by this edit.

minimum0
cleared_tool_uses: int

Number of tool uses that were cleared.

minimum0
type: Literal["clear_tool_uses_20250919"]

The type of context management edit applied.

defaultclear_tool_uses_20250919
class BetaClearThinking20251015EditResponse:
cleared_input_tokens: int

Number of input tokens cleared by this edit.

minimum0
cleared_thinking_turns: int

Number of thinking turns that were cleared.

minimum0
type: Literal["clear_thinking_20251015"]

The type of context management edit applied.

defaultclear_thinking_20251015
class BetaCountTokensContextManagementResponse:
original_input_tokens: int

The original token count before context management was applied

class BetaDiagnostics:

Response envelope for request-level diagnostics. Present (possibly null) whenever the caller supplied diagnostics on the request.

class BetaDiagnosticsParam:

Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting.

previous_message_id: Optional[str]

The id (msg_...) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns diagnostics.cache_miss_reason when the prompt-cache prefix could not be reused. Pass null on the first turn to opt in without a prior message to compare.

maxLength256
class BetaDirectCaller:

Tool invocation directly from the model.

type: Literal["direct"]
class BetaDocumentBlock:
class BetaEncryptedCodeExecutionResultBlock:

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

file_id: str
type: Literal["code_execution_output"]
defaultcode_execution_output
encrypted_stdout: str
return_code: int
stderr: str
type: Literal["encrypted_code_execution_result"]
defaultencrypted_code_execution_result
class BetaEncryptedCodeExecutionResultBlockParam:

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

file_id: str
type: Literal["code_execution_output"]
encrypted_stdout: str
return_code: int
stderr: str
type: Literal["encrypted_code_execution_result"]
class BetaFallbackBlock:

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 declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a fallback_message entry in usage.iterations, not this block.

The block is treated like a server-tool content block for streaming: it arrives via the standard content_block_start / content_block_stop pair and carries no deltas.

class BetaFallbackBlockParam:

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 fallbacks chain or top-level model.

Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect.

Identifies one hop of a fallback transition.

model: Model

The model that will complete your prompt.

See models for additional details and options.

One of the following:

Identifies one hop of a fallback transition.

model: Model

The model that will complete your prompt.

See models for additional details and options.

One of the following:
type: Literal["fallback"]
trigger: Optional[object]

The response block's trigger, echoed verbatim. Accepted and ignored by the server; any object or null is allowed.

class BetaFallbackCreditNotApplied:

No reprice was applied; reason says why.

class BetaFallbackCreditRedeemed:

The reprice was applied: the retry is billed as if the conversation had been on the retry model all along.

type: Literal["redeemed"]
defaultredeemed
class BetaFallbackCreditTokenParam:

Object form of fallback_credit_token: the token plus a redemption mode.

Requires anthropic-beta: fallback-credit-2026-07-01; without that header the field accepts the bare string only. The bare string and the mode-less object are equivalent (both select strict), so wrapping an existing token changes nothing by itself.

token: str

The opaque fallback_credit_token from a prior refusal's stop_details — the same string the bare-string form carries.

maxLength2048
minLength1
mode: Optional[Literal["strict", "best_effort"]]

How a failing token affects the retry. strict (the default, and the bare-string behavior): a failing redemption is a 400 and the retry is not served. best_effort: the retry is served either way — a token-layer failure no longer rejects the request; the retry proceeds at normal price and the outcome is reported on the response's usage.fallback_credit. Two failures stay hard in both modes: a malformed token, and combining fallback_credit_token with fallbacks.

One of the following:
"strict"
"best_effort"
class BetaFallbackCreditUsage:

Outcome of the fallback_credit_token presented on this request.

status: Status

Whether the fallback-credit reprice was applied to this response's billing.

A union discriminated on type. redeemed: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. not_applied: no reprice was applied; the arm's reason says why.

One of the following:
class BetaFallbackCreditRedeemed:

The reprice was applied: the retry is billed as if the conversation had been on the retry model all along.

type: Literal["redeemed"]
defaultredeemed
class BetaFallbackCreditNotApplied:

No reprice was applied; reason says why.

class BetaFallbackInfo:

Identifies one hop of a fallback transition.

model: Model

The model that will complete your prompt.

See models for additional details and options.

One of the following:
class BetaFallbackInfoParam:

Identifies one hop of a fallback transition.

model: Model

The model that will complete your prompt.

See models for additional details and options.

One of the following:
class BetaFallbackMessageIterationUsage:

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 declined hop produces the existing message entry. Whether a fallback model served the response is signalled by the presence of this entry in usage.iterations.

cache_creation: Optional[BetaCacheCreation]

Breakdown of cached tokens by TTL

ephemeral_1h_input_tokens: int

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

default0
minimum0
ephemeral_5m_input_tokens: int

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

default0
minimum0
cache_creation_input_tokens: int

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

default0
minimum0
cache_read_input_tokens: int

The number of input tokens read from the cache.

default0
minimum0
input_tokens: int

The number of input tokens which were used.

minimum0
model: Model

The model that will complete your prompt.

See models for additional details and options.

One of the following:
output_tokens: int

The number of output tokens which were used.

minimum0
type: Literal["fallback_message"]

Usage for the fallback-model attempt that served the response

defaultfallback_message
class BetaFallbackParam:

One entry in the fallbacks chain on a /v1/messages request.

model is required. The override fields (max_tokens, thinking, output_config, and speed) set the corresponding parameter for this attempt only and are validated as if the request were made to model. Any other key is rejected at parse time.

class BetaFallbackRefusalTrigger:

The from model declined for policy reasons.

category: Optional[Literal["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.

type: Literal["refusal"]
defaultrefusal
Union[List[BetaFallbackParam], Literal["default"], null]

Opt-in server-side retry on one or more substitute models when the requested model declines for policy reasons. Tried in order: if the first entry also declines, the second is tried, and so on. The string "default" requests the requested model's server-defined default fallback configuration.

One of the following:
class BetaFileDocumentSource:
file_id: str
type: Literal["file"]
class BetaFileImageSource:
file_id: str
type: Literal["file"]
class BetaImageBlockParam:
class BetaImageTransformationsParam:

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: Optional[Literal["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 BetaInputJSONDelta:
partial_json: str
type: Literal["input_json_delta"]
defaultinput_json_delta
class BetaInputTokensClearAtLeast:
type: Literal["input_tokens"]
value: int
minimum0
class BetaInputTokensTrigger:
type: Literal["input_tokens"]
value: int
minimum1
Optional[List[BetaIterationsUsageItem]]

Per-iteration token usage breakdown.

Each entry represents one sampling iteration, with its own input/output token counts and cache statistics, discriminated by type. For message entries (model sampling iterations, such as the turns of a server-side tool use loop), this allows you to:

  • Determine which iterations exceeded long context thresholds (>=200k tokens)
  • Calculate the context window size from the last message entry
  • Understand token accumulation across server-side tool use loops

A compaction entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a compaction entry, even when it is the last entry. A compaction entry's tokens are not included in the top-level usage fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each compaction entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results.

One of the following:
class BetaJSONOutputFormat:
schema: Dict[str, object]

The JSON schema of the format

type: Literal["json_schema"]
class BetaMCPToolConfig:

Configuration for a specific tool in an MCP toolset.

defer_loading: Optional[bool]
enabled: Optional[bool]
class BetaMCPToolDefaultConfig:

Default configuration for tools in an MCP toolset.

defer_loading: Optional[bool]
enabled: Optional[bool]
class BetaMCPToolResultBlock:
class BetaMCPToolUseBlock:
id: str
pattern^[a-zA-Z0-9_-]+$
input: Dict[str, object]
name: str

The name of the MCP tool

server_name: str

The name of the MCP server

type: Literal["mcp_tool_use"]
defaultmcp_tool_use
class BetaMCPToolUseBlockParam:
id: str
pattern^[a-zA-Z0-9_-]+$
input: Dict[str, object]
name: str
server_name: str

The name of the MCP server

type: Literal["mcp_tool_use"]
cache_control: Optional[BetaCacheControlEphemeral]

Create a cache control breakpoint at this content block.

type: Literal["ephemeral"]
ttl: Optional[Literal["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 BetaMCPToolset:

Configuration for a group of tools from an MCP server.

Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.

class BetaMemoryTool20250818:
One of the following:
class BetaMemoryTool20250818CreateCommand:
command: Literal["create"]

Command type identifier

defaultcreate
file_text: str

Content to write to the file

path: str

Path where the file should be created

class BetaMemoryTool20250818DeleteCommand:
command: Literal["delete"]

Command type identifier

defaultdelete
path: str

Path to the file or directory to delete

class BetaMemoryTool20250818InsertCommand:
command: Literal["insert"]

Command type identifier

defaultinsert
insert_line: int

Line number where text should be inserted

minimum1
insert_text: str

Text to insert at the specified line

path: str

Path to the file where text should be inserted

class BetaMemoryTool20250818RenameCommand:
command: Literal["rename"]

Command type identifier

defaultrename
new_path: str

New path for the file or directory

old_path: str

Current path of the file or directory

class BetaMemoryTool20250818StrReplaceCommand:
command: Literal["str_replace"]

Command type identifier

defaultstr_replace
new_str: str

Text to replace with

old_str: str

Text to search for and replace

path: str

Path to the file where text should be replaced

class BetaMemoryTool20250818ViewCommand:
command: Literal["view"]

Command type identifier

defaultview
path: str

Path to directory or file to view

view_range: Optional[List[int]]

Optional line range for viewing specific lines

minItems2
maxItems2
class BetaMessage:
class BetaMessageDeltaUsage:
class BetaMessageIterationUsage:

Token usage for a sampling iteration.

cache_creation: Optional[BetaCacheCreation]

Breakdown of cached tokens by TTL

ephemeral_1h_input_tokens: int

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

default0
minimum0
ephemeral_5m_input_tokens: int

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

default0
minimum0
cache_creation_input_tokens: int

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

default0
minimum0
cache_read_input_tokens: int

The number of input tokens read from the cache.

default0
minimum0
input_tokens: int

The number of input tokens which were used.

minimum0
model: Model

The model that will complete your prompt.

See models for additional details and options.

One of the following:
output_tokens: int

The number of output tokens which were used.

minimum0
type: Literal["message"]

Usage for a sampling iteration

defaultmessage
class BetaMessageParam:
class BetaMessageTokensCount:
context_management: Optional[BetaCountTokensContextManagementResponse]

Information about context management applied to the message.

original_input_tokens: int

The original token count before context management was applied

input_tokens: int

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

class BetaMetadata:
user_id: Optional[str]

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
class BetaOutputConfig:
class BetaOutputTokensDetails:
thinking_tokens: int

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.

default0
minimum0
class BetaPlainTextSource:
data: str
media_type: Literal["text/plain"]
type: Literal["text"]
One of the following:
class BetaRawContentBlockDeltaEvent:
One of the following:
index: int
type: Literal["content_block_delta"]
defaultcontent_block_delta
class BetaRawContentBlockStartEvent:
class BetaRawContentBlockStopEvent:
index: int
type: Literal["content_block_stop"]
defaultcontent_block_stop
class BetaRawMessageDeltaEvent:
class BetaRawMessageStartEvent:
message: BetaMessage
type: Literal["message_start"]
defaultmessage_start
class BetaRawMessageStopEvent:
type: Literal["message_stop"]
defaultmessage_stop
One of the following:
class BetaRedactedThinkingBlock:
data: str

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: Literal["redacted_thinking"]
defaultredacted_thinking
class BetaRedactedThinkingBlockParam:
data: str

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: Literal["redacted_thinking"]
class BetaRefusalStopDetails:

Structured information about a refusal.

class BetaRequestDocumentBlock:
class BetaRequestMCPServerToolConfiguration:
allowed_tools: Optional[List[str]]
enabled: Optional[bool]
class BetaRequestMCPServerURLDefinition:
name: str
type: Literal["url"]
url: str
authorization_token: Optional[str]
tool_configuration: Optional[BetaRequestMCPServerToolConfiguration]
allowed_tools: Optional[List[str]]
enabled: Optional[bool]
class BetaRequestMCPToolResultBlockParam:
class BetaRequestToolAdditionBlock:

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 from this point in the conversation onward.

class BetaRequestToolRemovalBlock:

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 from this point in the conversation onward.

class BetaSearchResultBlockParam:
class BetaServerToolCaller:

Tool invocation generated by a server-side tool.

tool_id: str
pattern^srvtoolu_[a-zA-Z0-9_]+$
type: Literal["code_execution_20250825"]
class BetaServerToolCaller20260120:
tool_id: str
pattern^srvtoolu_[a-zA-Z0-9_]+$
type: Literal["code_execution_20260120"]
class BetaServerToolUsage:
web_fetch_requests: int

The number of web fetch tool requests.

default0
minimum0
web_search_requests: int

The number of web search tool requests.

default0
minimum0
class BetaServerToolUseBlock:
class BetaServerToolUseBlockParam:
class BetaSignatureDelta:
signature: str

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: Literal["signature_delta"]
defaultsignature_delta
class BetaSkill:

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

skill_id: str

Skill ID

maxLength64
minLength1
type: Literal["anthropic", "custom"]

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

One of the following:
"anthropic"
"custom"
version: str

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

maxLength64
minLength1
class BetaSkillParams:

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

skill_id: str

Skill ID

maxLength64
minLength1
type: Literal["anthropic", "custom"]

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

One of the following:
"anthropic"
"custom"
version: Optional[str]

Skill version or 'latest' for most recent version

maxLength64
minLength1
Literal["end_turn", "max_tokens", "stop_sequence", 5 more]
One of the following:
"end_turn"
"max_tokens"
"stop_sequence"
"tool_use"
"pause_turn"
"compaction"
"refusal"
"model_context_window_exceeded"
class BetaTextBlock:
class BetaTextBlockParam:
One of the following:
One of the following:
class BetaTextDelta:
text: str
type: Literal["text_delta"]
defaulttext_delta
class BetaTextEditorCodeExecutionCreateResultBlock:
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
defaulttext_editor_code_execution_create_result
class BetaTextEditorCodeExecutionCreateResultBlockParam:
is_file_update: bool
type: Literal["text_editor_code_execution_create_result"]
class BetaTextEditorCodeExecutionStrReplaceResultBlock:
lines: Optional[List[str]]
new_lines: Optional[int]
new_start: Optional[int]
old_lines: Optional[int]
old_start: Optional[int]
type: Literal["text_editor_code_execution_str_replace_result"]
defaulttext_editor_code_execution_str_replace_result
class BetaTextEditorCodeExecutionStrReplaceResultBlockParam:
type: Literal["text_editor_code_execution_str_replace_result"]
lines: Optional[List[str]]
new_lines: Optional[int]
new_start: Optional[int]
old_lines: Optional[int]
old_start: Optional[int]
class BetaTextEditorCodeExecutionToolResultBlock:
class BetaTextEditorCodeExecutionToolResultBlockParam:
class BetaTextEditorCodeExecutionToolResultError:
error_code: Literal["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"
error_message: Optional[str]
type: Literal["text_editor_code_execution_tool_result_error"]
defaulttext_editor_code_execution_tool_result_error
class BetaTextEditorCodeExecutionToolResultErrorParam:
error_code: Literal["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"
type: Literal["text_editor_code_execution_tool_result_error"]
error_message: Optional[str]
class BetaTextEditorCodeExecutionViewResultBlock:
content: str
file_type: Literal["text", "image", "pdf"]
One of the following:
"text"
"image"
"pdf"
num_lines: Optional[int]
start_line: Optional[int]
total_lines: Optional[int]
type: Literal["text_editor_code_execution_view_result"]
defaulttext_editor_code_execution_view_result
class BetaTextEditorCodeExecutionViewResultBlockParam:
content: str
file_type: Literal["text", "image", "pdf"]
One of the following:
"text"
"image"
"pdf"
type: Literal["text_editor_code_execution_view_result"]
num_lines: Optional[int]
start_line: Optional[int]
total_lines: Optional[int]
class BetaThinkingBlock:
signature: str

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: str

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

type: Literal["thinking"]
defaultthinking
class BetaThinkingBlockParam:
signature: str

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: str

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

type: Literal["thinking"]
class BetaThinkingConfigAdaptive:
type: Literal["adaptive"]
display: Optional[Literal["summarized", "omitted", "updates"]]

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"
"updates"
class BetaThinkingConfigDisabled:
type: Literal["disabled"]
class BetaThinkingConfigEnabled:
budget_tokens: int

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: Literal["enabled"]
display: Optional[Literal["summarized", "omitted", "updates"]]

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"
"updates"

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 BetaThinkingDelta:
estimated_tokens: Optional[int]

Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the thinking-token-count-2026-05-13 beta is set; null unless thinking.display resolves to "omitted" and a count is due this frame. Sum the increments across thinking_delta frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; usage.output_tokens remains authoritative.

thinking: str

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: Literal["thinking_delta"]
defaultthinking_delta
class BetaThinkingTurns:
type: Literal["thinking_turns"]
value: int
minimum1
class BetaTokenTaskBudget:

User-configurable total token budget across contexts.

total: int

Total token budget across all contexts in the session.

minimum1024
type: Literal["tokens"]

The budget type. Currently only 'tokens' is supported.

remaining: Optional[int]

Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided.

minimum0
class BetaTool:
class BetaToolBash20241022:
class BetaToolBash20250124:
class BetaToolChangeMCPToolReference:

Reference to a single MCP tool by its server and remote name — the same server_name/name pair mcp_tool_use carries.

name: str
server_name: str
type: Literal["mcp_tool_reference"]
class BetaToolChangeMCPToolsetReference:

Reference to every tool in the named MCP server's toolset.

server_name: str
type: Literal["mcp_toolset_reference"]
class BetaToolChangeToolReference:

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 — use mcp_tool_reference or mcp_toolset_reference for those.

name: str
pattern^[a-zA-Z0-9_-]{1,128}$
type: Literal["tool_reference"]

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 BetaToolChoiceAny:

The model will use any available tools.

type: Literal["any"]
disable_parallel_tool_use: Optional[bool]

Whether to disable parallel tool use.

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

class BetaToolChoiceAuto:

The model will automatically decide whether to use tools.

type: Literal["auto"]
disable_parallel_tool_use: Optional[bool]

Whether to disable parallel tool use.

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

class BetaToolChoiceNone:

The model will not be allowed to use tools.

type: Literal["none"]
class BetaToolChoiceTool:

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

name: str

The name of the tool to use.

type: Literal["tool"]
disable_parallel_tool_use: Optional[bool]

Whether to disable parallel tool use.

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

class BetaToolComputerUse20241022:
class BetaToolComputerUse20250124:
class BetaToolComputerUse20251124:
class BetaToolReferenceBlock:
tool_name: str
maxLength256
minLength1
pattern^[a-zA-Z0-9_-]{1,256}$
type: Literal["tool_reference"]
defaulttool_reference
class BetaToolReferenceBlockParam:

Tool reference block that can be included in tool_result content.

tool_name: str
maxLength256
minLength1
pattern^[a-zA-Z0-9_-]{1,256}$
type: Literal["tool_reference"]
cache_control: Optional[BetaCacheControlEphemeral]

Create a cache control breakpoint at this content block.

type: Literal["ephemeral"]
ttl: Optional[Literal["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 BetaToolResultBlockParam:
class BetaToolSearchToolBm25_20251119:
class BetaToolSearchToolRegex20251119:
class BetaToolSearchToolResultBlock:
class BetaToolSearchToolResultBlockParam:
class BetaToolSearchToolResultError:
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
One of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
error_message: Optional[str]
type: Literal["tool_search_tool_result_error"]
defaulttool_search_tool_result_error
class BetaToolSearchToolResultErrorParam:
error_code: Literal["invalid_tool_input", "unavailable", "too_many_requests", "execution_time_exceeded"]
One of the following:
"invalid_tool_input"
"unavailable"
"too_many_requests"
"execution_time_exceeded"
type: Literal["tool_search_tool_result_error"]
error_message: Optional[str]
class BetaToolSearchToolSearchResultBlock:
tool_references: List[BetaToolReferenceBlock]
tool_name: str
maxLength256
minLength1
pattern^[a-zA-Z0-9_-]{1,256}$
type: Literal["tool_reference"]
defaulttool_reference
type: Literal["tool_search_tool_search_result"]
defaulttool_search_tool_search_result
class BetaToolSearchToolSearchResultBlockParam:
tool_references: List[BetaToolReferenceBlockParam]
tool_name: str
maxLength256
minLength1
pattern^[a-zA-Z0-9_-]{1,256}$
type: Literal["tool_reference"]
cache_control: Optional[BetaCacheControlEphemeral]

Create a cache control breakpoint at this content block.

type: Literal["ephemeral"]
ttl: Optional[Literal["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: Literal["tool_search_tool_search_result"]
class BetaToolTextEditor20241022:
class BetaToolTextEditor20250124:
class BetaToolTextEditor20250429:
class BetaToolTextEditor20250728:

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

One of the following:
class BetaToolUseBlock:
class BetaToolUseBlockParam:
class BetaToolUsesKeep:
type: Literal["tool_uses"]
value: int
minimum0
class BetaToolUsesTrigger:
type: Literal["tool_uses"]
value: int
minimum1
class BetaURLImageSource:
type: Literal["url"]
url: str
class BetaURLPDFSource:
type: Literal["url"]
url: str
class BetaUsage:
class BetaUserLocation:
type: Literal["approximate"]
city: Optional[str]

The city of the user.

maxLength255
minLength1
country: Optional[str]

The two letter ISO country code of the user.

maxLength2
minLength2
region: Optional[str]

The region of the user.

maxLength255
minLength1
timezone: Optional[str]

The IANA timezone of the user.

maxLength255
minLength1
class BetaWebFetchBlock:
retrieved_at: Optional[str]

ISO 8601 timestamp when the content was retrieved

type: Literal["web_fetch_result"]
defaultweb_fetch_result
url: str

Fetched content URL

class BetaWebFetchBlockParam:
type: Literal["web_fetch_result"]
url: str

Fetched content URL

retrieved_at: Optional[str]

ISO 8601 timestamp when the content was retrieved

class BetaWebFetchTool20250910:
class BetaWebFetchTool20260209:
class BetaWebFetchTool20260309:

Web fetch tool with use_cache parameter for bypassing cached content.

class BetaWebFetchTool20260318:
class BetaWebFetchToolResultBlock:
class BetaWebFetchToolResultBlockParam:
class BetaWebFetchToolResultErrorBlock:
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: Literal["web_fetch_tool_result_error"]
defaultweb_fetch_tool_result_error
class BetaWebFetchToolResultErrorBlockParam:
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: Literal["web_fetch_tool_result_error"]
Literal["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 BetaWebSearchResultBlock:
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
defaultweb_search_result
url: str
class BetaWebSearchResultBlockParam:
encrypted_content: str
title: str
type: Literal["web_search_result"]
url: str
page_age: Optional[str]
class BetaWebSearchTool20250305:
class BetaWebSearchTool20260209:
class BetaWebSearchTool20260318:
class BetaWebSearchToolRequestError:
One of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
"request_too_large"
type: Literal["web_search_tool_result_error"]
class BetaWebSearchToolResultBlock:
One of the following:
class BetaWebSearchToolResultError:
One of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
"request_too_large"
type: Literal["web_search_tool_result_error"]
defaultweb_search_tool_result_error
encrypted_content: str
page_age: Optional[str]
title: str
type: Literal["web_search_result"]
defaultweb_search_result
url: str
class BetaWebSearchToolResultBlockParam:
One of the following:
encrypted_content: str
title: str
type: Literal["web_search_result"]
url: str
page_age: Optional[str]
class BetaWebSearchToolRequestError:
One of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
"request_too_large"
type: Literal["web_search_tool_result_error"]
class BetaWebSearchToolResultError:
One of the following:
"invalid_tool_input"
"unavailable"
"max_uses_exceeded"
"too_many_requests"
"query_too_long"
"request_too_large"
type: Literal["web_search_tool_result_error"]
defaultweb_search_tool_result_error
Literal["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
beta.messages.batches.create(BatchCreateParams**kwargs) -> BetaMessageBatch
POST/v1/messages/batches
Retrieve a Message Batch
beta.messages.batches.retrieve(strmessage_batch_id, BatchRetrieveParams**kwargs) -> BetaMessageBatch
GET/v1/messages/batches/{message_batch_id}
List Message Batches
beta.messages.batches.list(BatchListParams**kwargs) -> SyncPage[BetaMessageBatch]
GET/v1/messages/batches
Cancel a Message Batch
beta.messages.batches.cancel(strmessage_batch_id, BatchCancelParams**kwargs) -> BetaMessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel
Delete a Message Batch
beta.messages.batches.delete(strmessage_batch_id, BatchDeleteParams**kwargs) -> BetaDeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
beta.messages.batches.results(strmessage_batch_id, BatchResultsParams**kwargs) -> BetaMessageBatchIndividualResponse
GET/v1/messages/batches/{message_batch_id}/results