Сообщения
Создать сообщение
$client->messages->create(int maxTokens, list<MessageParam> messages, Model model, ?CacheControlEphemeral cacheControl, ?MessageCreateParamsContainer container, ?DiagnosticsParam diagnostics, ?string inferenceGeo, ?Metadata metadata, ?OutputConfig outputConfig, ?ServiceTier serviceTier, ?Speed speed, ?list<string> stopSequences, ?System system, ?ThinkingConfigParam thinking, ?ToolChoice toolChoice, ?list<ToolUnion> tools, ?string userProfileID, ?string workspaceID): MessageОтправьте структурированный список входных сообщений с текстом и/или изображениями, и модель сгенерирует следующее сообщение в разговоре.
Подсчитать токены в сообщении
$client->messages->countTokens(list<MessageParam> messages, Model model, ?CacheControlEphemeral cacheControl, ?OutputConfig outputConfig, ?Speed speed, ?System system, ?ThinkingConfigParam thinking, ?ToolChoice toolChoice, ?list<MessageCountTokensTool> tools, ?string userProfileID, ?string workspaceID): MessageTokensCountПодсчитайте количество токенов в сообщении.
Models
class AssistantMessageParam { $content; $role; }
class Base64ImageSource { $type = 'base64'; $data; $mediaType; }
class Base64PDFSource { $type = 'base64'; $data; $mediaType; }
class BashCodeExecutionOutputBlock { $type = 'bash_code_execution_output'; $fileID; }
class BashCodeExecutionOutputBlockParam { $type = 'bash_code_execution_output'; $fileID; }
class BashCodeExecutionResultBlock { $type = 'bash_code_execution_result'; $content; $returnCode; /* 2 more */ }
class BashCodeExecutionResultBlockParam { $type = 'bash_code_execution_result'; $content; $returnCode; /* 2 more */ }
class BashCodeExecutionToolResultBlock { $type = 'bash_code_execution_tool_result'; $content; $toolUseID; }
class BashCodeExecutionToolResultBlockParam { $type = 'bash_code_execution_tool_result'; $content; $toolUseID; $cacheControl; }
Create a cache control breakpoint at this content block.
class BashCodeExecutionToolResultError { $type = 'bash_code_execution_tool_result_error'; $errorCode; }
class BashCodeExecutionToolResultErrorParam { $type = 'bash_code_execution_tool_result_error'; $errorCode; }
class BrowserClickTarget
class BrowserCoordinateTarget { $type = 'coordinate'; $x; $y; }
Pixels from the left edge of the viewport.
Pixels from the top edge of the viewport.
class BrowserRefTarget { $type = 'ref'; $ref; }
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
class BrowserCloseTabConfig { $deferLoading; $enabled; }
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.
class BrowserCloseTabInput { $tabID; }
The tab to close.
class BrowserCloseTabToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Close the tab with the given tab_id.
class BrowserCoordinateTarget { $type = 'coordinate'; $x; $y; }
Pixels from the left edge of the viewport.
Pixels from the top edge of the viewport.
class BrowserDoubleClickConfig { $deferLoading; $enabled; }
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.
class BrowserDoubleClickInput { $target; $modifiers; $tabID; }
Where to act: either a viewport coordinate or an element reference.
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.
class BrowserDoubleClickToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Double left-click at a viewport coordinate or on an element by reference.
class BrowserFileUploadConfig { $deferLoading; $enabled; }
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.
class BrowserFileUploadInput { $target; $documentIDs; $paths; $tabID; }
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.
References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem.
File paths on the browser executor's filesystem.
Tab to act on. Defaults to the active tab when omitted.
class BrowserFileUploadToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
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.
class BrowserFindConfig { $deferLoading; $enabled; }
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.
class BrowserFindInput { $query; $tabID; }
Natural-language description of the element(s) to find.
Tab to act on. Defaults to the active tab when omitted.
class BrowserFindToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references.
class BrowserFormInputConfig { $deferLoading; $enabled; }
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.
class BrowserFormInputInput { $target; $value; $tabID; }
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.
The value to set.
Tab to act on. Defaults to the active tab when omitted.
class BrowserFormInputToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects.
class BrowserFormInputValue
class BrowserGetPageTextConfig { $deferLoading; $enabled; }
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.
class BrowserGetPageTextInput { $tabID; }
Tab to act on. Defaults to the active tab when omitted.
class BrowserGetPageTextToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages.
class BrowserHoldKeyConfig { $deferLoading; $enabled; }
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.
class BrowserHoldKeyInput { $duration; $text; $tabID; }
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.
class BrowserHoldKeyToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
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.
class BrowserHoverConfig { $deferLoading; $enabled; }
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.
class BrowserHoverInput { $target; $tabID; }
Where to act: either a viewport coordinate or an element reference.
Tab to act on. Defaults to the active tab when omitted.
class BrowserHoverToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Move the cursor to a coordinate or element without clicking.
class BrowserJavascriptExecConfig { $deferLoading; $enabled; }
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.
class BrowserJavascriptExecInput { $text; $tabID; }
JavaScript to execute in the page context.
Tab to act on. Defaults to the active tab when omitted.
class BrowserJavascriptExecToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
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.
class BrowserKeyConfig { $deferLoading; $enabled; }
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.
class BrowserKeyInput { $text; $repeat; $tabID; }
The key, chord, or space-separated sequence to press.
Number of times to repeat. Default 1.
Tab to act on. Defaults to the active tab when omitted.
class BrowserKeyToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
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.
class BrowserLeftClickConfig { $deferLoading; $enabled; }
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.
class BrowserLeftClickDragConfig { $deferLoading; $enabled; }
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.
class BrowserLeftClickDragInput { $from; $target; $tabID; }
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).
Tab to act on. Defaults to the active tab when omitted.
class BrowserLeftClickDragToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Press at from, drag to target, release. Both must be coordinate targets.
class BrowserLeftClickInput { $target; $modifiers; $tabID; }
Where to act: either a viewport coordinate or an element reference.
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.
class BrowserLeftClickToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Left-click at a viewport coordinate or on an element by reference.
class BrowserLeftMouseDownConfig { $deferLoading; $enabled; }
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.
class BrowserLeftMouseDownInput { $target; $tabID; }
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
Tab to act on. Defaults to the active tab when omitted.
class BrowserLeftMouseDownToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag.
class BrowserLeftMouseUpConfig { $deferLoading; $enabled; }
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.
class BrowserLeftMouseUpInput { $target; $tabID; }
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
Tab to act on. Defaults to the active tab when omitted.
class BrowserLeftMouseUpToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Release the left mouse button at a viewport coordinate.
class BrowserListTabsConfig { $deferLoading; $enabled; }
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.
class BrowserListTabsToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
List all open tabs with each tab's tab_id, title, and URL.
class BrowserMiddleClickConfig { $deferLoading; $enabled; }
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.
class BrowserMiddleClickInput { $target; $modifiers; $tabID; }
Where to act: either a viewport coordinate or an element reference.
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.
class BrowserMiddleClickToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Middle-click at a viewport coordinate or on an element by reference.
class BrowserMouseMoveConfig { $deferLoading; $enabled; }
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.
class BrowserMouseMoveInput { $target; $tabID; }
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
Tab to act on. Defaults to the active tab when omitted.
class BrowserMouseMoveToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Move the pointer to a viewport coordinate without clicking.
class BrowserNavigateConfig { $deferLoading; $enabled; }
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.
class BrowserNavigateInput { $url; $tabID; }
The URL to navigate to, or "back" / "forward" / "reload" for history navigation.
Tab to act on. Defaults to the active tab when omitted.
class BrowserNavigateToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://).
class BrowserNewTabConfig { $deferLoading; $enabled; }
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.
class BrowserNewTabToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Open a new empty tab and return its tab_id.
class BrowserReadConsoleConfig { $deferLoading; $enabled; }
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.
class BrowserReadConsoleInput { $tabID; }
Tab to act on. Defaults to the active tab when omitted.
class BrowserReadConsoleToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
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.
class BrowserReadNetworkConfig { $deferLoading; $enabled; }
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.
class BrowserReadNetworkInput { $tabID; }
Tab to act on. Defaults to the active tab when omitted.
class BrowserReadNetworkToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
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.
class BrowserReadPageConfig { $deferLoading; $enabled; }
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.
class BrowserReadPageInput { $depth; $filter; $ref; $tabID; }
Maximum tree depth. Default 15.
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.
class BrowserReadPageToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
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.
class BrowserRefTarget { $type = 'ref'; $ref; }
An element reference (e.g. "ref_7") returned by a prior read_page or find result.
class BrowserRightClickConfig { $deferLoading; $enabled; }
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.
class BrowserRightClickInput { $target; $modifiers; $tabID; }
Where to act: either a viewport coordinate or an element reference.
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.
class BrowserRightClickToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Right-click at a viewport coordinate or on an element by reference.
class BrowserScreenshotConfig { $deferLoading; $enabled; }
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.
class BrowserScreenshotInput { $tabID; }
Tab to act on. Defaults to the active tab when omitted.
class BrowserScreenshotToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Capture the current browser viewport.
class BrowserScrollConfig { $deferLoading; $enabled; }
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.
class BrowserScrollInput { $scrollDirection; $target; $scrollAmount; $tabID; }
A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot).
Scroll-wheel notches (1–10). Default 3.
Tab to act on. Defaults to the active tab when omitted.
class BrowserScrollToConfig { $deferLoading; $enabled; }
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.
class BrowserScrollToInput { $target; $tabID; }
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.
Tab to act on. Defaults to the active tab when omitted.
class BrowserScrollToToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Scroll an element into view.
class BrowserScrollToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Scroll at a viewport position. target must be a coordinate target.
class BrowserStateBlockParam { $type = 'browser_state'; $tabs; $cacheControl; $stateChanges; }
All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries active: true.
Create a cache control breakpoint at this content block.
Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list.
class BrowserStateChange
class BrowserStateChangeDownloadCompleted { $type = 'download_completed'; $downloadID; $url; /* 2 more */ }
The caller-assigned identifier for this download, stable across the state changes reporting it.
The final post-redirect URL the download was served from.
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.
The completed download's size.
class BrowserStateChangeDownloadFailed { $type = 'download_failed'; $downloadID; $url; $error; }
The caller-assigned identifier for this download, stable across the state changes reporting it.
The final post-redirect URL the download was served from.
The failure or cancellation detail, when known.
class BrowserStateChangeDownloadStarted { $type = 'download_started'; $downloadID; $url; }
The caller-assigned identifier for this download, stable across the state changes reporting it.
The final post-redirect URL the download was served from.
class BrowserStateChangeTabOpened { $type = 'tab_opened'; $tabID; }
The tab_id of the opened tab, present in tabs.
class BrowserStateTabEntry { $tabID; $title; $url; $active; }
The caller-assigned identifier for this tab, unique within the inventory.
The title 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.
class BrowserSwitchTabConfig { $deferLoading; $enabled; }
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.
class BrowserSwitchTabInput { $tabID; }
The tab to switch to.
class BrowserSwitchTabToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to.
class BrowserToolUseBlock
class BrowserToolset20260801 { $type = 'browser_toolset_20260801'; $cacheControl; $configs; }
Create a cache control breakpoint at this content block.
Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
class BrowserToolsetConfigs { $type; $closeTab; $doubleClick; /* 28 more */ }
class BrowserTripleClickConfig { $deferLoading; $enabled; }
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.
class BrowserTripleClickInput { $target; $modifiers; $tabID; }
Where to act: either a viewport coordinate or an element reference.
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.
class BrowserTripleClickToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph).
class BrowserTypeConfig { $deferLoading; $enabled; }
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.
class BrowserTypeInput { $text; $tabID; }
The text to type.
Tab to act on. Defaults to the active tab when omitted.
class BrowserTypeToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Type a literal string at the current focus.
class BrowserWaitConfig { $deferLoading; $enabled; }
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.
class BrowserWaitInput { $duration; $tabID; }
Seconds to wait (maximum 30).
Tab to act on. Defaults to the active tab when omitted.
class BrowserWaitToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Pause for the given duration.
class BrowserZoomConfig { $deferLoading; $enabled; }
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.
class BrowserZoomInput { $region; $tabID; }
[x0, y0, x1, y1] in viewport pixels.
Tab to act on. Defaults to the active tab when omitted.
class BrowserZoomToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
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.
class CacheControlEphemeral { $type = 'ephemeral'; $ttl; }
?TTL ttlThe 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.
class CacheCreation { $ephemeral1hInputTokens; $ephemeral5mInputTokens; }
The number of input tokens used to create the 1 hour cache entry.
The number of input tokens used to create the 5 minute cache entry.
class CacheMissMessagesChanged { $type = 'messages_changed'; $cacheMissedInputTokens; }
Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
class CacheMissModelChanged { $type = 'model_changed'; $cacheMissedInputTokens; }
Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
class CacheMissPreviousMessageNotFound { $type = 'previous_message_not_found'; }
class CacheMissReason
class CacheMissSystemChanged { $type = 'system_changed'; $cacheMissedInputTokens; }
Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
class CacheMissToolsChanged { $type = 'tools_changed'; $cacheMissedInputTokens; }
Approximate number of input tokens that would have been read from cache had the prefix matched the previous request.
class CacheMissUnavailable { $type = 'unavailable'; }
class CitationCharLocation { $type = 'char_location'; $citedText; $documentIndex; /* 4 more */ }
class CitationCharLocationParam { $type = 'char_location'; $citedText; $documentIndex; /* 3 more */ }
class CitationContentBlockLocation { $type = 'content_block_location'; $citedText; $documentIndex; /* 4 more */ }
string citedTextThe 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.
int endBlockIndexExclusive 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.
0-based index of the first cited block in the source's content array.
class CitationContentBlockLocationParam { $type = 'content_block_location'; $citedText; $documentIndex; /* 3 more */ }
string citedTextThe 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.
int endBlockIndexExclusive 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.
0-based index of the first cited block in the source's content array.
class CitationPageLocation { $type = 'page_location'; $citedText; $documentIndex; /* 4 more */ }
class CitationPageLocationParam { $type = 'page_location'; $citedText; $documentIndex; /* 3 more */ }
class CitationSearchResultLocationParam { $type = 'search_result_location'; $citedText; $endBlockIndex; /* 4 more */ }
string citedTextThe 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.
int endBlockIndexExclusive 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.
int searchResultIndex0-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.
0-based index of the first cited block in the source's content array.
class CitationWebSearchResultLocationParam { $type = 'web_search_result_location'; $citedText; $encryptedIndex; /* 2 more */ }
class CitationsConfig { $enabled; }
class CitationsConfigParam { $enabled; }
class CitationsDelta { $type = 'citations_delta'; $citation; }
class CitationsSearchResultLocation { $type = 'search_result_location'; $citedText; $endBlockIndex; /* 4 more */ }
string citedTextThe 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.
int endBlockIndexExclusive 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.
int searchResultIndex0-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.
0-based index of the first cited block in the source's content array.
class CitationsWebSearchResultLocation { $type = 'web_search_result_location'; $citedText; $encryptedIndex; /* 2 more */ }
class CodeExecutionOutputBlock { $type = 'code_execution_output'; $fileID; }
class CodeExecutionOutputBlockParam { $type = 'code_execution_output'; $fileID; }
class CodeExecutionResultBlock { $type = 'code_execution_result'; $content; $returnCode; /* 2 more */ }
class CodeExecutionResultBlockParam { $type = 'code_execution_result'; $content; $returnCode; /* 2 more */ }
class CodeExecutionTool20250522 { $type = 'code_execution_20250522'; $name; $allowedCallers; /* 3 more */ }
"code_execution" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class CodeExecutionTool20250825 { $type = 'code_execution_20250825'; $name; $allowedCallers; /* 3 more */ }
"code_execution" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class CodeExecutionTool20260120 { $type = 'code_execution_20260120'; $name; $allowedCallers; /* 3 more */ }
"code_execution" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class CodeExecutionTool20260521 { $type = 'code_execution_20260521'; $name; $allowedCallers; /* 3 more */ }
"code_execution" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class CodeExecutionToolResultBlock { $type = 'code_execution_tool_result'; $content; $toolUseID; }
class CodeExecutionToolResultBlockParam { $type = 'code_execution_tool_result'; $content; $toolUseID; $cacheControl; }
Create a cache control breakpoint at this content block.
class CodeExecutionToolResultError { $type = 'code_execution_tool_result_error'; $errorCode; }
class CodeExecutionToolResultErrorParam { $type = 'code_execution_tool_result_error'; $errorCode; }
class ComputerCursorPositionConfig { $deferLoading; $enabled; }
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.
class ComputerCursorPositionToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Get the current (x, y) pixel coordinate of the cursor.
class ComputerDoubleClickConfig { $deferLoading; $enabled; }
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.
class ComputerDoubleClickInput { $coordinate; $text; }
(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").
class ComputerDoubleClickToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Double-click the left mouse button at the specified (x, y) pixel coordinate, or
the current cursor position if coordinate is omitted.
class ComputerHoldKeyConfig { $deferLoading; $enabled; }
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.
class ComputerHoldKeyInput { $duration; $text; }
Duration to hold the key, in seconds.
The key or key-combination to hold.
class ComputerHoldKeyToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Hold down a key or key-combination for a specified duration. Uses the same key
syntax as key.
class ComputerKeyConfig { $deferLoading; $enabled; }
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.
class ComputerKeyInput { $text; $repeat; }
The key or key-combination to press.
Number of times to repeat the key press. Default is 1.
class ComputerKeyToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
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.
class ComputerLeftClickConfig { $deferLoading; $enabled; }
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.
class ComputerLeftClickDragConfig { $deferLoading; $enabled; }
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.
class ComputerLeftClickDragInput { $coordinate; $startCoordinate; $text; }
(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").
class ComputerLeftClickDragToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Click and drag the cursor from start_coordinate to coordinate.
class ComputerLeftClickInput { $coordinate; $text; }
(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").
class ComputerLeftClickToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Click the left mouse button at the specified (x, y) pixel coordinate, or the
current cursor position if coordinate is omitted.
class ComputerLeftMouseDownConfig { $deferLoading; $enabled; }
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.
class ComputerLeftMouseDownToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Press and hold the left mouse button at the current cursor position.
class ComputerLeftMouseUpConfig { $deferLoading; $enabled; }
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.
class ComputerLeftMouseUpToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Release the left mouse button.
class ComputerMiddleClickConfig { $deferLoading; $enabled; }
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.
class ComputerMiddleClickInput { $coordinate; $text; }
(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").
class ComputerMiddleClickToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Click the middle mouse button at the specified (x, y) pixel coordinate, or the
current cursor position if coordinate is omitted.
class ComputerMouseMoveConfig { $deferLoading; $enabled; }
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.
class ComputerMouseMoveInput { $coordinate; }
(x, y): x pixels from the left edge, y pixels from the top edge.
class ComputerMouseMoveToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly.
class ComputerRightClickConfig { $deferLoading; $enabled; }
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.
class ComputerRightClickInput { $coordinate; $text; }
(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").
class ComputerRightClickToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Click the right mouse button at the specified (x, y) pixel coordinate, or the
current cursor position if coordinate is omitted.
class ComputerScreenshotConfig { $deferLoading; $enabled; }
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.
class ComputerScreenshotToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Take a screenshot of the screen.
class ComputerScrollConfig { $deferLoading; $enabled; }
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.
class ComputerScrollInput { $scrollAmount; $scrollDirection; $coordinate; $text; }
Number of 'clicks' of the scroll wheel.
(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").
class ComputerScrollToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
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.
class ComputerToolUseBlock
class ComputerToolset20260801 { $type = 'computer_toolset_20260801'; $cacheControl; $configs; }
Create a cache control breakpoint at this content block.
Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent.
class ComputerToolsetConfigs { $type; $cursorPosition; $doubleClick; /* 14 more */ }
class ComputerTripleClickConfig { $deferLoading; $enabled; }
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.
class ComputerTripleClickInput { $coordinate; $text; }
(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").
class ComputerTripleClickToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Triple-click the left mouse button at the specified (x, y) pixel coordinate, or
the current cursor position if coordinate is omitted.
class ComputerTypeConfig { $deferLoading; $enabled; }
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.
class ComputerTypeInput { $text; }
The text to type.
class ComputerTypeToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Type a string of text on the keyboard.
class ComputerWaitConfig { $deferLoading; $enabled; }
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.
class ComputerWaitInput { $duration; }
Duration to wait, in seconds.
class ComputerWaitToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
Wait for a specified duration.
class ComputerZoomConfig { $deferLoading; $enabled; }
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.
class ComputerZoomInput { $region; }
(x0, y0, x1, y1): The region to capture.
class ComputerZoomToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
Which party invoked the tool call: the model directly, or a server tool on its behalf.
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.
class Container { $id; $expiresAt; $skills; }
Identifier for the container used in this request
The time at which the container will expire.
Skills loaded in the container
class ContainerParams { $id; $skills; }
Container id
List of skills to load in the container
class ContainerSkill { $type; $skillID; $version; }
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Skill ID
The resolved version: a skill version ID for custom skills.
class ContainerUploadBlock { $type = 'container_upload'; $fileID; }
class ContainerUploadBlockParam { $type = 'container_upload'; $fileID; $cacheControl; }
Create a cache control breakpoint at this content block.
class ContentBlock
class ContentBlockParam
class ContentBlockSource { $type = 'content'; $content; }
class Diagnostics { $cacheMissReason; }
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.
class DiagnosticsParam { $previousMessageID; }
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.
class DirectCaller { $type = 'direct'; }
class DocumentBlock { $type = 'document'; $citations; $source; $title; }
Citation configuration for the document
The title of the document
class DocumentBlockParam { $type = 'document'; $source; $cacheControl; /* 3 more */ }
Create a cache control breakpoint at this content block.
class EncryptedCodeExecutionResultBlock { $type = 'encrypted_code_execution_result'; $content; $encryptedStdout; /* 2 more */ }
class EncryptedCodeExecutionResultBlockParam { $type = 'encrypted_code_execution_result'; $content; $encryptedStdout; /* 2 more */ }
class FileDocumentSource { $type = 'file'; $fileID; }
class FileImageSource { $type = 'file'; $fileID; }
class ImageBlockParam { $type = 'image'; $source; $cacheControl; $transformations; }
Create a cache control breakpoint at this content block.
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.
class ImageTransformationsParam { $oversizedImage; }
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.
class InputJSONDelta { $type = 'input_json_delta'; $partialJSON; }
class JSONOutputFormat { $type = 'json_schema'; $schema; }
The JSON schema of the format
class MemoryTool20250818 { $type = 'memory_20250818'; $name; $allowedCallers; /* 4 more */ }
"memory" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class Message { $type = 'message'; $id; $container; /* 8 more */ }
class MessageContentParam
class MessageCountTokensTool
class ContainerParams { $id; $skills; }
Container id
List of skills to load in the container
class MessageDeltaUsage { $cacheCreationInputTokens; $cacheReadInputTokens; $inputTokens; /* 3 more */ }
The cumulative number of input tokens used to create the cache entry.
The cumulative number of input tokens read from the cache.
The cumulative number of input tokens which were used.
The cumulative number of output tokens which were used.
?OutputTokensDetails outputTokensDetailsBreakdown of output tokens by category.
Breakdown of output tokens by category.
output_tokens remains the inclusive, authoritative total used for billing.
This object provides a read-only decomposition for observability — for example,
how many of the billed output tokens were spent on internal reasoning that may
have been summarized before being returned to you.
The number of server tool requests.
class MessageParam
class UserMessageParam { $content; $role; }
class AssistantMessageParam { $content; $role; }
class SystemMessageParam { $content; $role; }
class MessageTokensCount { $inputTokens; }
The total number of tokens across the provided list of messages, system prompt, and tools.
class Metadata { $userID; }
?string userIDAn 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.
enum Model
Fastest model for high-volume, real-time tasks
Efficient model for coding and agents
Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows
Powerful intelligence for coding, knowledge work, and long-running agents
Our most capable model for cybersecurity and biology research, available through trusted access programs
Efficient model for coding and agents
Next generation of intelligence for the hardest knowledge work and coding problems
Most capable model for cybersecurity and biology research
Powerful intelligence for long-running agents and coding
Powerful intelligence for long-running agents and coding
Powerful intelligence for long-running agents and coding
Powerful intelligence for long-running agents and coding
Best combination of speed and intelligence
Powerful intelligence for long-running agents and coding
Powerful intelligence for long-running agents and coding
"claude-mythos-preview"DeprecatedNew class of intelligence, strongest in coding and cybersecurity
New class of intelligence, strongest in coding and cybersecurity
"claude-sonnet-4-5"DeprecatedHigh-performance model for agents and coding
High-performance model for agents and coding
"claude-sonnet-4-5-20250929"DeprecatedHigh-performance model for agents and coding
High-performance model for agents and coding
class OutputConfig { $effort; $format; }
?Effort effortHow 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.
A schema to specify Claude's output format in responses. See structured outputs
class OutputTokensDetails { $thinkingTokens; }
int thinkingTokensNumber 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. 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.
class PlainTextSource { $type = 'text'; $data; $mediaType; }
class RawContentBlockDelta
class RawContentBlockDeltaEvent { $type = 'content_block_delta'; $delta; $index; }
class RawContentBlockStartEvent { $type = 'content_block_start'; $contentBlock; $index; }
class RawContentBlockStopEvent { $type = 'content_block_stop'; $index; }
class RawMessageDeltaEvent { $type = 'message_delta'; $delta; $usage; }
MessageDeltaUsage usageBilling and rate-limit usage.
Billing and rate-limit usage.
Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.
Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.
For example, output_tokens will be non-zero, even for an empty string response from Claude.
Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.
class RawMessageStartEvent { $type = 'message_start'; $message; }
class RawMessageStopEvent { $type = 'message_stop'; }
class RawMessageStreamEvent
class RedactedThinkingBlock { $type = 'redacted_thinking'; $data; }
string dataThe 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.
class RedactedThinkingBlockParam { $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.
class RefusalStopDetails { $type = 'refusal'; $category; $explanation; }
?Category categoryThe policy category that triggered the refusal.
The policy category that triggered the refusal.
null when the refusal doesn't map to a named category.
?string explanationHuman-readable explanation of the refusal.
Human-readable explanation of the refusal.
This text is not guaranteed to be stable. null when no explanation is available for the category.
class SearchResultBlockParam { $type = 'search_result'; $content; $source; /* 3 more */ }
Create a cache control breakpoint at this content block.
class ServerToolCaller { $type = 'code_execution_20250825'; $toolID; }
class ServerToolCaller20260120 { $type = 'code_execution_20260120'; $toolID; }
class ServerToolUsage { $webFetchRequests; $webSearchRequests; }
The number of web fetch tool requests.
The number of web search tool requests.
class ServerToolUseBlock { $type = 'server_tool_use'; $id; $caller; /* 2 more */ }
class ServerToolUseBlockParam { $type = 'server_tool_use'; $id; $input; /* 3 more */ }
Create a cache control breakpoint at this content block.
class SignatureDelta { $type = 'signature_delta'; $signature; }
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.
class SkillParams { $type; $skillID; $version; }
Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
Skill ID
Skill version or 'latest' for most recent version
enum StopReason
class SystemMessageParam { $content; $role; }
class TextBlock { $type = 'text'; $citations; $text; }
?list<TextCitation> citationsCitations supporting the text block.
Citations supporting the text block.
The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.
class TextBlockParam { $type = 'text'; $text; $cacheControl; $citations; }
Create a cache control breakpoint at this content block.
class TextCitation
class TextCitationParam
class TextDelta { $type = 'text_delta'; $text; }
class TextEditorCodeExecutionCreateResultBlock { $type = 'text_editor_code_execution_create_result'; $isFileUpdate; }
class TextEditorCodeExecutionCreateResultBlockParam { $type = 'text_editor_code_execution_create_result'; $isFileUpdate; }
class TextEditorCodeExecutionStrReplaceResultBlock { $type = 'text_editor_code_execution_str_replace_result'; $lines; $newLines; /* 3 more */ }
class TextEditorCodeExecutionStrReplaceResultBlockParam { $type = 'text_editor_code_execution_str_replace_result'; $lines; $newLines; /* 3 more */ }
class TextEditorCodeExecutionToolResultBlock { $type = 'text_editor_code_execution_tool_result'; $content; $toolUseID; }
class TextEditorCodeExecutionToolResultBlockParam { $type = 'text_editor_code_execution_tool_result'; $content; $toolUseID; $cacheControl; }
Create a cache control breakpoint at this content block.
class TextEditorCodeExecutionToolResultError { $type = 'text_editor_code_execution_tool_result_error'; $errorCode; $errorMessage; }
class TextEditorCodeExecutionToolResultErrorParam { $type = 'text_editor_code_execution_tool_result_error'; $errorCode; $errorMessage; }
class TextEditorCodeExecutionViewResultBlock { $type = 'text_editor_code_execution_view_result'; $content; $fileType; /* 3 more */ }
class TextEditorCodeExecutionViewResultBlockParam { $type = 'text_editor_code_execution_view_result'; $content; $fileType; /* 3 more */ }
class ThinkingBlock { $type = 'thinking'; $signature; $thinking; }
string signatureA 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.
class ThinkingBlockParam { $type = 'thinking'; $signature; $thinking; }
string signatureThe 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.
class ThinkingConfigAdaptive { $type = 'adaptive'; $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.
class ThinkingConfigBetweenTools { $type = 'between_tools'; }
class ThinkingConfigDisabled { $type = 'disabled'; }
class ThinkingConfigEnabled { $type = 'enabled'; $budgetTokens; $display; }
int budgetTokensDetermines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality.
Must be ≥1024 and less than max_tokens.
See extended thinking for details.
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.
class ThinkingConfigParam
class ThinkingDelta { $type = 'thinking_delta'; $thinking; }
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.
class Tool { $type; $inputSchema; $name; /* 7 more */ }
InputSchema inputSchemaJSON 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.
string nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
?string descriptionDescription of what this tool does.
Description of what this tool does.
Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema.
Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers.
When true, guarantees schema validation on tool names and inputs
class ToolBash20250124 { $type = 'bash_20250124'; $name; $allowedCallers; /* 4 more */ }
"bash" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class ToolChoice
class ToolChoiceAny { $type = 'any'; $disableParallelToolUse; }
?bool disableParallelToolUseWhether 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.
class ToolChoiceAuto { $type = 'auto'; $disableParallelToolUse; }
?bool disableParallelToolUseWhether 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.
class ToolChoiceNone { $type = 'none'; }
class ToolChoiceTool { $type = 'tool'; $name; $disableParallelToolUse; }
The name of the tool to use.
?bool disableParallelToolUseWhether 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.
class ToolReferenceBlock { $type = 'tool_reference'; $toolName; }
class ToolReferenceBlockParam { $type = 'tool_reference'; $toolName; $cacheControl; }
Create a cache control breakpoint at this content block.
class ToolResultBlockParam { $type = 'tool_result'; $toolUseID; $cacheControl; /* 3 more */ }
Create a cache control breakpoint at this content block.
For a toolset member tool_result, the toolset family of the paired tool_use.
class ToolSearchToolBm25_20251119 { $type; $name; $allowedCallers; /* 3 more */ }
"tool_search_tool_bm25" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class ToolSearchToolRegex20251119 { $type; $name; $allowedCallers; /* 3 more */ }
"tool_search_tool_regex" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class ToolSearchToolResultBlock { $type = 'tool_search_tool_result'; $content; $toolUseID; }
class ToolSearchToolResultBlockParam { $type = 'tool_search_tool_result'; $content; $toolUseID; $cacheControl; }
Create a cache control breakpoint at this content block.
class ToolSearchToolResultError { $type = 'tool_search_tool_result_error'; $errorCode; $errorMessage; }
class ToolSearchToolResultErrorParam { $type = 'tool_search_tool_result_error'; $errorCode; $errorMessage; }
class ToolSearchToolSearchResultBlock { $type = 'tool_search_tool_search_result'; $toolReferences; }
class ToolSearchToolSearchResultBlockParam { $type = 'tool_search_tool_search_result'; $toolReferences; }
class ToolTextEditor20250124 { $type = 'text_editor_20250124'; $name; $allowedCallers; /* 4 more */ }
"str_replace_editor" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class ToolTextEditor20250429 { $type = 'text_editor_20250429'; $name; $allowedCallers; /* 4 more */ }
"str_replace_based_edit_tool" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
When true, guarantees schema validation on tool names and inputs
class ToolTextEditor20250728 { $type = 'text_editor_20250728'; $name; $allowedCallers; /* 5 more */ }
"str_replace_based_edit_tool" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file.
When true, guarantees schema validation on tool names and inputs
class ToolUnion
class ToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
For a toolset member tool_use, the toolset family.
class ToolUseBlockParam { $type = 'tool_use'; $id; $input; /* 4 more */ }
Create a cache control breakpoint at this content block.
For a toolset member tool_use, the toolset family this member belongs to.
class ToolUseCaller
class DirectCaller { $type = 'direct'; }
class ServerToolCaller { $type = 'code_execution_20250825'; $toolID; }
class ServerToolCaller20260120 { $type = 'code_execution_20260120'; $toolID; }
class ToolsetToolUseBlock
class BrowserToolUseBlock
class ComputerToolUseBlock
class ToolUseBlock { $type = 'tool_use'; $id; $caller; /* 3 more */ }
For a toolset member tool_use, the toolset family.
class URLImageSource { $type = 'url'; $url; }
class URLPDFSource { $type = 'url'; $url; }
class Usage { $cacheCreation; $cacheCreationInputTokens; $cacheReadInputTokens; /* 7 more */ }
Breakdown of cached tokens by TTL
The number of input tokens used to create the cache entry.
The number of input tokens read from the cache.
The geographic region where inference was performed for this request.
The number of input tokens which were used.
The number of output tokens which were used.
?OutputTokensDetails outputTokensDetailsBreakdown of output tokens by category.
Breakdown of output tokens by category.
output_tokens remains the inclusive, authoritative total used for billing.
This object provides a read-only decomposition for observability — for example,
how many of the billed output tokens were spent on internal reasoning that may
have been summarized before being returned to you.
The number of server tool requests.
If the request used the priority, standard, or batch tier.
The inference speed mode used for this request.
class UserLocation { $type = 'approximate'; $city; $country; /* 2 more */ }
The city of the user.
The two letter ISO country code of the user.
The region of the user.
The IANA timezone of the user.
class UserMessageParam { $content; $role; }
class WebFetchBlock { $type = 'web_fetch_result'; $content; $retrievedAt; $url; }
ISO 8601 timestamp when the content was retrieved
Fetched content URL
class WebFetchBlockParam { $type = 'web_fetch_result'; $content; $url; $retrievedAt; }
Fetched content URL
ISO 8601 timestamp when the content was retrieved
class WebFetchTool20250910 { $type = 'web_fetch_20250910'; $name; $allowedCallers; /* 9 more */ }
class WebFetchTool20260209 { $type = 'web_fetch_20260209'; $name; $allowedCallers; /* 9 more */ }
class WebFetchTool20260309 { $type = 'web_fetch_20260309'; $name; $allowedCallers; /* 10 more */ }
class WebFetchTool20260318 { $type = 'web_fetch_20260318'; $name; $allowedCallers; /* 11 more */ }
class WebFetchToolResultBlock { $type = 'web_fetch_tool_result'; $caller; $content; $toolUseID; }
class WebFetchToolResultBlockParam { $type = 'web_fetch_tool_result'; $content; $toolUseID; /* 2 more */ }
Create a cache control breakpoint at this content block.
class WebFetchToolResultErrorBlock { $type = 'web_fetch_tool_result_error'; $errorCode; }
class WebFetchToolResultErrorBlockParam { $type = 'web_fetch_tool_result_error'; $errorCode; }
class WebFetchURLSourceAll { $type = 'all'; }
class WebFetchURLSourceExcept { $type = 'except'; $tools; }
class WebFetchURLSourceNone { $type = 'none'; }
class WebFetchURLSourceOnly { $type = 'only'; $tools; }
class WebFetchURLSourceToolReference { $type = 'tool_reference'; $name; }
class WebFetchURLSources { $clientToolResults; $serverToolResults; $userInput; }
Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[].
Which server tools' results contribute fetchable URLs: "all", "none", or an only or except list of server tool names from tools[]; only web_search and web_fetch results ever contribute.
Whether URLs in user messages are fetchable: "all" or "none".
class WebSearchResultBlock { $type = 'web_search_result'; $encryptedContent; $pageAge; /* 2 more */ }
class WebSearchResultBlockParam { $type = 'web_search_result'; $encryptedContent; $title; /* 2 more */ }
class WebSearchTool20250305 { $type = 'web_search_20250305'; $name; $allowedCallers; /* 7 more */ }
"web_search" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
Parameters for the user's location. Used to provide more relevant search results.
class WebSearchTool20260209 { $type = 'web_search_20260209'; $name; $allowedCallers; /* 7 more */ }
"web_search" nameName of the tool.
Name of the tool.
This is how the tool will be called by the model and in tool_use blocks.
If provided, only these domains will be included in results. Cannot be used alongside blocked_domains.
If provided, these domains will never appear in results. Cannot be used alongside allowed_domains.
Create a cache control breakpoint at this content block.
If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.
Maximum number of times the tool can be used in the API request.
When true, guarantees schema validation on tool names and inputs
Parameters for the user's location. Used to provide more relevant search results.
class WebSearchTool20260318 { $type = 'web_search_20260318'; $name; $allowedCallers; /* 8 more */ }
class WebSearchToolRequestError { $type = 'web_search_tool_result_error'; $errorCode; }
class WebSearchToolResultBlock { $type = 'web_search_tool_result'; $caller; $content; $toolUseID; }
class WebSearchToolResultError { $type = 'web_search_tool_result_error'; $errorCode; }
class list<WebSearchResultBlock> { $type = 'web_search_result'; $encryptedContent; $pageAge; /* 2 more */ }
class WebSearchToolResultBlockParam { $type = 'web_search_tool_result'; $content; $toolUseID; /* 2 more */ }
Create a cache control breakpoint at this content block.
class list<WebSearchResultBlockParam> { $type = 'web_search_result'; $encryptedContent; $title; /* 2 more */ }
class WebSearchToolRequestError { $type = 'web_search_tool_result_error'; $errorCode; }
class WebSearchToolResultError { $type = 'web_search_tool_result_error'; $errorCode; }
СообщенияПакеты
Создать пакет сообщений
$client->messages->batches->create(list<Request> requests, ?string userProfileID, ?string workspaceID): MessageBatchОтправьте пакет запросов на создание сообщений.
Получить пакет сообщений
$client->messages->batches->retrieve(string messageBatchID, ?string workspaceID): MessageBatchЭта конечная точка идемпотентна и может использоваться для опроса завершения пакета сообщений. Чтобы получить доступ к результатам пакета сообщений, выполните запрос по адресу, указанному в поле results_url ответа.
Список пакетов сообщений
$client->messages->batches->list(?string afterID, ?string beforeID, ?int limit, ?string workspaceID): Page<MessageBatch>Получите список всех пакетов сообщений в рабочем пространстве. Последние созданные пакеты возвращаются первыми.
Отменить пакет сообщений
$client->messages->batches->cancel(string messageBatchID, ?string workspaceID): MessageBatchПакеты можно отменить в любой момент до окончания обработки. После инициирования отмены пакет переходит в состояние canceling, в котором система может завершить все выполняющиеся непрерываемые запросы перед окончательной отменой.
Удалить пакет сообщений
$client->messages->batches->delete(string messageBatchID, ?string workspaceID): DeletedMessageBatchУдалите пакет сообщений.
Получить результаты пакета сообщений
$client->messages->batches->resultsStream(string messageBatchID, ?string workspaceID): BaseStream<MessageBatchIndividualResponse>Передаёт результаты пакета сообщений в потоковом режиме в виде файла .jsonl.