Сообщения
Создать сообщение
client.Beta.Messages.New(ctx, params) (*BetaMessage, error)Отправьте структурированный список входных сообщений с текстом и/или изображениями, и модель сгенерирует следующее сообщение в разговоре.
Подсчитать токены в сообщении
client.Beta.Messages.CountTokens(ctx, params) (*BetaMessageTokensCount, error)Подсчитайте количество токенов в сообщении.
Models
type BetaAdvisorMessageIterationUsage struct { Type: "advisor_message"; CacheCreation; CacheCreationInputTokens; /* 4 more */ }Token usage for an advisor sub-inference iteration.
Token usage for an advisor sub-inference iteration.
Type AdvisorMessageUsage for an advisor sub-inference iteration
Usage for an advisor sub-inference iteration
CacheCreation BetaCacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 1 hour cache entry.
Ephemeral5mInputTokens int64The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the 5 minute cache entry.
CacheCreationInputTokens int64The number of input tokens used to create the cache entry.
The number of input tokens used to create the cache entry.
CacheReadInputTokens int64The number of input tokens read from the cache.
The number of input tokens read from the cache.
InputTokens int64The number of input tokens which were used.
The number of input tokens which were used.
OutputTokens int64The number of output tokens which were used.
The number of output tokens which were used.
type BetaAdvisorRedactedResultBlock struct { Type: "advisor_redacted_result"; EncryptedContent; StopReason }
Type AdvisorRedactedResult
Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify.
The advisor sub-inference's stop reason (same values as the top-level message stop_reason).
type BetaAdvisorRedactedResultBlockParam struct { Type: "advisor_redacted_result"; EncryptedContent; StopReason }
Opaque blob produced by a prior response; must be round-tripped verbatim.
type BetaAdvisorResultBlock struct { Type: "advisor_result"; StopReason; Text }
Type AdvisorResult
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.
type BetaAdvisorResultBlockParam struct { Type: "advisor_result"; Text; StopReason }
type BetaAdvisorTool20260301 struct { Type: "advisor_20260301"; Model; Name; /* 7 more */ }
type BetaAdvisorToolResultBlock struct { Type: "advisor_tool_result"; Content; ToolUseID }
type BetaAdvisorToolResultBlockParam struct { Type: "advisor_tool_result"; Content; ToolUseID; CacheControl }
type BetaAdvisorToolResultError struct { Type: "advisor_tool_result_error"; ErrorCode }
Type AdvisorToolResultError
ErrorCode BetaAdvisorToolResultErrorErrorCode
type BetaAdvisorToolResultErrorParam struct { Type: "advisor_tool_result_error"; ErrorCode }
ErrorCode BetaAdvisorToolResultErrorParamErrorCode
type BetaAllThinkingTurnsParam struct { Type: "all" }
type BetaBase64ImageSourceParam struct { Type: "base64"; Data; MediaType }
Data string
MediaType BetaBase64ImageSourceMediaType
type BetaBase64PDFSource struct { Type: "base64"; Data; MediaType }
Data string
type BetaBashCodeExecutionOutputBlock struct { Type: "bash_code_execution_output"; FileID }
Type BashCodeExecutionOutput
type BetaBashCodeExecutionOutputBlockParam struct { Type: "bash_code_execution_output"; FileID }
type BetaBashCodeExecutionResultBlock struct { Type: "bash_code_execution_result"; Content; ReturnCode; /* 2 more */ }
Type BashCodeExecutionResult
Content []BetaBashCodeExecutionOutputBlock
Type BashCodeExecutionOutput
type BetaBashCodeExecutionResultBlockParam struct { Type: "bash_code_execution_result"; Content; ReturnCode; /* 2 more */ }
Content []BetaBashCodeExecutionOutputBlockParam
type BetaBashCodeExecutionToolResultBlock struct { Type: "bash_code_execution_tool_result"; Content; ToolUseID }
type BetaBashCodeExecutionToolResultBlockParam struct { Type: "bash_code_execution_tool_result"; Content; ToolUseID; CacheControl }
type BetaBashCodeExecutionToolResultError struct { Type: "bash_code_execution_tool_result_error"; ErrorCode }
Type BashCodeExecutionToolResultError
ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode
type BetaBashCodeExecutionToolResultErrorParam struct { Type: "bash_code_execution_tool_result_error"; ErrorCode }
ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode
type BetaBrowserClickTargetUnion interface{…}Where to act: either a viewport coordinate or an element reference.
Where to act: either a viewport coordinate or an element reference.
type BetaBrowserCoordinateTarget struct { Type: "coordinate"; X; Y }A point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
type BetaBrowserRefTarget struct { Type: "ref"; Ref }An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
type BetaBrowserCloseTabConfig struct { DeferLoading; Enabled }close_tab's config overrides.
close_tab's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserCloseTabInput struct { TabID }Close the tab with the given tab_id.
Close the tab with the given tab_id.
The tab to close.
type BetaBrowserCloseTabToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserCoordinateTarget struct { Type: "coordinate"; X; Y }A point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
type BetaBrowserDoubleClickConfig struct { DeferLoading; Enabled }double_click's config overrides.
double_click's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserDoubleClickInput struct { Target; Modifiers; TabID }Double left-click at a viewport coordinate or on an element by reference.
Double left-click at a viewport coordinate or on an element by reference.
Target BetaBrowserClickTargetUnionWhere to act: either a viewport coordinate or an element reference.
Where to act: either a viewport coordinate or an element reference.
type BetaBrowserCoordinateTarget struct { Type: "coordinate"; X; Y }A point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
type BetaBrowserRefTarget struct { Type: "ref"; Ref }An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserDoubleClickToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserFileUploadConfig struct { DeferLoading; Enabled }file_upload's config overrides.
file_upload's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserFileUploadInput struct { Target; DocumentIDs; Paths; TabID }Set the value of a file-input element to one or more files. The target must be an
element reference; at least one of paths or document_ids is required.
Set the value of a file-input element to one or more files. The target must be an element reference; at least one of paths or document_ids is required.
Target BetaBrowserRefTargetAn element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
DocumentIDs []string OptionalReferences to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem.
References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem.
Paths []string OptionalFile paths on the browser executor's filesystem.
File paths on the browser executor's filesystem.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserFileUploadToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserFindConfig struct { DeferLoading; Enabled }find's config overrides.
find's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserFindInput struct { Query; TabID }Find elements matching a natural-language description (e.g. "search bar", "add to
cart button") and return up to 20 matches with element references.
Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references.
Natural-language description of the element(s) to find.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserFindToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserFormInputConfig struct { DeferLoading; Enabled }form_input's config overrides.
form_input's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserFormInputInput struct { Target; Value; TabID }Set the value of a form element (input, textarea, select, checkbox). Use a
boolean for checkboxes, an option value or text for selects.
Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects.
Target BetaBrowserRefTargetAn element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
The value to set.
The value to set.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserFormInputToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserFormInputValueUnion interface{…}
type BetaBrowserGetPageTextConfig struct { DeferLoading; Enabled }get_page_text's config overrides.
get_page_text's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserGetPageTextInput struct { TabID }Return the page's visible text content as plain text, prioritizing article
content. Suited to articles, documentation, and other text-heavy pages.
Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserGetPageTextToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserHoldKeyConfig struct { DeferLoading; Enabled }hold_key's config overrides.
hold_key's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserHoldKeyInput struct { Duration; Text; TabID }Hold a key or key chord down for a duration, then release it. Uses the same key
names and "+" chord syntax as the key action.
Hold a key or key chord down for a duration, then release it. Uses the same key names and "+" chord syntax as the key action.
Duration float64Seconds to hold the key down (maximum 30).
Seconds to hold the key down (maximum 30).
The key or chord to hold.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserHoldKeyToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserHoverConfig struct { DeferLoading; Enabled }hover's config overrides.
hover's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserHoverInput struct { Target; TabID }Move the cursor to a coordinate or element without clicking.
Move the cursor to a coordinate or element without clicking.
Target BetaBrowserClickTargetUnionWhere to act: either a viewport coordinate or an element reference.
Where to act: either a viewport coordinate or an element reference.
type BetaBrowserCoordinateTarget struct { Type: "coordinate"; X; Y }A point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
type BetaBrowserRefTarget struct { Type: "ref"; Ref }An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserHoverToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserJavascriptExecConfig struct { DeferLoading; Enabled }javascript_exec's config overrides.
javascript_exec's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserJavascriptExecInput struct { Text; TabID }Execute JavaScript in the page context and return the value of the last
expression. The code runs with access to the DOM, window, and page variables.
Write the expression you want evaluated — do NOT use return.
Execute JavaScript in the page context and return the value of the last
expression. The code runs with access to the DOM, window, and page variables.
Write the expression you want evaluated — do NOT use return.
JavaScript to execute in the page context.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserJavascriptExecToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserKeyConfig struct { DeferLoading; Enabled }key's config overrides.
key's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserKeyInput struct { Text; Repeat; TabID }Press a key or key chord. Use "+" to combine modifiers with a key (e.g. "ctrl+a",
"cmd+shift+p") and space to sequence presses (e.g. "Backspace Backspace Delete").
Common names like "Return", "Tab", "Escape", "BackSpace" are supported.
Press a key or key chord. Use "+" to combine modifiers with a key (e.g. "ctrl+a", "cmd+shift+p") and space to sequence presses (e.g. "Backspace Backspace Delete"). Common names like "Return", "Tab", "Escape", "BackSpace" are supported.
The key, chord, or space-separated sequence to press.
Repeat int64 OptionalNumber of times to repeat. Default 1.
Number of times to repeat. Default 1.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserKeyToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserLeftClickConfig struct { DeferLoading; Enabled }left_click's config overrides.
left_click's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserLeftClickDragConfig struct { DeferLoading; Enabled }left_click_drag's config overrides.
left_click_drag's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserLeftClickDragInput struct { From; Target; TabID }Press at from, drag to target, release. Both must be coordinate targets.
Press at from, drag to target, release. Both must be coordinate targets.
A point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
Target BetaBrowserCoordinateTargetA point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserLeftClickDragToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserLeftClickInput struct { Target; Modifiers; TabID }Left-click at a viewport coordinate or on an element by reference.
Left-click at a viewport coordinate or on an element by reference.
Target BetaBrowserClickTargetUnionWhere to act: either a viewport coordinate or an element reference.
Where to act: either a viewport coordinate or an element reference.
type BetaBrowserCoordinateTarget struct { Type: "coordinate"; X; Y }A point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
type BetaBrowserRefTarget struct { Type: "ref"; Ref }An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserLeftClickToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserLeftMouseDownConfig struct { DeferLoading; Enabled }left_mouse_down's config overrides.
left_mouse_down's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserLeftMouseDownInput struct { Target; TabID }Press and hold the left mouse button at a viewport coordinate. Pair with
left_mouse_up to perform a custom drag.
Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag.
Target BetaBrowserCoordinateTargetA point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserLeftMouseDownToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserLeftMouseUpConfig struct { DeferLoading; Enabled }left_mouse_up's config overrides.
left_mouse_up's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserLeftMouseUpInput struct { Target; TabID }Release the left mouse button at a viewport coordinate.
Release the left mouse button at a viewport coordinate.
Target BetaBrowserCoordinateTargetA point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserLeftMouseUpToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserListTabsConfig struct { DeferLoading; Enabled }list_tabs's config overrides.
list_tabs's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
List all open tabs with each tab's tab_id, title, and URL.
type BetaBrowserListTabsToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserMiddleClickConfig struct { DeferLoading; Enabled }middle_click's config overrides.
middle_click's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserMiddleClickInput struct { Target; Modifiers; TabID }Middle-click at a viewport coordinate or on an element by reference.
Middle-click at a viewport coordinate or on an element by reference.
Target BetaBrowserClickTargetUnionWhere to act: either a viewport coordinate or an element reference.
Where to act: either a viewport coordinate or an element reference.
type BetaBrowserCoordinateTarget struct { Type: "coordinate"; X; Y }A point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
type BetaBrowserRefTarget struct { Type: "ref"; Ref }An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserMiddleClickToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserMouseMoveConfig struct { DeferLoading; Enabled }mouse_move's config overrides.
mouse_move's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserMouseMoveInput struct { Target; TabID }Move the pointer to a viewport coordinate without clicking.
Move the pointer to a viewport coordinate without clicking.
Target BetaBrowserCoordinateTargetA point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserMouseMoveToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserNavigateConfig struct { DeferLoading; Enabled }navigate's config overrides.
navigate's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserNavigateInput struct { URL; TabID }Navigate to a URL, or go back/forward/reload in history. The protocol may be
omitted (defaults to https://).
Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://).
The URL to navigate to, or "back" / "forward" / "reload" for history navigation.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserNavigateToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserNewTabConfig struct { DeferLoading; Enabled }new_tab's config overrides.
new_tab's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
Open a new empty tab and return its tab_id.
type BetaBrowserNewTabToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserReadConsoleConfig struct { DeferLoading; Enabled }read_console's config overrides.
read_console's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserReadConsoleInput struct { TabID }Return console output (log entries, errors, warnings) accumulated since the
driver attached to the tab and since the last read, one line per entry. An empty
result does not mean no traffic for a tab that predates attach.
Return console output (log entries, errors, warnings) accumulated since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserReadConsoleToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserReadNetworkConfig struct { DeferLoading; Enabled }read_network's config overrides.
read_network's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserReadNetworkInput struct { TabID }Return the network requests (method, URL, status, MIME type, timing) recorded
since the driver attached to the tab and since the last read, one line per entry.
An empty result does not mean no traffic for a tab that predates attach.
Return the network requests (method, URL, status, MIME type, timing) recorded since the driver attached to the tab and since the last read, one line per entry. An empty result does not mean no traffic for a tab that predates attach.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserReadNetworkToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserReadPageConfig struct { DeferLoading; Enabled }read_page's config overrides.
read_page's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserReadPageFilter string
type BetaBrowserReadPageInput struct { Depth; Filter; Ref; TabID }Return a structured accessibility tree of the page (or the subtree rooted at
ref), with element references like [ref_7] that can be used as targets on later
actions. Output is capped at 50,000 characters — narrow with ref or a smaller
depth when exceeded.
Return a structured accessibility tree of the page (or the subtree rooted at
ref), with element references like [ref_7] that can be used as targets on later
actions. Output is capped at 50,000 characters — narrow with ref or a smaller
depth when exceeded.
Depth int64 OptionalMaximum tree depth. Default 15.
Maximum tree depth. Default 15.
Filter BetaBrowserReadPageFilter OptionalWhich elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements.
Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements.
Element reference to read a subtree from. Omit to read from the page root.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserReadPageToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserRefTarget struct { Type: "ref"; Ref }An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
type BetaBrowserRightClickConfig struct { DeferLoading; Enabled }right_click's config overrides.
right_click's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserRightClickInput struct { Target; Modifiers; TabID }Right-click at a viewport coordinate or on an element by reference.
Right-click at a viewport coordinate or on an element by reference.
Target BetaBrowserClickTargetUnionWhere to act: either a viewport coordinate or an element reference.
Where to act: either a viewport coordinate or an element reference.
type BetaBrowserCoordinateTarget struct { Type: "coordinate"; X; Y }A point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
type BetaBrowserRefTarget struct { Type: "ref"; Ref }An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserRightClickToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserScreenshotConfig struct { DeferLoading; Enabled }screenshot's config overrides.
screenshot's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserScreenshotInput struct { TabID }Capture the current browser viewport.
Capture the current browser viewport.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserScreenshotToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserScrollConfig struct { DeferLoading; Enabled }scroll's config overrides.
scroll's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserScrollDirection string
type BetaBrowserScrollInput struct { ScrollDirection; Target; ScrollAmount; TabID }Scroll at a viewport position. target must be a coordinate target.
Scroll at a viewport position. target must be a coordinate target.
ScrollDirection BetaBrowserScrollDirection
Target BetaBrowserCoordinateTargetA point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
ScrollAmount int64 OptionalScroll-wheel notches (1–10). Default 3.
Scroll-wheel notches (1–10). Default 3.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserScrollToConfig struct { DeferLoading; Enabled }scroll_to's config overrides.
scroll_to's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserScrollToInput struct { Target; TabID }Scroll an element into view.
Scroll an element into view.
Target BetaBrowserRefTargetAn element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserScrollToToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserScrollToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserStateBlockParam struct { Type: "browser_state"; Tabs; CacheControl; StateChanges }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.
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.
type BetaBrowserStateChangeUnionParam interface{…}
type BetaBrowserStateChangeDownloadCompletedParam struct { Type: "download_completed"; DownloadID; 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).
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).
DownloadID stringThe caller-assigned identifier for this download, stable across the state changes reporting it.
The caller-assigned identifier for this download, stable across the state changes reporting it.
URL stringThe final post-redirect URL the download was served from.
The final post-redirect URL the download was served from.
Path string OptionalWhere 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.
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.
SizeBytes int64 OptionalThe completed download's size.
The completed download's size.
type BetaBrowserStateChangeDownloadFailedParam struct { Type: "download_failed"; DownloadID; URL; Error }A file download that failed — or was cancelled — during this call.
A file download that failed — or was cancelled — during this call.
DownloadID stringThe caller-assigned identifier for this download, stable across the state changes reporting it.
The caller-assigned identifier for this download, stable across the state changes reporting it.
URL stringThe final post-redirect URL the download was served from.
The final post-redirect URL the download was served from.
Error string OptionalThe failure or cancellation detail, when known.
The failure or cancellation detail, when known.
type BetaBrowserStateChangeDownloadStartedParam struct { Type: "download_started"; DownloadID; URL }A file download that started during this call.
A file download that started during this call.
DownloadID stringThe caller-assigned identifier for this download, stable across the state changes reporting it.
The caller-assigned identifier for this download, stable across the state changes reporting it.
URL stringThe final post-redirect URL the download was served from.
The final post-redirect URL the download was served from.
type BetaBrowserStateChangeTabOpenedParam struct { Type: "tab_opened"; TabID }A tab this call's execution opened that remains open at its end —
the creation delta of the tabs inventory, not an event log.
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.
TabID stringThe tab_id of the opened tab, present in tabs.
The tab_id of the opened tab, present in tabs.
type BetaBrowserStateTabEntryParam struct { TabID; Title; URL; Active }One open browser tab reported in a browser_state block's tabs
inventory.
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.
TabID stringThe caller-assigned identifier for this tab, unique within the inventory.
The caller-assigned identifier for this tab, unique within the inventory.
Title stringThe title of the page the tab is showing. May be empty.
The title of the page the tab is showing. May be empty.
URL stringThe URL of the page the tab is showing. May be empty.
The URL of the page the tab is showing. May be empty.
Whether this tab is the active tab after this call. Whenever tabs is non-empty, exactly one entry is marked active: true.
type BetaBrowserSwitchTabConfig struct { DeferLoading; Enabled }switch_tab's config overrides.
switch_tab's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserSwitchTabInput struct { TabID }Make the tab with the given tab_id the active tab — the tab that actions without
a tab_id apply to.
Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to.
The tab to switch to.
type BetaBrowserSwitchTabToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserToolUseBlockUnion interface{…}
type BetaBrowserToolset20260801 struct { Type: "browser_toolset_20260801"; CacheControl; 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.
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.
CacheControl BetaCacheControlEphemeral OptionalCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
TTL BetaCacheControlEphemeralTTL OptionalThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m. See prompt caching pricing for details.
Configs BetaBrowserToolsetConfigs OptionalSparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
type BetaBrowserToolsetConfigs struct { Type; CloseTab; DoubleClick; /* 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.
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.
type BetaBrowserTripleClickConfig struct { DeferLoading; Enabled }triple_click's config overrides.
triple_click's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserTripleClickInput struct { Target; Modifiers; TabID }Triple left-click at a viewport coordinate or on an element by reference
(typically selects a line or paragraph).
Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph).
Target BetaBrowserClickTargetUnionWhere to act: either a viewport coordinate or an element reference.
Where to act: either a viewport coordinate or an element reference.
type BetaBrowserCoordinateTarget struct { Type: "coordinate"; X; Y }A point in the browser viewport, in viewport pixels (the same frame as a
full-viewport screenshot).
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
X int64Pixels from the left edge of the viewport.
Pixels from the left edge of the viewport.
Y int64Pixels from the top edge of the viewport.
Pixels from the top edge of the viewport.
type BetaBrowserRefTarget struct { Type: "ref"; Ref }An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element on the page, identified by a reference from a prior read_page or
find result. References are scoped to the tab that produced them and become
stale after navigation or a major re-render.
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt").
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserTripleClickToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserTypeConfig struct { DeferLoading; Enabled }type's config overrides.
type's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserTypeInput struct { Text; TabID }Type a literal string at the current focus.
Type a literal string at the current focus.
The text to type.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserTypeToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserWaitConfig struct { DeferLoading; Enabled }wait's config overrides.
wait's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserWaitInput struct { Duration; TabID }Pause for the given duration.
Pause for the given duration.
Duration float64Seconds to wait (maximum 30).
Seconds to wait (maximum 30).
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserWaitToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaBrowserZoomConfig struct { DeferLoading; Enabled }zoom's config overrides.
zoom's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaBrowserZoomInput struct { Region; TabID }Return a cropped screenshot of the given viewport region, scaled up for closer
inspection — useful for small icons, buttons, or text. Coordinates are in the
same viewport-pixel space as a full screenshot.
Return a cropped screenshot of the given viewport region, scaled up for closer inspection — useful for small icons, buttons, or text. Coordinates are in the same viewport-pixel space as a full screenshot.
Region []int64[x0, y0, x1, y1] in viewport pixels.
[x0, y0, x1, y1] in viewport pixels.
Tab to act on. Defaults to the active tab when omitted.
type BetaBrowserZoomToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaCacheControlEphemeral struct { Type: "ephemeral"; TTL }
TTL BetaCacheControlEphemeralTTL OptionalThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m. See prompt caching pricing for details.
type BetaCacheCreation struct { Ephemeral1hInputTokens; Ephemeral5mInputTokens }
Ephemeral1hInputTokens int64The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 1 hour cache entry.
Ephemeral5mInputTokens int64The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the 5 minute cache entry.
type BetaCacheMissMessagesChanged struct { Type: "messages_changed"; CacheMissedInputTokens }
Type MessagesChanged
Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
type BetaCacheMissModelChanged struct { Type: "model_changed"; CacheMissedInputTokens }
Type ModelChanged
Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
type BetaCacheMissPreviousMessageNotFound struct { Type: "previous_message_not_found" }
Type PreviousMessageNotFound
type BetaCacheMissReasonUnion interface{…}
type BetaCacheMissSystemChanged struct { Type: "system_changed"; CacheMissedInputTokens }
Type SystemChanged
Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
type BetaCacheMissToolsChanged struct { Type: "tools_changed"; CacheMissedInputTokens }
Type ToolsChanged
Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
type BetaCacheMissUnavailable struct { Type: "unavailable" }
Type Unavailable
type BetaCitationCharLocation struct { Type: "char_location"; CitedText; DocumentIndex; /* 4 more */ }
Type CharLocation
DocumentIndex int64
StartCharIndex int64
type BetaCitationCharLocationParam struct { Type: "char_location"; CitedText; DocumentIndex; /* 3 more */ }
DocumentIndex int64
DocumentTitle string
StartCharIndex int64
type BetaCitationConfig struct { Enabled }
Enabled bool
type BetaCitationContentBlockLocation struct { Type: "content_block_location"; CitedText; DocumentIndex; /* 4 more */ }
Type ContentBlockLocation
CitedText stringThe full text of the cited block range, concatenated.
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.
DocumentIndex int64
EndBlockIndex int64Exclusive 0-based end index of the cited block range in the source's content array.
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.
StartBlockIndex int640-based index of the first cited block in the source's content array.
0-based index of the first cited block in the source's content array.
type BetaCitationContentBlockLocationParam struct { Type: "content_block_location"; CitedText; DocumentIndex; /* 3 more */ }
CitedText stringThe full text of the cited block range, concatenated.
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.
DocumentIndex int64
DocumentTitle string
EndBlockIndex int64Exclusive 0-based end index of the cited block range in the source's content array.
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.
StartBlockIndex int640-based index of the first cited block in the source's content array.
0-based index of the first cited block in the source's content array.
type BetaCitationPageLocation struct { Type: "page_location"; CitedText; DocumentIndex; /* 4 more */ }
Type PageLocation
DocumentIndex int64
StartPageNumber int64
type BetaCitationPageLocationParam struct { Type: "page_location"; CitedText; DocumentIndex; /* 3 more */ }
DocumentIndex int64
DocumentTitle string
StartPageNumber int64
type BetaCitationSearchResultLocation struct { Type: "search_result_location"; CitedText; EndBlockIndex; /* 4 more */ }
Type SearchResultLocation
CitedText stringThe full text of the cited block range, concatenated.
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.
EndBlockIndex int64Exclusive 0-based end index of the cited block range in the source's content array.
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.
SearchResultIndex int640-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.
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.
StartBlockIndex int640-based index of the first cited block in the source's content array.
0-based index of the first cited block in the source's content array.
type BetaCitationSearchResultLocationParam struct { Type: "search_result_location"; CitedText; EndBlockIndex; /* 4 more */ }
CitedText stringThe full text of the cited block range, concatenated.
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.
EndBlockIndex int64Exclusive 0-based end index of the cited block range in the source's content array.
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.
SearchResultIndex int640-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.
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.
StartBlockIndex int640-based index of the first cited block in the source's content array.
0-based index of the first cited block in the source's content array.
type BetaCitationWebSearchResultLocationParam struct { Type: "web_search_result_location"; CitedText; EncryptedIndex; /* 2 more */ }
Title string
URL string
type BetaCitationsConfigParamResp struct { Enabled }
type BetaCitationsDelta struct { Type: "citations_delta"; Citation }
type BetaCitationsWebSearchResultLocation struct { Type: "web_search_result_location"; CitedText; EncryptedIndex; /* 2 more */ }
Type WebSearchResultLocation
Title string
type BetaClearThinking20251015EditParam struct { Type: "clear_thinking_20251015"; Keep }
Keep BetaClearThinking20251015EditKeepUnionParam OptionalNumber of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed.
type BetaThinkingTurnsParam struct { Type: "thinking_turns"; Value }
Value int64
type BetaAllThinkingTurnsParam struct { Type: "all" }
type BetaClearThinking20251015EditResponse struct { Type: "clear_thinking_20251015"; ClearedInputTokens; ClearedThinkingTurns }
Type ClearThinking20251015The type of context management edit applied.
The type of context management edit applied.
ClearedInputTokens int64Number of input tokens cleared by this edit.
Number of input tokens cleared by this edit.
ClearedThinkingTurns int64Number of thinking turns that were cleared.
Number of thinking turns that were cleared.
type BetaClearToolUses20250919EditParam struct { Type: "clear_tool_uses_20250919"; ClearAtLeast; ClearToolInputs; /* 3 more */ }
type BetaClearToolUses20250919EditResponse struct { Type: "clear_tool_uses_20250919"; ClearedInputTokens; ClearedToolUses }
Type ClearToolUses20250919The type of context management edit applied.
The type of context management edit applied.
ClearedInputTokens int64Number of input tokens cleared by this edit.
Number of input tokens cleared by this edit.
ClearedToolUses int64Number of tool uses that were cleared.
Number of tool uses that were cleared.
type BetaCodeExecutionOutputBlock struct { Type: "code_execution_output"; FileID }
Type CodeExecutionOutput
type BetaCodeExecutionOutputBlockParam struct { Type: "code_execution_output"; FileID }
type BetaCodeExecutionResultBlock struct { Type: "code_execution_result"; Content; ReturnCode; /* 2 more */ }
Type CodeExecutionResult
Content []BetaCodeExecutionOutputBlock
Type CodeExecutionOutput
type BetaCodeExecutionResultBlockParam struct { Type: "code_execution_result"; Content; ReturnCode; /* 2 more */ }
Content []BetaCodeExecutionOutputBlockParam
type BetaCodeExecutionTool20250522 struct { Type: "code_execution_20250522"; Name; AllowedCallers; /* 3 more */ }
type BetaCodeExecutionTool20250825 struct { Type: "code_execution_20250825"; Name; AllowedCallers; /* 3 more */ }
type BetaCodeExecutionTool20260120 struct { Type: "code_execution_20260120"; Name; AllowedCallers; /* 3 more */ }Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).
type BetaCodeExecutionTool20260521 struct { Type: "code_execution_20260521"; Name; AllowedCallers; /* 3 more */ }Code execution tool with REPL state persistence.
Code execution tool with REPL state persistence.
type BetaCodeExecutionToolResultBlock struct { Type: "code_execution_tool_result"; Content; ToolUseID }
Type CodeExecutionToolResult
ToolUseID string
type BetaCodeExecutionToolResultBlockContentUnion interface{…}
type BetaCodeExecutionToolResultBlockParam struct { Type: "code_execution_tool_result"; Content; ToolUseID; CacheControl }
ToolUseID string
CacheControl BetaCacheControlEphemeralParam OptionalCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
TTL BetaCacheControlEphemeralTTL OptionalThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m. See prompt caching pricing for details.
type BetaCodeExecutionToolResultBlockParamContentUnion interface{…}
type BetaCodeExecutionToolResultError struct { Type: "code_execution_tool_result_error"; ErrorCode }
Type CodeExecutionToolResultError
ErrorCode BetaCodeExecutionToolResultErrorCode
type BetaCodeExecutionToolResultErrorCode string
type BetaCodeExecutionToolResultErrorParam struct { Type: "code_execution_tool_result_error"; ErrorCode }
ErrorCode BetaCodeExecutionToolResultErrorCode
type BetaCompact20260112EditParam struct { Type: "compact_20260112"; Instructions; PauseAfterCompaction; Trigger }Automatically compact older context when reaching the configured trigger threshold.
Automatically compact older context when reaching the configured trigger threshold.
Additional instructions for summarization.
Whether to pause after compaction and return the compaction block to the user.
Trigger BetaInputTokensTriggerParam OptionalWhen to trigger compaction. Defaults to 150000 input tokens.
When to trigger compaction. Defaults to 150000 input tokens.
Value int64
type BetaCompactionBlock struct { Type: "compaction"; Content; EncryptedContent; /* 2 more */ }A compaction block returned when autocompact is triggered.
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.
Type Compaction
Summary of compacted content, or null if compaction failed
Opaque metadata from prior compaction, to be round-tripped verbatim
Signature over the summary, to be sent back with the block verbatim
ToolChanges []BetaCompactionBlockToolChangeUnion OptionalThe tool changes of the compacted range: the tool_addition and tool_removal blocks that take the request's tools to the tool set in effect at the end of the range, or [] when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged.
The tool changes of the compacted range: the tool_addition and tool_removal blocks that take the request's tools to the tool set in effect at the end of the range, or [] when the range changed no tool. Absent when the server did not compute them. Send the block back unchanged.
type BetaResponseToolAdditionBlock struct { Type: "tool_addition"; Tool }An entry of a compaction block's tool_changes: a tool the
compacted range made available, as a reference to a tools entry or
MCP toolset, or as the tool definition in effect at the end of the
range, by value. Send it back unchanged.
An entry of a compaction block's tool_changes: a tool the
compacted range made available, as a reference to a tools entry or
MCP toolset, or as the tool definition in effect at the end of the
range, by value. Send it back unchanged.
type BetaResponseToolRemovalBlock struct { Type: "tool_removal"; Tool }An entry of a compaction block's tool_changes: a tool of the
request's tools (or an MCP tool or toolset) that the compacted range
withdrew. Send it back unchanged.
An entry of a compaction block's tool_changes: a tool of the
request's tools (or an MCP tool or toolset) that the compacted range
withdrew. Send it back unchanged.
type BetaCompactionBlockParam struct { Type: "compaction"; CacheControl; Content; /* 3 more */ }A compaction block containing summary of previous context.
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 BetaCompactionConfigParam struct { Type: "summarize"; Instructions }Compact the whole conversation and return a signed compaction block,
alone, that a later request sends back first in messages, in place of
the messages it summarizes. There is no trigger and no pause flag: sending
the parameter compacts, and nothing is sampled after the block.
Compact the whole conversation and return a signed compaction block,
alone, that a later request sends back first in messages, in place of
the messages it summarizes. There is no trigger and no pause flag: sending
the parameter compacts, and nothing is sampled after the block.
The summarization prompt is the server's own unless instructions are
given, which then replace it for this request; a value that is empty or
only whitespace counts as absent.
Instructions string OptionalReplaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent.
Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent.
type BetaCompactionContentBlockDelta struct { Type: "compaction_delta"; Content; EncryptedContent }
Type CompactionDelta
Opaque metadata from prior compaction, to be round-tripped verbatim
type BetaCompactionIterationUsage struct { Type: "compaction"; CacheCreation; CacheCreationInputTokens; /* 3 more */ }Token usage for a compaction iteration.
Token usage for a compaction iteration.
Type CompactionUsage for a compaction iteration
Usage for a compaction iteration
CacheCreation BetaCacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 1 hour cache entry.
Ephemeral5mInputTokens int64The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the 5 minute cache entry.
CacheCreationInputTokens int64The number of input tokens used to create the cache entry.
The number of input tokens used to create the cache entry.
CacheReadInputTokens int64The number of input tokens read from the cache.
The number of input tokens read from the cache.
InputTokens int64The number of input tokens which were used.
The number of input tokens which were used.
OutputTokens int64The number of output tokens which were used.
The number of output tokens which were used.
type BetaComputerCursorPositionConfig struct { DeferLoading; Enabled }cursor_position's config overrides.
cursor_position's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
Get the current (x, y) pixel coordinate of the cursor.
type BetaComputerCursorPositionToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerDoubleClickConfig struct { DeferLoading; Enabled }double_click's config overrides.
double_click's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerDoubleClickInput struct { Coordinate; Text }Double-click the left mouse button at the specified (x, y) pixel coordinate, or
the current cursor position if coordinate is omitted.
Double-click the left mouse button at the specified (x, y) pixel coordinate, or
the current cursor position if coordinate is omitted.
Coordinate []int64 Optional(x, y): x pixels from the left edge, y pixels from the top edge.
(x, y): x pixels from the left edge, y pixels from the top edge.
Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").
type BetaComputerDoubleClickToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerHoldKeyConfig struct { DeferLoading; Enabled }hold_key's config overrides.
hold_key's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerHoldKeyInput struct { Duration; Text }Hold down a key or key-combination for a specified duration. Uses the same key
syntax as key.
Hold down a key or key-combination for a specified duration. Uses the same key
syntax as key.
Duration int64Duration to hold the key, in seconds.
Duration to hold the key, in seconds.
The key or key-combination to hold.
type BetaComputerHoldKeyToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerKeyConfig struct { DeferLoading; Enabled }key's config overrides.
key's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerKeyInput struct { Text; Repeat }Press a key or key-combination on the keyboard. Use "+" to combine modifiers with
a key (e.g. "ctrl+s", "alt+Tab", "ctrl+shift+Escape"). Key names are
case-insensitive; common names like "Return", "Tab", "Escape", "Up", "Down",
"Left", "Right", "Home", "End", "Page_Up", "Page_Down", "Delete", "BackSpace" are
supported.
Press a key or key-combination on the keyboard. Use "+" to combine modifiers with a key (e.g. "ctrl+s", "alt+Tab", "ctrl+shift+Escape"). Key names are case-insensitive; common names like "Return", "Tab", "Escape", "Up", "Down", "Left", "Right", "Home", "End", "Page_Up", "Page_Down", "Delete", "BackSpace" are supported.
The key or key-combination to press.
Repeat int64 OptionalNumber of times to repeat the key press. Default is 1.
Number of times to repeat the key press. Default is 1.
type BetaComputerKeyToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerLeftClickConfig struct { DeferLoading; Enabled }left_click's config overrides.
left_click's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerLeftClickDragConfig struct { DeferLoading; Enabled }left_click_drag's config overrides.
left_click_drag's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerLeftClickDragInput struct { Coordinate; StartCoordinate; Text }Click and drag the cursor from start_coordinate to coordinate.
Click and drag the cursor from start_coordinate to coordinate.
Coordinate []int64(x, y): x pixels from the left edge, y pixels from the top edge.
(x, y): x pixels from the left edge, y pixels from the top edge.
StartCoordinate []int64(x, y): x pixels from the left edge, y pixels from the top edge.
(x, y): x pixels from the left edge, y pixels from the top edge.
Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").
type BetaComputerLeftClickDragToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerLeftClickInput struct { Coordinate; Text }Click the left mouse button at the specified (x, y) pixel coordinate, or the
current cursor position if coordinate is omitted.
Click the left mouse button at the specified (x, y) pixel coordinate, or the
current cursor position if coordinate is omitted.
Coordinate []int64 Optional(x, y): x pixels from the left edge, y pixels from the top edge.
(x, y): x pixels from the left edge, y pixels from the top edge.
Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").
type BetaComputerLeftClickToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerLeftMouseDownConfig struct { DeferLoading; Enabled }left_mouse_down's config overrides.
left_mouse_down's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
Press and hold the left mouse button at the current cursor position.
type BetaComputerLeftMouseDownToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerLeftMouseUpConfig struct { DeferLoading; Enabled }left_mouse_up's config overrides.
left_mouse_up's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
Release the left mouse button.
type BetaComputerLeftMouseUpToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerMiddleClickConfig struct { DeferLoading; Enabled }middle_click's config overrides.
middle_click's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerMiddleClickInput struct { Coordinate; Text }Click the middle mouse button at the specified (x, y) pixel coordinate, or the
current cursor position if coordinate is omitted.
Click the middle mouse button at the specified (x, y) pixel coordinate, or the
current cursor position if coordinate is omitted.
Coordinate []int64 Optional(x, y): x pixels from the left edge, y pixels from the top edge.
(x, y): x pixels from the left edge, y pixels from the top edge.
Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").
type BetaComputerMiddleClickToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerMouseMoveConfig struct { DeferLoading; Enabled }mouse_move's config overrides.
mouse_move's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerMouseMoveInput struct { Coordinate }Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover
without clicking; otherwise use a click action directly.
Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly.
Coordinate []int64(x, y): x pixels from the left edge, y pixels from the top edge.
(x, y): x pixels from the left edge, y pixels from the top edge.
type BetaComputerMouseMoveToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerRightClickConfig struct { DeferLoading; Enabled }right_click's config overrides.
right_click's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerRightClickInput struct { Coordinate; Text }Click the right mouse button at the specified (x, y) pixel coordinate, or the
current cursor position if coordinate is omitted.
Click the right mouse button at the specified (x, y) pixel coordinate, or the
current cursor position if coordinate is omitted.
Coordinate []int64 Optional(x, y): x pixels from the left edge, y pixels from the top edge.
(x, y): x pixels from the left edge, y pixels from the top edge.
Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").
type BetaComputerRightClickToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerScreenshotConfig struct { DeferLoading; Enabled }screenshot's config overrides.
screenshot's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
Take a screenshot of the screen.
type BetaComputerScreenshotToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerScrollConfig struct { DeferLoading; Enabled }scroll's config overrides.
scroll's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerScrollDirection string
type BetaComputerScrollInput struct { ScrollAmount; ScrollDirection; Coordinate; Text }Scroll the screen at the specified (x, y) pixel coordinate, or the current cursor
position if coordinate is omitted. Do NOT use PageUp/PageDown to scroll.
Scroll the screen at the specified (x, y) pixel coordinate, or the current cursor
position if coordinate is omitted. Do NOT use PageUp/PageDown to scroll.
Number of 'clicks' of the scroll wheel.
ScrollDirection BetaComputerScrollDirection
Coordinate []int64 Optional(x, y): x pixels from the left edge, y pixels from the top edge.
(x, y): x pixels from the left edge, y pixels from the top edge.
Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").
type BetaComputerScrollToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerToolUseBlockUnion interface{…}
type BetaComputerToolset20260801 struct { Type: "computer_toolset_20260801"; CacheControl; 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.
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.
CacheControl BetaCacheControlEphemeral OptionalCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
TTL BetaCacheControlEphemeralTTL OptionalThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m. See prompt caching pricing for details.
Configs BetaComputerToolsetConfigs OptionalSparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
type BetaComputerToolsetConfigs struct { Type; CursorPosition; DoubleClick; /* 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.
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.
type BetaComputerTripleClickConfig struct { DeferLoading; Enabled }triple_click's config overrides.
triple_click's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerTripleClickInput struct { Coordinate; Text }Triple-click the left mouse button at the specified (x, y) pixel coordinate, or
the current cursor position if coordinate is omitted.
Triple-click the left mouse button at the specified (x, y) pixel coordinate, or
the current cursor position if coordinate is omitted.
Coordinate []int64 Optional(x, y): x pixels from the left edge, y pixels from the top edge.
(x, y): x pixels from the left edge, y pixels from the top edge.
Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift").
type BetaComputerTripleClickToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerTypeConfig struct { DeferLoading; Enabled }type's config overrides.
type's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerTypeInput struct { Text }Type a string of text on the keyboard.
Type a string of text on the keyboard.
The text to type.
type BetaComputerTypeToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerWaitConfig struct { DeferLoading; Enabled }wait's config overrides.
wait's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerWaitInput struct { Duration }Wait for a specified duration.
Wait for a specified duration.
Duration int64Duration to wait, in seconds.
Duration to wait, in seconds.
type BetaComputerWaitToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaComputerZoomConfig struct { DeferLoading; Enabled }zoom's config overrides.
zoom's config overrides.
Defer loading for this member. Must resolve to the same value on every enabled member of the toolset.
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.
type BetaComputerZoomInput struct { Region }Take a screenshot of a rectangular region. Region coordinates are in the
full-screenshot space (not physical display pixels). The crop is scaled up to
fill the image budget so fine details become legible.
Take a screenshot of a rectangular region. Region coordinates are in the full-screenshot space (not physical display pixels). The crop is scaled up to fill the image budget so fine details become legible.
Region []int64(x0, y0, x1, y1): The region to capture.
(x0, y0, x1, y1): The region to capture.
type BetaComputerZoomToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaContainer struct { ID; ExpiresAt; Skills }Information about the container used in the request (for the code execution tool)
Information about the container used in the request (for the code execution tool)
Identifier for the container used in this request
ExpiresAt TimeThe time at which the container will expire.
The time at which the container will expire.
Skills []BetaContainerSkillSkills loaded in the container
Skills loaded in the container
Type BetaContainerSkillTypeType of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
SkillID stringSkill ID
Skill ID
Version stringThe resolved version: a skill version ID for custom skills.
The resolved version: a skill version ID for custom skills.
type BetaContainerParams struct { ID; Skills }Container parameters with skills to be loaded.
Container parameters with skills to be loaded.
Container id
Skills []BetaSkillParams OptionalList of skills to load in the container
List of skills to load in the container
Type BetaSkillParamsTypeType of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
SkillID stringSkill ID
Skill ID
Version string OptionalSkill version or 'latest' for most recent version
Skill version or 'latest' for most recent version
type BetaContainerSkill struct { Type; SkillID; Version }A skill that was loaded in a container (response model).
A skill that was loaded in a container (response model).
Type BetaContainerSkillTypeType of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
SkillID stringSkill ID
Skill ID
Version stringThe resolved version: a skill version ID for custom skills.
The resolved version: a skill version ID for custom skills.
type BetaContainerUploadBlock struct { Type: "container_upload"; FileID }Response model for a file uploaded to the container.
Response model for a file uploaded to the container.
Type ContainerUpload
type BetaContainerUploadBlockParam struct { Type: "container_upload"; FileID; CacheControl }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.
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.
CacheControl BetaCacheControlEphemeralParam OptionalCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
TTL BetaCacheControlEphemeralTTL OptionalThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m. See prompt caching pricing for details.
type BetaContentBlockUnion interface{…}
type BetaContentBlockParamUnion interface{…}
type BetaContentBlockSourceParam struct { Type: "content"; Content }
Content BetaContentBlockSourceContentUnionParam
type BetaTextBlockParam struct { Type: "text"; Text; CacheControl; Citations }
type BetaImageBlockParam struct { Type: "image"; Source; CacheControl; Transformations }
type BetaContentBlockSourceContentUnionParam interface{…}
type BetaTextBlockParam struct { Type: "text"; Text; CacheControl; Citations }
type BetaImageBlockParam struct { Type: "image"; Source; CacheControl; Transformations }
type BetaContextManagementConfigParam struct { Edits }
type BetaContextManagementResponse struct { AppliedEdits }
AppliedEdits []BetaContextManagementResponseAppliedEditUnionList of context management edits that were applied.
List of context management edits that were applied.
type BetaClearToolUses20250919EditResponse struct { Type: "clear_tool_uses_20250919"; ClearedInputTokens; ClearedToolUses }
Type ClearToolUses20250919The type of context management edit applied.
The type of context management edit applied.
ClearedInputTokens int64Number of input tokens cleared by this edit.
Number of input tokens cleared by this edit.
ClearedToolUses int64Number of tool uses that were cleared.
Number of tool uses that were cleared.
type BetaClearThinking20251015EditResponse struct { Type: "clear_thinking_20251015"; ClearedInputTokens; ClearedThinkingTurns }
Type ClearThinking20251015The type of context management edit applied.
The type of context management edit applied.
ClearedInputTokens int64Number of input tokens cleared by this edit.
Number of input tokens cleared by this edit.
ClearedThinkingTurns int64Number of thinking turns that were cleared.
Number of thinking turns that were cleared.
type BetaCountTokensContextManagementResponse struct { OriginalInputTokens }
The original token count before context management was applied
type BetaDiagnostics struct { CacheMissReason }Request-level diagnostics: why the prompt cache could not fully reuse
the prefix of the request named by diagnostics.previous_message_id.
Request-level diagnostics: why the prompt cache could not fully reuse
the prefix of the request named by diagnostics.previous_message_id.
CacheMissReason BetaCacheMissReasonUnionExplains why the prompt cache could not fully reuse the prefix from the request identified by diagnostics.previous_message_id. null means diagnosis is still pending — the response was serialized before the background comparison completed.
Explains why the prompt cache could not fully reuse the prefix from the request identified by diagnostics.previous_message_id. null means diagnosis is still pending — the response was serialized before the background comparison completed.
type BetaDiagnosticsParam struct { PreviousMessageID }Request-level diagnostics. Currently carries the previous response
id for prompt-cache divergence reporting.
Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting.
PreviousMessageID string OptionalThe 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.
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.
type BetaDirectCaller struct { Type: "direct" }Tool invocation directly from the model.
Tool invocation directly from the model.
type BetaDocumentBlock struct { Type: "document"; Citations; Source; Title }
type BetaEncryptedCodeExecutionResultBlock struct { Type: "encrypted_code_execution_result"; Content; EncryptedStdout; /* 2 more */ }Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
Type EncryptedCodeExecutionResult
Content []BetaCodeExecutionOutputBlock
Type CodeExecutionOutput
type BetaEncryptedCodeExecutionResultBlockParam struct { Type: "encrypted_code_execution_result"; Content; EncryptedStdout; /* 2 more */ }Code execution result with encrypted stdout for PFC + web_search results.
Code execution result with encrypted stdout for PFC + web_search results.
Content []BetaCodeExecutionOutputBlockParam
type BetaFallbackBlock struct { Type: "fallback"; From; To; Trigger }Marks the point in content where one model's output gives way to the next.
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.
type BetaFallbackBlockParam struct { Type: "fallback"; From; To; Trigger }A fallback block echoed back from a prior response.
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.
Identifies one hop of a fallback transition.
Identifies one hop of a fallback transition.
Identifies one hop of a fallback transition.
The response block's trigger, echoed verbatim. Accepted and ignored by the server; any object or null is allowed.
type BetaFallbackCreditNotApplied struct { Type: "not_applied"; Reason; RemoveToRedeem }No reprice was applied; reason says why.
No reprice was applied; reason says why.
type BetaFallbackCreditRedeemed struct { Type: "redeemed" }The reprice was applied: the retry is billed as if the conversation
had been on the retry model all along.
The reprice was applied: the retry is billed as if the conversation had been on the retry model all along.
Type Redeemed
type BetaFallbackCreditTokenParam struct { Token; Mode }Object form of fallback_credit_token: the token plus a redemption
mode.
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 stringThe opaque fallback_credit_token from a prior refusal's stop_details — the same string the bare-string form carries.
The opaque fallback_credit_token from a prior refusal's stop_details — the same string the bare-string form carries.
Mode BetaFallbackCreditTokenParamMode OptionalHow 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.
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.
type BetaFallbackCreditUsage struct { Status }Outcome of the fallback_credit_token presented on this request.
Outcome of the fallback_credit_token presented on this request.
Status BetaFallbackCreditUsageStatusUnionWhether the fallback-credit reprice was applied to this response's billing.
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.
type BetaFallbackCreditRedeemed struct { Type: "redeemed" }The reprice was applied: the retry is billed as if the conversation
had been on the retry model all along.
The reprice was applied: the retry is billed as if the conversation had been on the retry model all along.
Type Redeemed
type BetaFallbackCreditNotApplied struct { Type: "not_applied"; Reason; RemoveToRedeem }No reprice was applied; reason says why.
No reprice was applied; reason says why.
type BetaFallbackMessageIterationUsage struct { Type: "fallback_message"; CacheCreation; CacheCreationInputTokens; /* 4 more */ }Token usage for the fallback-model attempt of a server-side fallback request.
Token usage for the fallback-model attempt of a server-side fallback request.
The terminal entry of a fallback-served turn: when a fallback hop's
output is the returned message, the entry for the iteration that
completed it carries this type in place of message. A declined hop
and the serving hop's earlier tool-loop iterations produce message
entries. Whether a fallback model served the response is signalled by
the presence of this entry in usage.iterations.
Type FallbackMessageUsage for the fallback-model attempt that served the response
Usage for the fallback-model attempt that served the response
CacheCreation BetaCacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 1 hour cache entry.
Ephemeral5mInputTokens int64The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the 5 minute cache entry.
CacheCreationInputTokens int64The number of input tokens used to create the cache entry.
The number of input tokens used to create the cache entry.
CacheReadInputTokens int64The number of input tokens read from the cache.
The number of input tokens read from the cache.
InputTokens int64The number of input tokens which were used.
The number of input tokens which were used.
OutputTokens int64The number of output tokens which were used.
The number of output tokens which were used.
type BetaFallbackParam struct { Model; MaxTokens; OutputConfig; /* 2 more */ }One entry in the fallbacks chain on a /v1/messages request.
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.
type BetaFallbackRefusalTrigger struct { Type: "refusal"; Category }The from model declined for policy reasons.
The from model declined for policy reasons.
Type Refusal
Category BetaFallbackRefusalTriggerCategoryThe policy category that triggered the from model's refusal at this hop. null when the refusal doesn't map to a named category. Same vocabulary as stop_details.category.
The policy category that triggered the from model's refusal at this hop. null when the refusal doesn't map to a named category. Same vocabulary as stop_details.category.
The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category.
The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category.
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.
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.
The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category.
type BetaFallbacksParamUnion interface{…}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. Some models don't support fallbacks; on those models, a list of fallback models returns a 400 error. See Server-side fallback. The string "default" requests the requested model's server-defined default fallback configuration. On a model that doesn't support fallbacks, the request runs on the requested model alone, so a declined request stays declined.
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. Some models don't support fallbacks; on those models, a list of fallback models returns a 400 error. See Server-side fallback. The string "default" requests the requested model's server-defined default fallback configuration. On a model that doesn't support fallbacks, the request runs on the requested model alone, so a declined request stays declined.
type BetaFileDocumentSourceParam struct { Type: "file"; FileID }
type BetaFileImageSourceParam struct { Type: "file"; FileID }
type BetaImageBlockParam struct { Type: "image"; Source; CacheControl; Transformations }
type BetaImageTransformationsParam struct { OversizedImage }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.
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.
OversizedImage BetaImageTransformationsParamOversizedImage OptionalWhat 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.
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.
type BetaInputJSONDelta struct { Type: "input_json_delta"; PartialJSON }
Type InputJSONDelta
type BetaInputTokensClearAtLeastParam struct { Type: "input_tokens"; Value }
Value int64
type BetaInputTokensTriggerParam struct { Type: "input_tokens"; Value }
Value int64
type BetaInputTransformationUnion interface{…}One entry of input_transformations: either a change the API made to the
request's input before showing it to the model, or a block that failed a
binding check and was still shown to the model unchanged. The type field
says which.
One entry of input_transformations: either a change the API made to the
request's input before showing it to the model, or a block that failed a
binding check and was still shown to the model unchanged. The type field
says which.
type BetaIterationsUsage []BetaIterationsUsageItemUnionPer-iteration token usage breakdown.
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:
- Calculate the context window size from the last
messageentry - 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.
type BetaJSONOutputFormatParam struct { Type: "json_schema"; Schema }
The JSON schema of the format
type BetaMCPTool struct { InputSchema; Name; Description }A tool as an MCP server lists it: its name on that server, its
description, and its input schema.
A tool as an MCP server lists it: its name on that server, its description, and its input schema.
type BetaMCPToolConfig struct { DeferLoading; Enabled }Configuration for a specific tool in an MCP toolset.
Configuration for a specific tool in an MCP toolset.
type BetaMCPToolDefaultConfig struct { DeferLoading; Enabled }Default configuration for tools in an MCP toolset.
Default configuration for tools in an MCP toolset.
type BetaMCPToolListingBlock struct { Type: "mcp_tool_listing"; MCPServerName; Tools }The tool listing the server fetched from an MCP server while producing
this response. Send the assistant message back unchanged, this block
included, so later requests use this listing instead of asking the MCP
server again.
The tool listing the server fetched from an MCP server while producing this response. Send the assistant message back unchanged, this block included, so later requests use this listing instead of asking the MCP server again.
Type MCPToolListing
Tools []BetaMCPTool
type BetaMCPToolListingBlockParam struct { Type: "mcp_tool_listing"; MCPServerName; Tools }The tool listing an MCP server returned while an earlier response was
produced, as that response carried it. Send the assistant message back
unchanged, this block included, and the server uses this listing for the
matching mcp_toolset instead of asking the MCP server again.
The tool listing an MCP server returned while an earlier response was
produced, as that response carried it. Send the assistant message back
unchanged, this block included, and the server uses this listing for the
matching mcp_toolset instead of asking the MCP server again.
MCPServerName stringThe name of the MCP server this listing came from, as mcp_servers declares it.
The name of the MCP server this listing came from, as mcp_servers declares it.
Tools []BetaMCPToolParamThe server's tools, exactly as the response listed them.
The server's tools, exactly as the response listed them.
The tool's input schema as the MCP server lists it, verbatim.
Name stringThe tool's name as the MCP server lists it (not prefixed with the server name).
The tool's name as the MCP server lists it (not prefixed with the server name).
The tool's description as the MCP server lists it.
type BetaMCPToolParamResp struct { InputSchema; Name; Description }A tool as an MCP server lists it: its name on that server, its
description, and its input schema.
A tool as an MCP server lists it: its name on that server, its description, and its input schema.
The tool's input schema as the MCP server lists it, verbatim.
Name stringThe tool's name as the MCP server lists it (not prefixed with the server name).
The tool's name as the MCP server lists it (not prefixed with the server name).
The tool's description as the MCP server lists it.
type BetaMCPToolResultBlock struct { Type: "mcp_tool_result"; Content; IsError; ToolUseID }
type BetaMCPToolUseBlock struct { Type: "mcp_tool_use"; ID; Input; /* 2 more */ }
Type MCPToolUse
ID string
The name of the MCP tool
The name of the MCP server
type BetaMCPToolUseBlockParam struct { Type: "mcp_tool_use"; ID; Input; /* 3 more */ }
ID string
The name of the MCP server
CacheControl BetaCacheControlEphemeralParam OptionalCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
TTL BetaCacheControlEphemeralTTL OptionalThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m. See prompt caching pricing for details.
type BetaMCPToolset struct { Type: "mcp_toolset"; MCPServerName; CacheControl; /* 3 more */ }Configuration for a group of tools from an MCP server.
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.
type BetaMemoryTool20250818 struct { Type: "memory_20250818"; Name; AllowedCallers; /* 4 more */ }
type BetaMemoryTool20250818CommandUnion interface{…}
type BetaMemoryTool20250818CreateCommand struct { Command; FileText; Path }
Command CreateCommand type identifier
Command type identifier
Content to write to the file
Path where the file should be created
type BetaMemoryTool20250818DeleteCommand struct { Command; Path }
Command DeleteCommand type identifier
Command type identifier
Path to the file or directory to delete
type BetaMemoryTool20250818InsertCommand struct { Command; InsertLine; InsertText; Path }
Command InsertCommand type identifier
Command type identifier
InsertLine int64Line number where text should be inserted
Line number where text should be inserted
Text to insert at the specified line
Path to the file where text should be inserted
type BetaMemoryTool20250818RenameCommand struct { Command; NewPath; OldPath }
Command RenameCommand type identifier
Command type identifier
New path for the file or directory
Current path of the file or directory
type BetaMemoryTool20250818StrReplaceCommand struct { Command; NewStr; OldStr; Path }
Command StrReplaceCommand type identifier
Command type identifier
Text to replace with
Text to search for and replace
Path to the file where text should be replaced
type BetaMemoryTool20250818ViewCommand struct { Command; Path; ViewRange }
Command ViewCommand type identifier
Command type identifier
Path to directory or file to view
ViewRange []int64 OptionalOptional line range for viewing specific lines
Optional line range for viewing specific lines
type BetaMessage struct { Type: "message"; ID; Container; /* 10 more */ }
type BetaMessageDeltaUsage struct { CacheCreationInputTokens; CacheReadInputTokens; FallbackCredit; /* 5 more */ }
type BetaMessageIterationUsage struct { Type: "message"; CacheCreation; CacheCreationInputTokens; /* 4 more */ }Token usage for a sampling iteration.
Token usage for a sampling iteration.
Type MessageUsage for a sampling iteration
Usage for a sampling iteration
CacheCreation BetaCacheCreationBreakdown of cached tokens by TTL
Breakdown of cached tokens by TTL
Ephemeral1hInputTokens int64The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 1 hour cache entry.
Ephemeral5mInputTokens int64The number of input tokens used to create the 5 minute cache entry.
The number of input tokens used to create the 5 minute cache entry.
CacheCreationInputTokens int64The number of input tokens used to create the cache entry.
The number of input tokens used to create the cache entry.
CacheReadInputTokens int64The number of input tokens read from the cache.
The number of input tokens read from the cache.
InputTokens int64The number of input tokens which were used.
The number of input tokens which were used.
OutputTokens int64The number of output tokens which were used.
The number of output tokens which were used.
type BetaMessageParam struct { Content; Role; ClearAt; OutputConfig }
type BetaMessageTokensCount struct { ContextManagement; InputTokens }
ContextManagement BetaCountTokensContextManagementResponseInformation about context management applied to the message.
Information about context management applied to the message.
The original token count before context management was applied
The total number of tokens across the provided list of messages, system prompt, and tools.
type BetaMetadataParam struct { UserID }
UserID string OptionalAn external identifier for the user who is associated with the request.
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.
type BetaOutputConfigParam struct { Effort; Format; TaskBudget }
type BetaOutputTokensDetails struct { ThinkingTokens }
ThinkingTokens int64Number of output tokens the model generated as internal reasoning, including
the thinking-block delimiter tokens.
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.
type BetaPlainTextSource struct { Type: "text"; Data; MediaType }
type BetaRawContentBlockDeltaUnion interface{…}
type BetaRawContentBlockDeltaEvent struct { Type: "content_block_delta"; Delta; Index }
Type ContentBlockDelta
type BetaRawContentBlockStartEvent struct { Type: "content_block_start"; ContentBlock; Index }
type BetaRawContentBlockStopEvent struct { Type: "content_block_stop"; Index }
Type ContentBlockStop
type BetaRawMessageDeltaEvent struct { Type: "message_delta"; ContextManagement; Delta; /* 2 more */ }
type BetaRawMessageStartEvent struct { Type: "message_start"; Message }
Type MessageStart
Message BetaMessage
type BetaRawMessageStopEvent struct { Type: "message_stop" }
Type MessageStop
type BetaRawMessageStreamEventUnion interface{…}
type BetaRedactedThinkingBlock struct { Type: "redacted_thinking"; Data }
Type RedactedThinking
Data stringThe 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.
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 BetaRedactedThinkingBlockParam struct { Type: "redacted_thinking"; Data }
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 BetaRefusalStopDetails struct { Type: "refusal"; Category; Explanation; /* 3 more */ }Structured information about a refusal.
Structured information about a refusal.
type BetaRequestDocumentBlockParam struct { Type: "document"; Source; CacheControl; /* 3 more */ }
type BetaRequestMCPServerToolConfigurationParam struct { AllowedTools; Enabled }
type BetaRequestMCPServerURLDefinitionParam struct { Type: "url"; Name; URL; /* 2 more */ }
ToolConfiguration BetaRequestMCPServerToolConfigurationParam Optional
type BetaRequestMCPToolResultBlockParam struct { Type: "mcp_tool_result"; ToolUseID; CacheControl; /* 2 more */ }
type BetaRequestToolAdditionBlockParam struct { Type: "tool_addition"; Tool; CacheControl }Mid-conversation directive to make a tool available.
Mid-conversation directive to make a tool available.
tool is a reference to a tool (or MCP toolset) declared in the
request's tools. Under the inline-tools-2026-09-15 beta it may
instead be a reference to a tool defined earlier in messages, or a
tool_definition object that carries an inline tool definition in
definition (the same object a tools entry holds). An mcp_toolset
definition also requires the mcp-client-2026-09-15 beta. The tool is
offered to the model from this point in the conversation onward.
type BetaRequestToolRemovalBlockParam struct { Type: "tool_removal"; Tool; CacheControl }Mid-conversation directive to withdraw a tool.
Mid-conversation directive to withdraw a tool.
tool references a tool (or MCP toolset) by name: one declared in the
request's tools or defined earlier in messages. It is no longer
offered to the model from this point in the conversation onward.
type BetaResponseTool struct { Type: "custom"; InputSchema; Name; /* 6 more */ }A custom tool definition, as sent.
A custom tool definition, as sent.
type BetaResponseToolAdditionBlock struct { Type: "tool_addition"; Tool }An entry of a compaction block's tool_changes: a tool the
compacted range made available, as a reference to a tools entry or
MCP toolset, or as the tool definition in effect at the end of the
range, by value. Send it back unchanged.
An entry of a compaction block's tool_changes: a tool the
compacted range made available, as a reference to a tools entry or
MCP toolset, or as the tool definition in effect at the end of the
range, by value. Send it back unchanged.
type BetaResponseToolChangeMCPToolReference struct { Type: "mcp_tool_reference"; Name; ServerName }Reference to a single MCP tool, by its server and its name on that
server, as a compaction block's tool_changes entry reports it.
Send it back unchanged with the block.
Reference to a single MCP tool, by its server and its name on that
server, as a compaction block's tool_changes entry reports it.
Send it back unchanged with the block.
Type MCPToolReference
type BetaResponseToolChangeMCPToolsetReference struct { Type: "mcp_toolset_reference"; ServerName }Reference to every tool in the named MCP server's toolset, as a
compaction block's tool_changes entry reports it. Send it back
unchanged with the block.
Reference to every tool in the named MCP server's toolset, as a
compaction block's tool_changes entry reports it. Send it back
unchanged with the block.
Type MCPToolsetReference
type BetaResponseToolChangeToolReference struct { Type: "tool_reference"; Name }Reference to a single tool, by the name the model uses to call it, as
a compaction block's tool_changes entry reports it: a tool
declared in tools or defined by an earlier tool_addition block.
Send it back unchanged with the block.
Reference to a single tool, by the name the model uses to call it, as
a compaction block's tool_changes entry reports it: a tool
declared in tools or defined by an earlier tool_addition block.
Send it back unchanged with the block.
Type ToolReference
type BetaResponseToolInputSchema struct { Type: "object"; Properties; Required }JSON schema for this tool's input.
JSON schema for this tool's input.
This defines the shape of the input that your tool accepts and that the model will produce.
type BetaResponseToolRemovalBlock struct { Type: "tool_removal"; Tool }An entry of a compaction block's tool_changes: a tool of the
request's tools (or an MCP tool or toolset) that the compacted range
withdrew. Send it back unchanged.
An entry of a compaction block's tool_changes: a tool of the
request's tools (or an MCP tool or toolset) that the compacted range
withdrew. Send it back unchanged.
type BetaResponseToolUnion interface{…}
type BetaSearchResultBlockParam struct { Type: "search_result"; Content; Source; /* 3 more */ }
type BetaServerToolCaller struct { Type: "code_execution_20250825"; ToolID }Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ToolID string
type BetaServerToolCaller20260120 struct { Type: "code_execution_20260120"; ToolID }
ToolID string
type BetaServerToolUsage struct { WebFetchRequests; WebSearchRequests }
WebFetchRequests int64The number of web fetch tool requests.
The number of web fetch tool requests.
WebSearchRequests int64The number of web search tool requests.
The number of web search tool requests.
type BetaServerToolUseBlock struct { Type: "server_tool_use"; ID; Input; /* 2 more */ }
type BetaServerToolUseBlockParam struct { Type: "server_tool_use"; ID; Input; /* 3 more */ }
type BetaSignatureDelta struct { Type: "signature_delta"; Signature }
Type SignatureDelta
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 BetaSkillParams struct { Type; SkillID; Version }Specification for a skill to be loaded in a container (request model).
Specification for a skill to be loaded in a container (request model).
Type BetaSkillParamsTypeType of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
SkillID stringSkill ID
Skill ID
Version string OptionalSkill version or 'latest' for most recent version
Skill version or 'latest' for most recent version
type BetaStopReason string
type BetaSummarizeCompaction struct { Type: "summarize"; Instructions }Compact the whole conversation and return a signed compaction block,
alone, that a later request sends back first in messages, in place of
the messages it summarizes. There is no trigger and no pause flag: sending
the parameter compacts, and nothing is sampled after the block.
Compact the whole conversation and return a signed compaction block,
alone, that a later request sends back first in messages, in place of
the messages it summarizes. There is no trigger and no pause flag: sending
the parameter compacts, and nothing is sampled after the block.
The summarization prompt is the server's own unless instructions are
given, which then replace it for this request; a value that is empty or
only whitespace counts as absent.
Instructions string OptionalReplaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent.
Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent.
type BetaSystemMessageOutputConfigParam struct { Effort }Per-message output configuration on a role:"system" input message.
Per-message output configuration on a role:"system" input message.
Fields here apply per-turn; format remains top-level only. An
empty {} is accepted on a message that carries content; a message
with neither content nor output_config fields is rejected.
Effort BetaSystemMessageOutputConfigEffort OptionalHow much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
How much effort the model should put into its response. Higher effort levels may result in more thorough analysis but take longer.
Valid values are low, medium, high, xhigh, or max.
type BetaTextBlock struct { Type: "text"; Citations; Text }
type BetaTextBlockParam struct { Type: "text"; Text; CacheControl; Citations }
type BetaTextCitationUnion interface{…}
type BetaTextCitationParamUnion interface{…}
type BetaTextDelta struct { Type: "text_delta"; Text }
Type TextDelta
type BetaTextEditorCodeExecutionCreateResultBlock struct { Type: "text_editor_code_execution_create_result"; IsFileUpdate }
Type TextEditorCodeExecutionCreateResult
type BetaTextEditorCodeExecutionCreateResultBlockParam struct { Type: "text_editor_code_execution_create_result"; IsFileUpdate }
type BetaTextEditorCodeExecutionStrReplaceResultBlock struct { Type: "text_editor_code_execution_str_replace_result"; Lines; NewLines; /* 3 more */ }
Type TextEditorCodeExecutionStrReplaceResult
type BetaTextEditorCodeExecutionStrReplaceResultBlockParam struct { Type: "text_editor_code_execution_str_replace_result"; Lines; NewLines; /* 3 more */ }
type BetaTextEditorCodeExecutionToolResultBlock struct { Type: "text_editor_code_execution_tool_result"; Content; ToolUseID }
type BetaTextEditorCodeExecutionToolResultBlockParam struct { Type: "text_editor_code_execution_tool_result"; Content; ToolUseID; CacheControl }
type BetaTextEditorCodeExecutionToolResultError struct { Type: "text_editor_code_execution_tool_result_error"; ErrorCode; ErrorMessage }
Type TextEditorCodeExecutionToolResultError
ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode
type BetaTextEditorCodeExecutionToolResultErrorParam struct { Type: "text_editor_code_execution_tool_result_error"; ErrorCode; ErrorMessage }
ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode
type BetaTextEditorCodeExecutionViewResultBlock struct { Type: "text_editor_code_execution_view_result"; Content; FileType; /* 3 more */ }
Type TextEditorCodeExecutionViewResult
FileType BetaTextEditorCodeExecutionViewResultBlockFileType
type BetaTextEditorCodeExecutionViewResultBlockParam struct { Type: "text_editor_code_execution_view_result"; Content; FileType; /* 3 more */ }
FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType
type BetaThinkingBlock struct { Type: "thinking"; Signature; Thinking }
Type Thinking
Signature stringA value used to verify that this thinking block was generated by Claude when it is passed back to the API.
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.
The text of Claude's thinking process for this block.
type BetaThinkingBlockBindingParam struct { PrefixMismatchBehavior }Controls for block binding: what happens when a thinking block this
request sends back fails the conversation check. Every field is optional;
an empty object means every default.
Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. Every field is optional; an empty object means every default.
PrefixMismatchBehavior BetaThinkingPrefixMismatchBehavior Optional"error" (default) | "drop_block". What happens when a thinking block in messages fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in input_transformations.
"error" (default) | "drop_block". What happens when a thinking block in messages fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in input_transformations.
type BetaThinkingBlockParam struct { Type: "thinking"; Signature; Thinking }
Signature stringThe 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.
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.
The thinking text of this block as returned by the API.
type BetaThinkingConfigAdaptiveParam struct { Type: "adaptive"; BlockBinding; Display }
BlockBinding BetaThinkingBlockBindingParam OptionalControls for block binding: what happens when a thinking block this request sends back fails the conversation check. null, absent or an empty object means every default.
Controls for block binding: what happens when a thinking block this request sends back fails the conversation check. null, absent or an empty object means every default.
PrefixMismatchBehavior BetaThinkingPrefixMismatchBehavior Optional"error" (default) | "drop_block". What happens when a thinking block in messages fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in input_transformations.
"error" (default) | "drop_block". What happens when a thinking block in messages fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in input_transformations.
Display BetaThinkingConfigAdaptiveDisplay OptionalControls 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. The default depends on the model; see Controlling thinking display.
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. The default depends on the model; see Controlling thinking display.
type BetaThinkingConfigBetweenToolsParam struct { Type: "between_tools" }
type BetaThinkingConfigDisabledParam struct { Type: "disabled" }
type BetaThinkingConfigEnabledParam struct { Type: "enabled"; BudgetTokens; BlockBinding; Display }
type BetaThinkingConfigParamUnion interface{…}Configuration for Claude's thinking.
Configuration for Claude's thinking.
With {"type": "adaptive"}, Claude decides when and how much to think. With {"type": "enabled"} (manual extended thinking), you set a budget_tokens of at least 1,024. Thinking tokens count toward your max_tokens limit.
Which type values are accepted, and what happens when you omit thinking, depend on the model. See thinking for each model's behavior.
type BetaThinkingDelta struct { Type: "thinking_delta"; EstimatedTokens; Thinking }
Type ThinkingDelta
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.
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 BetaThinkingDroppedInputTransformation struct { Type: "thinking_dropped"; Path; Reason }
Type ThinkingDroppedAlways thinking_dropped for this entry type.
Always thinking_dropped for this entry type.
Where the removed block was in your request, as messages.{i}.content.{j}:
i indexes the messages array you sent and j that message's content
array — the same form error messages use.
Reason BetaThinkingDroppedInputTransformationReasonWhich binding check removed the block: model_binding_mismatch — it was
created by a model whose reasoning the requested model may not read;
prefix_binding_mismatch — the conversation before it differs from the
conversation it was created in (the rest of that turn's consecutive thinking
blocks are removed with it, each with this reason);
organization_binding_mismatch — it was created under a different
organization (an Anthropic organization, AWS account or Google Cloud project)
and this organization is not one of its additional organizations;
end_user_binding_mismatch — it was created for a different end user, or
was removed by the consumer-organization binding. A block that would fail
several checks reports one reason, in this order of precedence:
organization_binding_mismatch, end_user_binding_mismatch,
model_binding_mismatch, prefix_binding_mismatch.
Which binding check removed the block: model_binding_mismatch — it was
created by a model whose reasoning the requested model may not read;
prefix_binding_mismatch — the conversation before it differs from the
conversation it was created in (the rest of that turn's consecutive thinking
blocks are removed with it, each with this reason);
organization_binding_mismatch — it was created under a different
organization (an Anthropic organization, AWS account or Google Cloud project)
and this organization is not one of its additional organizations;
end_user_binding_mismatch — it was created for a different end user, or
was removed by the consumer-organization binding. A block that would fail
several checks reports one reason, in this order of precedence:
organization_binding_mismatch, end_user_binding_mismatch,
model_binding_mismatch, prefix_binding_mismatch.
type BetaThinkingMismatchAllowedInputTransformation struct { Type: "thinking_mismatch_allowed"; Path; Reason }
Type ThinkingMismatchAllowedAlways thinking_mismatch_allowed for this entry type.
Always thinking_mismatch_allowed for this entry type.
Where the block is in your request, as messages.{i}.content.{j}:
i indexes the messages array you sent and j that message's content
array — the same form error messages use.
Reason BetaThinkingMismatchAllowedInputTransformationReasonWhich binding check the block failed; the block was shown to the model all
the same. Always prefix_binding_mismatch today — the conversation before
the block differs from the conversation it was created in, or the block
carries no record of one on a model that requires it. Were the check
enforced for this request, the block would have been removed or the request
rejected (thinking.block_binding.prefix_mismatch_behavior). A removal also
takes the rest of that turn's consecutive thinking blocks, whereas here each
block is checked on its own, so thinking_mismatch_allowed entries are a
lower bound on what enforcement would remove.
Which binding check the block failed; the block was shown to the model all
the same. Always prefix_binding_mismatch today — the conversation before
the block differs from the conversation it was created in, or the block
carries no record of one on a model that requires it. Were the check
enforced for this request, the block would have been removed or the request
rejected (thinking.block_binding.prefix_mismatch_behavior). A removal also
takes the rest of that turn's consecutive thinking blocks, whereas here each
block is checked on its own, so thinking_mismatch_allowed entries are a
lower bound on what enforcement would remove.
type BetaThinkingPrefixMismatchBehavior stringWhat happens when a thinking block in messages fails the conversation
check: it was created in a different conversation, or the messages before
it have changed since. "error" (the default) fails the request with a
400 error. "drop_block" removes the failing blocks and the request
proceeds; the model no longer sees the dropped reasoning.
What happens when a thinking block in messages fails the conversation
check: it was created in a different conversation, or the messages before
it have changed since. "error" (the default) fails the request with a
400 error. "drop_block" removes the failing blocks and the request
proceeds; the model no longer sees the dropped reasoning.
type BetaThinkingTurnsParam struct { Type: "thinking_turns"; Value }
Value int64
type BetaTokenTaskBudgetParam struct { Type: "tokens"; Total; Remaining }User-configurable total token budget across contexts.
User-configurable total token budget across contexts.
The budget type. Currently only 'tokens' is supported.
Total int64Total token budget across all contexts in the session.
Total token budget across all contexts in the session.
Remaining int64 OptionalRemaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided.
Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided.
type BetaToolParam struct { Type: "custom"; InputSchema; Name; /* 7 more */ }
type BetaToolBash20241022 struct { Type: "bash_20241022"; Name; AllowedCallers; /* 4 more */ }
type BetaToolBash20250124 struct { Type: "bash_20250124"; Name; AllowedCallers; /* 4 more */ }
type BetaToolChangeMCPToolReferenceParam struct { Type: "mcp_tool_reference"; Name; ServerName }Reference to a single MCP tool by its server and remote name; the
same server_name/name pair mcp_tool_use carries.
Reference to a single MCP tool by its server and remote name; the
same server_name/name pair mcp_tool_use carries.
type BetaToolChangeMCPToolsetReferenceParam struct { Type: "mcp_toolset_reference"; ServerName }Reference to every tool in the named MCP server's toolset.
Reference to every tool in the named MCP server's toolset.
type BetaToolChangeToolDefinition struct { Type: "tool_definition"; Definition }A tool defined by value, as a compaction block's tool_changes entry
reports it: definition is the tool's definition as it was sent, in the
form of a tools entry, without cache_control. Send it back unchanged
with the block.
A tool defined by value, as a compaction block's tool_changes entry
reports it: definition is the tool's definition as it was sent, in the
form of a tools entry, without cache_control. Send it back unchanged
with the block.
Type ToolDefinition
Definition BetaResponseToolUnion
type BetaToolChangeToolDefinitionParam struct { Type: "tool_definition"; Definition }A tool defined by value: definition is a tools entry (any kind
tools accepts, an MCP toolset included). An mcp_toolset given here
also requires the mcp-client-2026-09-15 beta.
A tool defined by value: definition is a tools entry (any kind
tools accepts, an MCP toolset included). An mcp_toolset given here
also requires the mcp-client-2026-09-15 beta.
Definition BetaToolUnionParam
type BetaToolChangeToolReferenceParam struct { Type: "tool_reference"; Name }Reference to a single tool, by the name the model uses to call it: a
tool declared in tools or defined by an earlier tool_addition
block. 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.
Reference to a single tool, by the name the model uses to call it: a
tool declared in tools or defined by an earlier tool_addition
block. 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 string
type BetaToolChoiceUnionParam interface{…}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.
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.
type BetaToolChoiceAnyParam struct { Type: "any"; DisableParallelToolUse }The model will use any available tools.
The model will use any available tools.
DisableParallelToolUse bool OptionalWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
type BetaToolChoiceAutoParam struct { Type: "auto"; DisableParallelToolUse }The model will automatically decide whether to use tools.
The model will automatically decide whether to use tools.
DisableParallelToolUse bool OptionalWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output at most one tool use.
type BetaToolChoiceNoneParam struct { Type: "none" }The model will not be allowed to use tools.
The model will not be allowed to use tools.
type BetaToolChoiceToolParam struct { Type: "tool"; Name; DisableParallelToolUse }The model will use the specified tool with tool_choice.name.
The model will use the specified tool with tool_choice.name.
The name of the tool to use.
DisableParallelToolUse bool OptionalWhether to disable parallel tool use.
Whether to disable parallel tool use.
Defaults to false. If set to true, the model will output exactly one tool use.
type BetaToolComputerUse20241022 struct { Type: "computer_20241022"; DisplayHeightPx; DisplayWidthPx; /* 7 more */ }
type BetaToolComputerUse20250124 struct { Type: "computer_20250124"; DisplayHeightPx; DisplayWidthPx; /* 7 more */ }
type BetaToolComputerUse20251124 struct { Type: "computer_20251124"; DisplayHeightPx; DisplayWidthPx; /* 8 more */ }
type BetaToolReferenceBlock struct { Type: "tool_reference"; ToolName }
Type ToolReference
ToolName string
type BetaToolReferenceBlockParam struct { Type: "tool_reference"; ToolName; CacheControl }Tool reference block that can be included in tool_result content.
Tool reference block that can be included in tool_result content.
ToolName string
CacheControl BetaCacheControlEphemeralParam OptionalCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
TTL BetaCacheControlEphemeralTTL OptionalThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m. See prompt caching pricing for details.
type BetaToolResultBlockParam struct { Type: "tool_result"; ToolUseID; CacheControl; /* 3 more */ }
type BetaToolSearchToolBm25_20251119 struct { Type; Name; AllowedCallers; /* 3 more */ }
type BetaToolSearchToolRegex20251119 struct { Type; Name; AllowedCallers; /* 3 more */ }
type BetaToolSearchToolResultBlock struct { Type: "tool_search_tool_result"; Content; ToolUseID }
type BetaToolSearchToolResultBlockParam struct { Type: "tool_search_tool_result"; Content; ToolUseID; CacheControl }
type BetaToolSearchToolResultError struct { Type: "tool_search_tool_result_error"; ErrorCode; ErrorMessage }
Type ToolSearchToolResultError
ErrorCode BetaToolSearchToolResultErrorErrorCode
type BetaToolSearchToolResultErrorParam struct { Type: "tool_search_tool_result_error"; ErrorCode; ErrorMessage }
ErrorCode BetaToolSearchToolResultErrorParamErrorCode
type BetaToolSearchToolSearchResultBlock struct { Type: "tool_search_tool_search_result"; ToolReferences }
Type ToolSearchToolSearchResult
ToolReferences []BetaToolReferenceBlock
Type ToolReference
ToolName string
type BetaToolSearchToolSearchResultBlockParam struct { Type: "tool_search_tool_search_result"; ToolReferences }
ToolReferences []BetaToolReferenceBlockParam
ToolName string
CacheControl BetaCacheControlEphemeralParam OptionalCreate a cache control breakpoint at this content block.
Create a cache control breakpoint at this content block.
TTL BetaCacheControlEphemeralTTL OptionalThe time-to-live for the cache control breakpoint.
The time-to-live for the cache control breakpoint.
This may be one the following values:
5m: 5 minutes1h: 1 hour
Defaults to 5m. See prompt caching pricing for details.
type BetaToolTextEditor20241022 struct { Type: "text_editor_20241022"; Name; AllowedCallers; /* 4 more */ }
type BetaToolTextEditor20250124 struct { Type: "text_editor_20250124"; Name; AllowedCallers; /* 4 more */ }
type BetaToolTextEditor20250429 struct { Type: "text_editor_20250429"; Name; AllowedCallers; /* 4 more */ }
type BetaToolTextEditor20250728 struct { Type: "text_editor_20250728"; Name; AllowedCallers; /* 5 more */ }
type BetaToolUnionParam interface{…}
type BetaToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaToolUseBlockParam struct { Type: "tool_use"; ID; Input; /* 4 more */ }
type BetaToolUseCallerUnion interface{…}Which party invoked the tool call: the model directly, or a server tool on its behalf.
Which party invoked the tool call: the model directly, or a server tool on its behalf.
type BetaDirectCaller struct { Type: "direct" }Tool invocation directly from the model.
Tool invocation directly from the model.
type BetaServerToolCaller struct { Type: "code_execution_20250825"; ToolID }Tool invocation generated by a server-side tool.
Tool invocation generated by a server-side tool.
ToolID string
type BetaServerToolCaller20260120 struct { Type: "code_execution_20260120"; ToolID }
ToolID string
type BetaToolUsesKeepParam struct { Type: "tool_uses"; Value }
Value int64
type BetaToolUsesTriggerParam struct { Type: "tool_uses"; Value }
Value int64
type BetaToolsetToolUseBlockUnion interface{…}
type BetaBrowserToolUseBlockUnion interface{…}
type BetaComputerToolUseBlockUnion interface{…}
type BetaToolUseBlock struct { Type: "tool_use"; ID; Input; /* 3 more */ }
type BetaURLImageSourceParam struct { Type: "url"; URL }
type BetaURLPDFSourceParam struct { Type: "url"; URL }
type BetaUsage struct { CacheCreation; CacheCreationInputTokens; CacheReadInputTokens; /* 9 more */ }
type BetaUserLocation struct { Type: "approximate"; City; Country; /* 2 more */ }
City string OptionalThe city of the user.
The city of the user.
Country string OptionalThe two letter ISO country code of the user.
The two letter ISO country code of the user.
Region string OptionalThe region of the user.
The region of the user.
Timezone string OptionalThe IANA timezone of the user.
The IANA timezone of the user.
type BetaWebFetchBlock struct { Type: "web_fetch_result"; Content; RetrievedAt; URL }
type BetaWebFetchBlockParam struct { Type: "web_fetch_result"; Content; URL; RetrievedAt }
Content BetaRequestDocumentBlockParam
Fetched content URL
ISO 8601 timestamp when the content was retrieved
type BetaWebFetchTool20250910 struct { Type: "web_fetch_20250910"; Name; AllowedCallers; /* 9 more */ }
type BetaWebFetchTool20260209 struct { Type: "web_fetch_20260209"; Name; AllowedCallers; /* 9 more */ }
type BetaWebFetchTool20260309 struct { Type: "web_fetch_20260309"; Name; AllowedCallers; /* 10 more */ }Web fetch tool with use_cache parameter for bypassing cached content.
Web fetch tool with use_cache parameter for bypassing cached content.
type BetaWebFetchTool20260318 struct { Type: "web_fetch_20260318"; Name; AllowedCallers; /* 11 more */ }
type BetaWebFetchToolResultBlock struct { Type: "web_fetch_tool_result"; Content; ToolUseID; Caller }
type BetaWebFetchToolResultBlockParam struct { Type: "web_fetch_tool_result"; Content; ToolUseID; /* 2 more */ }
type BetaWebFetchToolResultErrorBlock struct { Type: "web_fetch_tool_result_error"; ErrorCode }
type BetaWebFetchToolResultErrorBlockParam struct { Type: "web_fetch_tool_result_error"; ErrorCode }
type BetaWebFetchToolResultErrorCode string
type BetaWebFetchURLSourceAll struct { Type: "all" }The url_sources variant under which a source contributes in
full: every result of the tool filter's source, or all user input.
The url_sources variant under which a source contributes in
full: every result of the tool filter's source, or all user input.
type BetaWebFetchURLSourceExcept struct { Type: "except"; Tools }The tool filter variant under which every result but the named
tools' contributes.
The tool filter variant under which every result but the named tools' contributes.
type BetaWebFetchURLSourceNone struct { Type: "none" }The url_sources variant under which a source contributes nothing:
no result of the tool filter's source, or no user input.
The url_sources variant under which a source contributes nothing:
no result of the tool filter's source, or no user input.
type BetaWebFetchURLSourceOnly struct { Type: "only"; Tools }The tool filter variant under which only the named tools' results
contribute.
The tool filter variant under which only the named tools' results contribute.
type BetaWebFetchURLSourceToolReference struct { Type: "tool_reference"; Name }One entry of a tool filter's tools: it must name a tool declared
in this request's tools[].
One entry of a tool filter's tools: it must name a tool declared
in this request's tools[].
type BetaWebFetchURLSources struct { ClientToolResults; ServerToolResults; UserInput }Which sources contribute to the set of URLs web fetch may fetch.
Which sources contribute to the set of URLs web fetch may fetch.
Each key is a tagged variant: user_input is all or none; the
two tool filters are all, none, only (only the named tools'
results) or except (every result but the named tools'). A named tool
must be declared in this request's tools[].
type BetaWebSearchResultBlock struct { Type: "web_search_result"; EncryptedContent; PageAge; /* 2 more */ }
Type WebSearchResult
type BetaWebSearchResultBlockParam struct { Type: "web_search_result"; EncryptedContent; Title; /* 2 more */ }
type BetaWebSearchTool20250305 struct { Type: "web_search_20250305"; Name; AllowedCallers; /* 7 more */ }
type BetaWebSearchTool20260209 struct { Type: "web_search_20260209"; Name; AllowedCallers; /* 7 more */ }
type BetaWebSearchTool20260318 struct { Type: "web_search_20260318"; Name; AllowedCallers; /* 8 more */ }
type BetaWebSearchToolRequestErrorParam struct { Type: "web_search_tool_result_error"; ErrorCode }
ErrorCode BetaWebSearchToolResultErrorCode
type BetaWebSearchToolResultBlock struct { Type: "web_search_tool_result"; Content; ToolUseID; Caller }
type BetaWebSearchToolResultBlockContentUnion interface{…}
type BetaWebSearchToolResultBlockParam struct { Type: "web_search_tool_result"; Content; ToolUseID; /* 2 more */ }
type BetaWebSearchToolResultBlockParamContentUnion interface{…}
type BetaWebSearchToolResultError struct { Type: "web_search_tool_result_error"; ErrorCode }
Type WebSearchToolResultError
ErrorCode BetaWebSearchToolResultErrorCode
type BetaWebSearchToolResultErrorCode string
СообщенияПакеты
Создать пакет сообщений
client.Beta.Messages.Batches.New(ctx, params) (*BetaMessageBatch, error)Отправьте пакет запросов на создание сообщений.
Получить пакет сообщений
client.Beta.Messages.Batches.Get(ctx, messageBatchID, query) (*BetaMessageBatch, error)Эта конечная точка идемпотентна и может использоваться для опроса завершения пакета сообщений. Чтобы получить доступ к результатам пакета сообщений, выполните запрос по адресу, указанному в поле results_url ответа.
Список пакетов сообщений
client.Beta.Messages.Batches.List(ctx, params) (*Page[BetaMessageBatch], error)Получите список всех пакетов сообщений в рабочем пространстве. Последние созданные пакеты возвращаются первыми.
Отменить пакет сообщений
client.Beta.Messages.Batches.Cancel(ctx, messageBatchID, body) (*BetaMessageBatch, error)Пакеты можно отменить в любой момент до окончания обработки. После инициирования отмены пакет переходит в состояние canceling, в котором система может завершить все выполняющиеся непрерываемые запросы перед окончательной отменой.
Удалить пакет сообщений
client.Beta.Messages.Batches.Delete(ctx, messageBatchID, body) (*BetaDeletedMessageBatch, error)Удалите пакет сообщений.
Получить результаты пакета сообщений
client.Beta.Messages.Batches.ResultsStreaming(ctx, messageBatchID, query) *jsonl.Stream[BetaMessageBatchIndividualResponse]Передаёт результаты пакета сообщений в потоковом режиме в виде файла .jsonl.