--- title: Messages url: https://platform.claude.com/docs/en/api/go/beta/messages --- # Messages ## Create a Message `client.Beta.Messages.New(ctx, params) (*BetaMessage, error)` **POST** `/v1/messages` Send a structured list of input messages with text and/or image content, and the model will generate the next message in the conversation. The Messages API can be used for either single queries or stateless multi-turn conversations. Learn more about the Messages API in our [user guide](https://platform.claude.com/docs/en/get-started?sdk_languages=go) ### Parameters - `params BetaMessageNewParams` - `MaxTokens int64` The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=go) for details. minimum: 0 - `Messages []BetaMessageParam` Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=go#prefill-not-supported). Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude, for models that support prefill: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=go). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=go#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `Content []BetaContentBlockParamUnion` - `[]BetaContentBlockParamUnion` - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` - `type BetaRequestDocumentBlockParam` - `Type Document` - `Source BetaRequestDocumentBlockSourceUnionParam` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `type BetaContentBlockSourceParam` - `Type Content` - `Content BetaContentBlockSourceContentUnionParam` - `string` - `[]BetaContentBlockSourceContentUnionParam` - `type BetaTextBlockParam` - `type BetaImageBlockParam` - `type BetaURLPDFSourceParam` - `Type URL` - `URL string` - `type BetaFileDocumentSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `Enabled bool Optional` - `Context string Optional` minLength: 1 - `Title string Optional` minLength: 1, maxLength: 500 - `type BetaSearchResultBlockParam` - `Type SearchResult` - `Content []BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `Source string` - `Title string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `type BetaThinkingBlockParam` - `Type Thinking` - `Signature string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `Thinking string` The `thinking` text of this block as returned by the API. - `type BetaRedactedThinkingBlockParam` - `Type RedactedThinking` - `Data string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `type BetaToolUseBlockParam` - `Type ToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1, maxLength: 200 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaToolResultBlockParam` - `Type ToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content []BetaToolResultBlockParamContentUnion Optional` - `[]BetaToolResultBlockParamContentUnion` - `type BetaTextBlockParam` - `type BetaImageBlockParam` - `type BetaSearchResultBlockParam` - `type BetaRequestDocumentBlockParam` - `type BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `Type BrowserState` - `Tabs []BetaBrowserStateTabEntryParam` 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`. maxItems: 100 - `TabID string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Title string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Active bool Optional` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `StateChanges []BetaBrowserStateChangeUnionParam Optional` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `type BetaBrowserStateChangeTabOpenedParam` 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. - `Type TabOpened` - `TabID string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadStartedParam` A file download that started during this call. - `Type DownloadStarted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadCompletedParam` 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). - `Type DownloadCompleted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Path string Optional` 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. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `SizeBytes int64 Optional` The completed download's size. minimum: 0 - `type BetaBrowserStateChangeDownloadFailedParam` A file download that failed — or was cancelled — during this call. - `Type DownloadFailed` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Error string Optional` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `IsError bool Optional` - `ToolsetName string Optional` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlockParam` - `Type ServerToolUse` - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `const BetaServerToolUseBlockParamNameWebSearch BetaServerToolUseBlockParamName = "web_search"` - `const BetaServerToolUseBlockParamNameWebFetch BetaServerToolUseBlockParamName = "web_fetch"` - `const BetaServerToolUseBlockParamNameCodeExecution BetaServerToolUseBlockParamName = "code_execution"` - `const BetaServerToolUseBlockParamNameBashCodeExecution BetaServerToolUseBlockParamName = "bash_code_execution"` - `const BetaServerToolUseBlockParamNameTextEditorCodeExecution BetaServerToolUseBlockParamName = "text_editor_code_execution"` - `const BetaServerToolUseBlockParamNameToolSearchToolRegex BetaServerToolUseBlockParamName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockParamNameToolSearchToolBm25 BetaServerToolUseBlockParamName = "tool_search_tool_bm25"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaServerToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlockParam` - `Type WebSearchToolResult` - `Content BetaWebSearchToolResultBlockParamContentUnion` - `[]BetaWebSearchResultBlockParam` - `Type WebSearchResult` - `EncryptedContent string` - `Title string` - `URL string` - `PageAge string Optional` - `type BetaWebSearchToolRequestErrorParam` - `Type WebSearchToolResultError` - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaWebSearchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlockParam` - `Type WebFetchToolResult` - `Content BetaWebFetchToolResultBlockParamContentUnion` - `type BetaWebFetchToolResultErrorBlockParam` - `Type WebFetchToolResultError` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlockParam` - `Type WebFetchResult` - `Content BetaRequestDocumentBlockParam` - `URL string` Fetched content URL - `RetrievedAt string Optional` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlockParam` - `Type AdvisorToolResult` - `Content BetaAdvisorToolResultBlockParamContentUnion` - `type BetaAdvisorToolResultErrorParam` - `Type AdvisorToolResultError` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodeModelNotFound BetaAdvisorToolResultErrorParamErrorCode = "model_not_found"` - `type BetaAdvisorResultBlockParam` - `Type AdvisorResult` - `Text string` - `StopReason string Optional` - `type BetaAdvisorRedactedResultBlockParam` - `Type AdvisorRedactedResult` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `StopReason string Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaCodeExecutionToolResultBlockParam` - `Type CodeExecutionToolResult` - `Content BetaCodeExecutionToolResultBlockParamContentUnion` - `type BetaCodeExecutionToolResultErrorParam` - `Type CodeExecutionToolResultError` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlockParam` - `Type CodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaBashCodeExecutionToolResultBlockParam` - `Type BashCodeExecutionToolResult` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnion` - `type BetaBashCodeExecutionToolResultErrorParam` - `Type BashCodeExecutionToolResultError` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorParamErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlockParam` - `Type BashCodeExecutionResult` - `Content []BetaBashCodeExecutionOutputBlockParam` - `Type BashCodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaTextEditorCodeExecutionToolResultBlockParam` - `Type TextEditorCodeExecutionToolResult` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnion` - `type BetaTextEditorCodeExecutionToolResultErrorParam` - `Type TextEditorCodeExecutionToolResultError` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "file_not_found"` - `ErrorMessage string Optional` - `type BetaTextEditorCodeExecutionViewResultBlockParam` - `Type TextEditorCodeExecutionViewResult` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `NumLines int64 Optional` - `StartLine int64 Optional` - `TotalLines int64 Optional` - `type BetaTextEditorCodeExecutionCreateResultBlockParam` - `Type TextEditorCodeExecutionCreateResult` - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `Type TextEditorCodeExecutionStrReplaceResult` - `Lines []string Optional` - `NewLines int64 Optional` - `NewStart int64 Optional` - `OldLines int64 Optional` - `OldStart int64 Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaToolSearchToolResultBlockParam` - `Type ToolSearchToolResult` - `Content BetaToolSearchToolResultBlockParamContentUnion` - `type BetaToolSearchToolResultErrorParam` - `Type ToolSearchToolResultError` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `ErrorMessage string Optional` - `type BetaToolSearchToolSearchResultBlockParam` - `Type ToolSearchToolSearchResult` - `ToolReferences []BetaToolReferenceBlockParam` - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaMCPToolUseBlockParam` - `Type MCPToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestMCPToolResultBlockParam` - `Type MCPToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content BetaRequestMCPToolResultBlockParamContentUnion Optional` - `string` - `[]BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `IsError bool Optional` - `type BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `Type ContainerUpload` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `Type Compaction` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content string Optional` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string Optional` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` The block's signature as returned, to be sent back verbatim - `ToolChanges []BetaCompactionBlockParamToolChangeUnion Optional` The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block. - `type BetaRequestToolAdditionBlockParam` 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 ToolAddition` - `Tool BetaRequestToolAdditionBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `Type ToolReference` - `Name string` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `Type MCPToolReference` - `Name string` - `ServerName string` - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `Type MCPToolsetReference` - `ServerName string` - `type BetaToolChangeToolDefinitionParam` 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. - `Type ToolDefinition` - `Definition BetaToolUnionParam` - `type BetaToolParam` - `Type BetaToolType Optional` - `InputSchema BetaToolInputSchemaParam` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `const BetaToolAllowedCallerCodeExecution20260521 BetaToolAllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestToolRemovalBlockParam` 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 ToolRemoval` - `Tool BetaRequestToolRemovalBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestToolAdditionBlockParam` 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` 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 BetaMCPToolListingBlockParam` 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. - `Type MCPToolListing` - `MCPServerName string` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `Tools []BetaMCPToolParam` The server's tools, exactly as the response listed them. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `Type Fallback` - `From BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Trigger any Optional` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `Role BetaMessageParamRole` - `const BetaMessageParamRoleUser BetaMessageParamRole = "user"` - `const BetaMessageParamRoleAssistant BetaMessageParamRole = "assistant"` - `const BetaMessageParamRoleSystem BetaMessageParamRole = "system"` - `ClearAt BetaMessageParamClearAt Optional` How long this system message's text stays in front of the model. `"never"` (the default) renders it on every request that includes it. `"next_user_message"` renders it only for the user turn it follows: once a later `role: "user"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: "system"` messages. - `const BetaMessageParamClearAtNextUserMessage BetaMessageParamClearAt = "next_user_message"` - `const BetaMessageParamClearAtNever BetaMessageParamClearAt = "never"` - `OutputConfig BetaSystemMessageOutputConfigParam Optional` 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 Optional` 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`. - `const BetaSystemMessageOutputConfigEffortLow BetaSystemMessageOutputConfigEffort = "low"` - `const BetaSystemMessageOutputConfigEffortMedium BetaSystemMessageOutputConfigEffort = "medium"` - `const BetaSystemMessageOutputConfigEffortHigh BetaSystemMessageOutputConfigEffort = "high"` - `const BetaSystemMessageOutputConfigEffortXhigh BetaSystemMessageOutputConfigEffort = "xhigh"` - `const BetaSystemMessageOutputConfigEffortMax BetaSystemMessageOutputConfigEffort = "max"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CacheControl BetaCacheControlEphemeralParam Optional` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `Compaction BetaCompactionConfigParam Optional` Compaction configuration. When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`. - `Container BetaMessageNewParamsContainerUnion Optional` Container identifier for reuse across requests. - `type BetaContainerParams` Container parameters with skills to be loaded. - `ID string Optional` Container id - `Skills []BetaSkillParams Optional` List of skills to load in the container maxItems: 20 - `Type BetaSkillParamsType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillParamsTypeAnthropic BetaSkillParamsType = "anthropic"` - `const BetaSkillParamsTypeCustom BetaSkillParamsType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string Optional` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 - `string` - `ContextManagement BetaContextManagementConfigParam Optional` Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `Diagnostics BetaDiagnosticsParam Optional` Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request. - `FallbackCreditToken BetaMessageNewParamsFallbackCreditTokenUnion Optional` The `fallback_credit_token` from a prior refusal's `stop_details`. When a preceding request was refused and returned a `fallback_credit_token`, pass that code here on the retry to have the retry's cache-creation tokens for the prefix that was warm on the refused model billed at the cache-read rate. Must be redeemed by the same organization and workspace, with the same request body (optionally extended by one appended `assistant` message whose content is the partial text — with any trailing whitespace stripped from the final text block — and paired server-tool blocks streamed before the refusal; the appended-assistant form is not available for requests with `output_format` set or forced `tool_choice`), on an eligible fallback model, on the same platform, and within 5 minutes of the refusal; a mismatch is a 400. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed with the appended-assistant form — if an exact-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry with the appended-assistant form instead. When the appended-assistant form is used on a model that otherwise disallows assistant-turn prefill, this token also authorizes that one prefill. - `string` - `type BetaFallbackCreditTokenParam` Object form of `fallback_credit_token`: the token plus a redemption mode. Requires `anthropic-beta: fallback-credit-2026-07-01`; without that header the field accepts the bare string only. The bare string and the mode-less object are equivalent (both select `strict`), so wrapping an existing token changes nothing by itself. - `Token string` The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries. minLength: 1, maxLength: 2048 - `Mode BetaFallbackCreditTokenParamMode Optional` 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`. - `const BetaFallbackCreditTokenParamModeStrict BetaFallbackCreditTokenParamMode = "strict"` - `const BetaFallbackCreditTokenParamModeBestEffort BetaFallbackCreditTokenParamMode = "best_effort"` - `Fallbacks BetaFallbacksParamUnion Optional` 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](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=go#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. - `InferenceGeo param.Opt[string] Optional` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `MCPServers []BetaRequestMCPServerURLDefinitionParam Optional` MCP servers to be utilized in this request maxItems: 20 - `Type URL` - `Name string` - `URL string` - `AuthorizationToken string Optional` - `ToolConfiguration BetaRequestMCPServerToolConfigurationParam Optional` - `AllowedTools []string Optional` - `Enabled bool Optional` - `Metadata BetaMetadataParam Optional` An object describing metadata about the request. - `OutputConfig BetaOutputConfigParam Optional` Configuration options for the model's output, such as the output format. - `ServiceTier BetaMessageNewParamsServiceTier Optional` Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers?sdk_languages=go) for details. - `const BetaMessageNewParamsServiceTierAuto BetaMessageNewParamsServiceTier = "auto"` - `const BetaMessageNewParamsServiceTierStandardOnly BetaMessageNewParamsServiceTier = "standard_only"` - `Speed BetaMessageNewParamsSpeed Optional` The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. Some models require the `fast-mode-2026-02-01` beta header for any `speed` value. See [fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode?sdk_languages=go) for which models. - `const BetaMessageNewParamsSpeedStandard BetaMessageNewParamsSpeed = "standard"` - `const BetaMessageNewParamsSpeedFast BetaMessageNewParamsSpeed = "fast"` - `StopSequences []string Optional` Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. - `System []BetaTextBlockParam Optional` System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=go#give-claude-a-role). - `[]BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `Thinking BetaThinkingConfigParamUnion Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#configuring-thinking) for each model's behavior. - `ToolChoice BetaToolChoiceUnionParam Optional` 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. - `Tools []BetaToolUnionParam Optional` Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=go), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=go)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=go) for more details. - `type BetaToolParam` - `type BetaToolBash20241022` - `type BetaToolBash20250124` - `type BetaCodeExecutionTool20250522` - `type BetaCodeExecutionTool20250825` - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type BetaToolComputerUse20241022` - `type BetaMemoryTool20250818` - `type BetaToolComputerUse20250124` - `type BetaToolTextEditor20241022` - `type BetaToolComputerUse20251124` - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type BetaToolTextEditor20250124` - `type BetaToolTextEditor20250429` - `type BetaToolTextEditor20250728` - `type BetaWebSearchTool20250305` - `type BetaWebFetchTool20250910` - `type BetaWebSearchTool20260209` - `type BetaWebFetchTool20260209` - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `type BetaWebSearchTool20260318` - `type BetaWebFetchTool20260318` - `type BetaAdvisorTool20260301` - `type BetaToolSearchToolBm25_20251119` - `type BetaToolSearchToolRegex20251119` - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Betas []AnthropicBeta Optional` (header parameter) Optional header to specify the beta version(s) you want to use. - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` - `const AnthropicBetaUserProfiles2026_09_04 AnthropicBeta = "user-profiles-2026-09-04"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` - `const AnthropicBetaMidConversationOutputConfig2026_07_01 AnthropicBeta = "mid-conversation-output-config-2026-07-01"` - `const AnthropicBetaThinkingBindingControls2026_08_01 AnthropicBeta = "thinking-binding-controls-2026-08-01"` - `const AnthropicBetaMidConversationSystemClearAt2026_08_21 AnthropicBeta = "mid-conversation-system-clear-at-2026-08-21"` - `const AnthropicBetaCompact2026_09_04 AnthropicBeta = "compact-2026-09-04"` - `const AnthropicBetaInlineTools2026_09_15 AnthropicBeta = "inline-tools-2026-09-15"` - `const AnthropicBetaMCPClient2026_09_15 AnthropicBeta = "mcp-client-2026-09-15"` - `const AnthropicBetaCEPlugins2026_09_01 AnthropicBeta = "ce-plugins-2026-09-01"` - `const AnthropicBetaSpendLimitReads2026_09_26 AnthropicBeta = "spend-limit-reads-2026-09-26"` - `const AnthropicBetaTelemetryDestinations2026_08_11 AnthropicBeta = "telemetry-destinations-2026-08-11"` - `UserProfileID param.Opt[string] Optional` (header parameter) The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. - `WorkspaceID param.Opt[string] Optional` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `OutputFormat BetaJSONOutputFormatParam Optional` **Deprecated** Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=go) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `Temperature param.Opt[float64] Optional` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. minimum: 0, maximum: 1 - `TopK param.Opt[int64] Optional` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error. Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. minimum: 0 - `TopP param.Opt[float64] Optional` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. minimum: 0, maximum: 1 ### Returns - `type BetaMessage` - `Type Message` Object type. For Messages, this is always `"message"`. default: message - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. format: date-time - `Skills []BetaContainerSkill` Skills loaded in the container - `Type BetaContainerSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaContainerSkillTypeAnthropic BetaContainerSkillType = "anthropic"` - `const BetaContainerSkillTypeCustom BetaContainerSkillType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `Text string` - `type BetaThinkingBlock` - `Type Thinking` default: thinking - `Signature string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. - `Thinking string` The text of Claude's thinking process for this block. - `type BetaRedactedThinkingBlock` - `Type RedactedThinking` default: redacted_thinking - `Data string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go#redacted-thinking-blocks) for details. - `type BetaToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1 - `Caller BetaToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlock` - `Type ServerToolUse` default: server_tool_use - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"` - `const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"` - `const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"` - `const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"` - `const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"` - `const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"` - `Caller BetaServerToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlock` - `Type WebSearchToolResult` default: web_search_tool_result - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError` - `Type WebSearchToolResultError` default: web_search_tool_result_error - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `[]BetaWebSearchResultBlock` - `Type WebSearchResult` default: web_search_result - `EncryptedContent string` - `PageAge string` - `Title string` - `URL string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebSearchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlock` - `Type WebFetchToolResult` default: web_fetch_tool_result - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock` - `Type WebFetchToolResultError` default: web_fetch_tool_result_error - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlock` - `Type WebFetchResult` default: web_fetch_result - `Content BetaDocumentBlock` - `Type Document` default: document - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` default: false - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `Title string` The title of the document - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `URL string` Fetched content URL - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebFetchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlock` - `Type AdvisorToolResult` default: advisor_tool_result - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError` - `Type AdvisorToolResultError` default: advisor_tool_result_error - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodeModelNotFound BetaAdvisorToolResultErrorErrorCode = "model_not_found"` - `type BetaAdvisorResultBlock` - `Type AdvisorResult` default: advisor_result - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `type BetaAdvisorRedactedResultBlock` - `Type AdvisorRedactedResult` default: advisor_redacted_result - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaCodeExecutionToolResultBlock` - `Type CodeExecutionToolResult` default: code_execution_tool_result - `Content BetaCodeExecutionToolResultBlockContentUnion` - `type BetaCodeExecutionToolResultError` - `Type CodeExecutionToolResultError` default: code_execution_tool_result_error - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlock` - `Type CodeExecutionResult` default: code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` default: encrypted_code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaBashCodeExecutionToolResultBlock` - `Type BashCodeExecutionToolResult` default: bash_code_execution_tool_result - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError` - `Type BashCodeExecutionToolResultError` default: bash_code_execution_tool_result_error - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlock` - `Type BashCodeExecutionResult` default: bash_code_execution_result - `Content []BetaBashCodeExecutionOutputBlock` - `Type BashCodeExecutionOutput` default: bash_code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaTextEditorCodeExecutionToolResultBlock` - `Type TextEditorCodeExecutionToolResult` default: text_editor_code_execution_tool_result - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError` - `Type TextEditorCodeExecutionToolResultError` default: text_editor_code_execution_tool_result_error - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlock` - `Type TextEditorCodeExecutionViewResult` default: text_editor_code_execution_view_result - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlock` - `Type TextEditorCodeExecutionCreateResult` default: text_editor_code_execution_create_result - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock` - `Type TextEditorCodeExecutionStrReplaceResult` default: text_editor_code_execution_str_replace_result - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaToolSearchToolResultBlock` - `Type ToolSearchToolResult` default: tool_search_tool_result - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError` - `Type ToolSearchToolResultError` default: tool_search_tool_result_error - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"` - `ErrorMessage string` - `type BetaToolSearchToolSearchResultBlock` - `Type ToolSearchToolSearchResult` default: tool_search_tool_search_result - `ToolReferences []BetaToolReferenceBlock` - `Type ToolReference` default: tool_reference - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaMCPToolUseBlock` - `Type MCPToolUse` default: mcp_tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` The name of the MCP tool - `ServerName string` The name of the MCP server - `type BetaMCPToolResultBlock` - `Type MCPToolResult` default: mcp_tool_result - `Content BetaMCPToolResultBlockContentUnion` - `string` - `[]BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `Text string` - `IsError bool` default: false - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `type BetaContainerUploadBlock` Response model for a file uploaded to the container. - `Type ContainerUpload` default: container_upload - `FileID string` - `type BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `Type Compaction` default: compaction - `Content string` Summary of compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` Signature over the summary, to be sent back with the block verbatim - `ToolChanges []BetaCompactionBlockToolChangeUnion Optional` 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` 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 ToolAddition` default: tool_addition - `Tool BetaResponseToolAdditionBlockToolUnion` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `type BetaResponseToolChangeToolReference` 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` default: tool_reference - `Name string` - `type BetaResponseToolChangeMCPToolReference` 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` default: mcp_tool_reference - `Name string` - `ServerName string` - `type BetaResponseToolChangeMCPToolsetReference` 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` default: mcp_toolset_reference - `ServerName string` - `type BetaToolChangeToolDefinition` 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` default: tool_definition - `Definition BetaResponseToolUnion` - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaResponseToolRemovalBlock` 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 ToolRemoval` default: tool_removal - `Tool BetaResponseToolRemovalBlockToolUnion` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `type BetaResponseToolChangeToolReference` 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 BetaResponseToolChangeMCPToolReference` 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 BetaResponseToolChangeMCPToolsetReference` 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 BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `Type Fallback` default: fallback - `From BetaFallbackInfo` The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `Trigger BetaFallbackRefusalTrigger` What caused the `from` model to hand over at this hop. - `Type Refusal` default: refusal - `Category BetaFallbackRefusalTriggerCategory` 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`. - `const BetaFallbackRefusalTriggerCategoryCyber BetaFallbackRefusalTriggerCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryBio BetaFallbackRefusalTriggerCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryFrontierLLM BetaFallbackRefusalTriggerCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryReasoningExtraction BetaFallbackRefusalTriggerCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaFallbackRefusalTriggerCategoryGeneralHarms BetaFallbackRefusalTriggerCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `type BetaMCPToolListingBlock` 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` default: mcp_tool_listing - `MCPServerName string` - `Tools []BetaMCPTool` - `InputSchema map[string, any]` - `Name string` - `Description string Optional` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `type BetaClearToolUses20250919EditResponse` - `Type ClearToolUses20250919` The type of context management edit applied. default: clear_tool_uses_20250919 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedToolUses int64` Number of tool uses that were cleared. minimum: 0 - `type BetaClearThinking20251015EditResponse` - `Type ClearThinking20251015` The type of context management edit applied. default: clear_thinking_20251015 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedThinkingTurns int64` Number of thinking turns that were cleared. minimum: 0 - `Diagnostics BetaDiagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `CacheMissReason BetaCacheMissReasonUnion` 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 BetaCacheMissModelChanged` - `Type ModelChanged` default: model_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissSystemChanged` - `Type SystemChanged` default: system_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissToolsChanged` - `Type ToolsChanged` default: tools_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissMessagesChanged` - `Type MessagesChanged` default: messages_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissPreviousMessageNotFound` - `Type PreviousMessageNotFound` default: previous_message_not_found - `type BetaCacheMissUnavailable` - `Type Unavailable` default: unavailable - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `StopDetails BetaRefusalStopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `Type Refusal` default: refusal - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaRefusalStopDetailsCategoryFrontierLLM BetaRefusalStopDetailsCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaRefusalStopDetailsCategoryReasoningExtraction BetaRefusalStopDetailsCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaRefusalStopDetailsCategoryGeneralHarms BetaRefusalStopDetailsCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `FallbackCreditToken string` Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit. - `FallbackHasPrefillClaim bool` Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token. - `RecommendedModel string` The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise. - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Usage BetaUsage` 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`. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. minimum: 0 - `FallbackCredit BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `Status BetaFallbackCreditUsageStatusUnion` 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` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `Type Redeemed` default: redeemed - `type BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `Type NotApplied` default: not_applied - `Reason BetaFallbackCreditNotAppliedReason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `const BetaFallbackCreditNotAppliedReasonBodyMismatch BetaFallbackCreditNotAppliedReason = "body_mismatch"` - `const BetaFallbackCreditNotAppliedReasonContinuationExcluded BetaFallbackCreditNotAppliedReason = "continuation_excluded"` - `const BetaFallbackCreditNotAppliedReasonContinuationOnly BetaFallbackCreditNotAppliedReason = "continuation_only"` - `const BetaFallbackCreditNotAppliedReasonExpired BetaFallbackCreditNotAppliedReason = "expired"` - `const BetaFallbackCreditNotAppliedReasonInvalidTargetModel BetaFallbackCreditNotAppliedReason = "invalid_target_model"` - `const BetaFallbackCreditNotAppliedReasonNotEnabled BetaFallbackCreditNotAppliedReason = "not_enabled"` - `const BetaFallbackCreditNotAppliedReasonRepriceUnavailable BetaFallbackCreditNotAppliedReason = "reprice_unavailable"` - `const BetaFallbackCreditNotAppliedReasonTemporarilyUnavailable BetaFallbackCreditNotAppliedReason = "temporarily_unavailable"` - `const BetaFallbackCreditNotAppliedReasonVariantFieldsPresent BetaFallbackCreditNotAppliedReason = "variant_fields_present"` - `const BetaFallbackCreditNotAppliedReasonWrongOrganization BetaFallbackCreditNotAppliedReason = "wrong_organization"` - `const BetaFallbackCreditNotAppliedReasonWrongPlatform BetaFallbackCreditNotAppliedReason = "wrong_platform"` - `const BetaFallbackCreditNotAppliedReasonWrongWorkspace BetaFallbackCreditNotAppliedReason = "wrong_workspace"` - `RemoveToRedeem []string Optional` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Iterations BetaIterationsUsage` 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 `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `type BetaMessageIterationUsage` Token usage for a sampling iteration. - `Type Message` Usage for a sampling iteration default: message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaCompactionIterationUsage` Token usage for a compaction iteration. - `Type Compaction` Usage for a compaction iteration default: compaction - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration default: advisor_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaFallbackMessageIterationUsage` 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 FallbackMessage` Usage for the fallback-model attempt that served the response default: fallback_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokensDetails BetaOutputTokensDetails` 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. - `ThinkingTokens int64` 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. default: 0, minimum: 0 - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. default: 0, minimum: 0 - `WebSearchRequests int64` The number of web search tool requests. default: 0, minimum: 0 - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` - `InputTransformations []BetaInputTransformationUnion Optional` Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`. - `type BetaThinkingDroppedInputTransformation` - `Type ThinkingDropped` Always `thinking_dropped` for this entry type. default: thinking_dropped - `Path string` 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 BetaThinkingDroppedInputTransformationReason` 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`. - `const BetaThinkingDroppedInputTransformationReasonModelBindingMismatch BetaThinkingDroppedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonPrefixBindingMismatch BetaThinkingDroppedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonOrganizationBindingMismatch BetaThinkingDroppedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonEndUserBindingMismatch BetaThinkingDroppedInputTransformationReason = "end_user_binding_mismatch"` - `type BetaThinkingMismatchAllowedInputTransformation` - `Type ThinkingMismatchAllowed` Always `thinking_mismatch_allowed` for this entry type. default: thinking_mismatch_allowed - `Path string` 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 BetaThinkingMismatchAllowedInputTransformationReason` 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. - `const BetaThinkingMismatchAllowedInputTransformationReasonModelBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonPrefixBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonOrganizationBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonEndUserBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "end_user_binding_mismatch"` - `type BetaRawMessageStreamEventUnion interface{…}` - `type BetaRawMessageStartEvent` - `Type MessageStart` default: message_start - `Message BetaMessage` - `type BetaRawMessageDeltaEvent` - `Type MessageDelta` default: message_delta - `ContextManagement BetaContextManagementResponse` Information about context management strategies applied during the request - `Delta BetaRawMessageDeltaEventDelta` - `Container BetaContainer` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `StopDetails BetaRefusalStopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `StopReason BetaStopReason` - `StopSequence string` - `Usage BetaMessageDeltaUsage` 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`. - `CacheCreationInputTokens int64` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `CacheReadInputTokens int64` The cumulative number of input tokens read from the cache. minimum: 0 - `FallbackCredit BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `InputTokens int64` The cumulative number of input tokens which were used. minimum: 0 - `Iterations BetaIterationsUsage` 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 `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `OutputTokens int64` The cumulative number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` 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. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `InputTransformations []BetaInputTransformationUnion Optional` Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`. - `type BetaThinkingDroppedInputTransformation` - `type BetaThinkingMismatchAllowedInputTransformation` - `type BetaRawMessageStopEvent` - `Type MessageStop` default: message_stop - `type BetaRawContentBlockStartEvent` - `Type ContentBlockStart` default: content_block_start - `ContentBlock BetaRawContentBlockStartEventContentBlockUnion` - `type BetaTextBlock` - `type BetaThinkingBlock` - `type BetaRedactedThinkingBlock` - `type BetaToolUseBlock` - `type BetaServerToolUseBlock` - `type BetaWebSearchToolResultBlock` - `type BetaWebFetchToolResultBlock` - `type BetaAdvisorToolResultBlock` - `type BetaCodeExecutionToolResultBlock` - `type BetaBashCodeExecutionToolResultBlock` - `type BetaTextEditorCodeExecutionToolResultBlock` - `type BetaToolSearchToolResultBlock` - `type BetaMCPToolUseBlock` - `type BetaMCPToolResultBlock` - `type BetaContainerUploadBlock` Response model for a file uploaded to the container. - `type BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `type BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `type BetaMCPToolListingBlock` 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. - `Index int64` - `type BetaRawContentBlockDeltaEvent` - `Type ContentBlockDelta` default: content_block_delta - `Delta BetaRawContentBlockDeltaUnion` - `type BetaTextDelta` - `Type TextDelta` default: text_delta - `Text string` - `type BetaInputJSONDelta` - `Type InputJSONDelta` default: input_json_delta - `PartialJSON string` - `type BetaCitationsDelta` - `Type CitationsDelta` default: citations_delta - `Citation BetaCitationsDeltaCitationUnion` - `type BetaCitationCharLocation` - `type BetaCitationPageLocation` - `type BetaCitationContentBlockLocation` - `type BetaCitationsWebSearchResultLocation` - `type BetaCitationSearchResultLocation` - `type BetaThinkingDelta` - `Type ThinkingDelta` default: thinking_delta - `EstimatedTokens int64` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `Thinking string` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `type BetaSignatureDelta` - `Type SignatureDelta` default: signature_delta - `Signature string` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `type BetaCompactionContentBlockDelta` - `Type CompactionDelta` default: compaction_delta - `Content string` - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Index int64` - `type BetaRawContentBlockStopEvent` - `Type ContentBlockStop` default: content_block_stop - `Index int64` ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaMessage, err := client.Beta.Messages.New(context.TODO(), anthropic.BetaMessageNewParams{ MaxTokens: 1024, Messages: []anthropic.BetaMessageParam{anthropic.BetaMessageParam{ Content: []anthropic.BetaContentBlockParamUnion{anthropic.BetaContentBlockParamUnion{ OfText: &anthropic.BetaTextBlockParam{ Text: "x", }, }}, Role: anthropic.BetaMessageParamRoleUser, }}, Model: anthropic.ModelClaudeOpus5_5, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaMessage.ID) } ``` #### Response (200) ```json { "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF", "container": { "id": "container_011CpZohnwH4vuy7gazohgSP", "expires_at": "2019-12-27T18:11:19.117Z", "skills": [ { "skill_id": "pdf", "type": "anthropic", "version": "latest" } ] }, "content": [ { "citations": [ { "cited_text": "The grass is green. The sky is blue.", "document_index": 0, "document_title": "My Document", "end_char_index": 0, "file_id": "file_011CNha8iCJcU1wXNR6q4V8w", "start_char_index": 0, "type": "char_location" } ], "text": "Hi! My name is Claude.", "type": "text" } ], "context_management": { "applied_edits": [ { "cleared_input_tokens": 0, "cleared_tool_uses": 0, "type": "clear_tool_uses_20250919" } ] }, "diagnostics": { "cache_miss_reason": { "cache_missed_input_tokens": 0, "type": "model_changed" } }, "model": "claude-opus-5-5", "role": "assistant", "stop_details": { "category": "cyber", "explanation": "This request was declined because it conflicts with Anthropic's Usage Policy.", "fallback_credit_token": "QW50aHJvcGljL0NsYXVkZQ==", "fallback_has_prefill_claim": true, "recommended_model": "claude-opus-4-8", "type": "refusal" }, "stop_reason": "end_turn", "stop_sequence": null, "type": "message", "usage": { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_creation_input_tokens": 2051, "cache_read_input_tokens": 2051, "fallback_credit": { "status": { "type": "redeemed" } }, "inference_geo": "global", "input_tokens": 2095, "iterations": [ { "cache_creation": { "ephemeral_1h_input_tokens": 0, "ephemeral_5m_input_tokens": 0 }, "cache_creation_input_tokens": 0, "cache_read_input_tokens": 0, "input_tokens": 0, "model": "claude-haiku-5-5", "output_tokens": 0, "type": "message" } ], "output_tokens": 503, "output_tokens_details": { "thinking_tokens": 0 }, "server_tool_use": { "web_fetch_requests": 2, "web_search_requests": 0 }, "service_tier": "standard", "speed": "standard" }, "input_transformations": [ { "path": "path", "reason": "model_binding_mismatch", "type": "thinking_dropped" } ] } ``` ## Count tokens in a Message `client.Beta.Messages.CountTokens(ctx, params) (*BetaMessageTokensCount, error)` **POST** `/v1/messages/count_tokens` Count the number of tokens in a Message. The Token Count API can be used to count the number of tokens in a Message, including tools, images, and documents, without creating it. Learn more about token counting in our [user guide](https://platform.claude.com/docs/en/build-with-claude/token-counting?sdk_languages=go) ### Parameters - `params BetaMessageCountTokensParams` - `Messages []BetaMessageParam` Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=go#prefill-not-supported). Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude, for models that support prefill: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=go). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=go#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `Content []BetaContentBlockParamUnion` - `[]BetaContentBlockParamUnion` - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` - `type BetaRequestDocumentBlockParam` - `Type Document` - `Source BetaRequestDocumentBlockSourceUnionParam` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `type BetaContentBlockSourceParam` - `Type Content` - `Content BetaContentBlockSourceContentUnionParam` - `string` - `[]BetaContentBlockSourceContentUnionParam` - `type BetaTextBlockParam` - `type BetaImageBlockParam` - `type BetaURLPDFSourceParam` - `Type URL` - `URL string` - `type BetaFileDocumentSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `Enabled bool Optional` - `Context string Optional` minLength: 1 - `Title string Optional` minLength: 1, maxLength: 500 - `type BetaSearchResultBlockParam` - `Type SearchResult` - `Content []BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `Source string` - `Title string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `type BetaThinkingBlockParam` - `Type Thinking` - `Signature string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `Thinking string` The `thinking` text of this block as returned by the API. - `type BetaRedactedThinkingBlockParam` - `Type RedactedThinking` - `Data string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `type BetaToolUseBlockParam` - `Type ToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1, maxLength: 200 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaToolResultBlockParam` - `Type ToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content []BetaToolResultBlockParamContentUnion Optional` - `[]BetaToolResultBlockParamContentUnion` - `type BetaTextBlockParam` - `type BetaImageBlockParam` - `type BetaSearchResultBlockParam` - `type BetaRequestDocumentBlockParam` - `type BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `Type BrowserState` - `Tabs []BetaBrowserStateTabEntryParam` 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`. maxItems: 100 - `TabID string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Title string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Active bool Optional` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `StateChanges []BetaBrowserStateChangeUnionParam Optional` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `type BetaBrowserStateChangeTabOpenedParam` 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. - `Type TabOpened` - `TabID string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadStartedParam` A file download that started during this call. - `Type DownloadStarted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadCompletedParam` 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). - `Type DownloadCompleted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Path string Optional` 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. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `SizeBytes int64 Optional` The completed download's size. minimum: 0 - `type BetaBrowserStateChangeDownloadFailedParam` A file download that failed — or was cancelled — during this call. - `Type DownloadFailed` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Error string Optional` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `IsError bool Optional` - `ToolsetName string Optional` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlockParam` - `Type ServerToolUse` - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `const BetaServerToolUseBlockParamNameWebSearch BetaServerToolUseBlockParamName = "web_search"` - `const BetaServerToolUseBlockParamNameWebFetch BetaServerToolUseBlockParamName = "web_fetch"` - `const BetaServerToolUseBlockParamNameCodeExecution BetaServerToolUseBlockParamName = "code_execution"` - `const BetaServerToolUseBlockParamNameBashCodeExecution BetaServerToolUseBlockParamName = "bash_code_execution"` - `const BetaServerToolUseBlockParamNameTextEditorCodeExecution BetaServerToolUseBlockParamName = "text_editor_code_execution"` - `const BetaServerToolUseBlockParamNameToolSearchToolRegex BetaServerToolUseBlockParamName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockParamNameToolSearchToolBm25 BetaServerToolUseBlockParamName = "tool_search_tool_bm25"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaServerToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlockParam` - `Type WebSearchToolResult` - `Content BetaWebSearchToolResultBlockParamContentUnion` - `[]BetaWebSearchResultBlockParam` - `Type WebSearchResult` - `EncryptedContent string` - `Title string` - `URL string` - `PageAge string Optional` - `type BetaWebSearchToolRequestErrorParam` - `Type WebSearchToolResultError` - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaWebSearchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlockParam` - `Type WebFetchToolResult` - `Content BetaWebFetchToolResultBlockParamContentUnion` - `type BetaWebFetchToolResultErrorBlockParam` - `Type WebFetchToolResultError` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlockParam` - `Type WebFetchResult` - `Content BetaRequestDocumentBlockParam` - `URL string` Fetched content URL - `RetrievedAt string Optional` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlockParam` - `Type AdvisorToolResult` - `Content BetaAdvisorToolResultBlockParamContentUnion` - `type BetaAdvisorToolResultErrorParam` - `Type AdvisorToolResultError` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodeModelNotFound BetaAdvisorToolResultErrorParamErrorCode = "model_not_found"` - `type BetaAdvisorResultBlockParam` - `Type AdvisorResult` - `Text string` - `StopReason string Optional` - `type BetaAdvisorRedactedResultBlockParam` - `Type AdvisorRedactedResult` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `StopReason string Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaCodeExecutionToolResultBlockParam` - `Type CodeExecutionToolResult` - `Content BetaCodeExecutionToolResultBlockParamContentUnion` - `type BetaCodeExecutionToolResultErrorParam` - `Type CodeExecutionToolResultError` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlockParam` - `Type CodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaBashCodeExecutionToolResultBlockParam` - `Type BashCodeExecutionToolResult` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnion` - `type BetaBashCodeExecutionToolResultErrorParam` - `Type BashCodeExecutionToolResultError` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorParamErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlockParam` - `Type BashCodeExecutionResult` - `Content []BetaBashCodeExecutionOutputBlockParam` - `Type BashCodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaTextEditorCodeExecutionToolResultBlockParam` - `Type TextEditorCodeExecutionToolResult` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnion` - `type BetaTextEditorCodeExecutionToolResultErrorParam` - `Type TextEditorCodeExecutionToolResultError` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "file_not_found"` - `ErrorMessage string Optional` - `type BetaTextEditorCodeExecutionViewResultBlockParam` - `Type TextEditorCodeExecutionViewResult` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `NumLines int64 Optional` - `StartLine int64 Optional` - `TotalLines int64 Optional` - `type BetaTextEditorCodeExecutionCreateResultBlockParam` - `Type TextEditorCodeExecutionCreateResult` - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `Type TextEditorCodeExecutionStrReplaceResult` - `Lines []string Optional` - `NewLines int64 Optional` - `NewStart int64 Optional` - `OldLines int64 Optional` - `OldStart int64 Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaToolSearchToolResultBlockParam` - `Type ToolSearchToolResult` - `Content BetaToolSearchToolResultBlockParamContentUnion` - `type BetaToolSearchToolResultErrorParam` - `Type ToolSearchToolResultError` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `ErrorMessage string Optional` - `type BetaToolSearchToolSearchResultBlockParam` - `Type ToolSearchToolSearchResult` - `ToolReferences []BetaToolReferenceBlockParam` - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaMCPToolUseBlockParam` - `Type MCPToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestMCPToolResultBlockParam` - `Type MCPToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content BetaRequestMCPToolResultBlockParamContentUnion Optional` - `string` - `[]BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `IsError bool Optional` - `type BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `Type ContainerUpload` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `Type Compaction` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content string Optional` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string Optional` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` The block's signature as returned, to be sent back verbatim - `ToolChanges []BetaCompactionBlockParamToolChangeUnion Optional` The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block. - `type BetaRequestToolAdditionBlockParam` 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 ToolAddition` - `Tool BetaRequestToolAdditionBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `Type ToolReference` - `Name string` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `Type MCPToolReference` - `Name string` - `ServerName string` - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `Type MCPToolsetReference` - `ServerName string` - `type BetaToolChangeToolDefinitionParam` 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. - `Type ToolDefinition` - `Definition BetaToolUnionParam` - `type BetaToolParam` - `Type BetaToolType Optional` - `InputSchema BetaToolInputSchemaParam` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `const BetaToolAllowedCallerCodeExecution20260521 BetaToolAllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestToolRemovalBlockParam` 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 ToolRemoval` - `Tool BetaRequestToolRemovalBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestToolAdditionBlockParam` 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` 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 BetaMCPToolListingBlockParam` 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. - `Type MCPToolListing` - `MCPServerName string` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `Tools []BetaMCPToolParam` The server's tools, exactly as the response listed them. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `Type Fallback` - `From BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Trigger any Optional` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `Role BetaMessageParamRole` - `const BetaMessageParamRoleUser BetaMessageParamRole = "user"` - `const BetaMessageParamRoleAssistant BetaMessageParamRole = "assistant"` - `const BetaMessageParamRoleSystem BetaMessageParamRole = "system"` - `ClearAt BetaMessageParamClearAt Optional` How long this system message's text stays in front of the model. `"never"` (the default) renders it on every request that includes it. `"next_user_message"` renders it only for the user turn it follows: once a later `role: "user"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: "system"` messages. - `const BetaMessageParamClearAtNextUserMessage BetaMessageParamClearAt = "next_user_message"` - `const BetaMessageParamClearAtNever BetaMessageParamClearAt = "never"` - `OutputConfig BetaSystemMessageOutputConfigParam Optional` 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 Optional` 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`. - `const BetaSystemMessageOutputConfigEffortLow BetaSystemMessageOutputConfigEffort = "low"` - `const BetaSystemMessageOutputConfigEffortMedium BetaSystemMessageOutputConfigEffort = "medium"` - `const BetaSystemMessageOutputConfigEffortHigh BetaSystemMessageOutputConfigEffort = "high"` - `const BetaSystemMessageOutputConfigEffortXhigh BetaSystemMessageOutputConfigEffort = "xhigh"` - `const BetaSystemMessageOutputConfigEffortMax BetaSystemMessageOutputConfigEffort = "max"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CacheControl BetaCacheControlEphemeralParam Optional` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `Compaction BetaCompactionConfigParam Optional` Compaction configuration. When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`. - `ContextManagement BetaContextManagementConfigParam Optional` Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `MCPServers []BetaRequestMCPServerURLDefinitionParam Optional` MCP servers to be utilized in this request maxItems: 20 - `Type URL` - `Name string` - `URL string` - `AuthorizationToken string Optional` - `ToolConfiguration BetaRequestMCPServerToolConfigurationParam Optional` - `AllowedTools []string Optional` - `Enabled bool Optional` - `OutputConfig BetaOutputConfigParam Optional` Configuration options for the model's output, such as the output format. - `Speed BetaMessageCountTokensParamsSpeed Optional` The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. Some models require the `fast-mode-2026-02-01` beta header for any `speed` value. See [fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode?sdk_languages=go) for which models. - `const BetaMessageCountTokensParamsSpeedStandard BetaMessageCountTokensParamsSpeed = "standard"` - `const BetaMessageCountTokensParamsSpeedFast BetaMessageCountTokensParamsSpeed = "fast"` - `System BetaMessageCountTokensParamsSystemUnion Optional` System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=go#give-claude-a-role). - `string` - `[]BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `Thinking BetaThinkingConfigParamUnion Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#configuring-thinking) for each model's behavior. - `ToolChoice BetaToolChoiceUnionParam Optional` 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. - `Tools []BetaMessageCountTokensParamsToolUnion Optional` Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=go), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=go)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=go) for more details. - `type BetaToolParam` - `type BetaToolBash20241022` - `type BetaToolBash20250124` - `type BetaCodeExecutionTool20250522` - `type BetaCodeExecutionTool20250825` - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type BetaToolComputerUse20241022` - `type BetaMemoryTool20250818` - `type BetaToolComputerUse20250124` - `type BetaToolTextEditor20241022` - `type BetaToolComputerUse20251124` - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type BetaToolTextEditor20250124` - `type BetaToolTextEditor20250429` - `type BetaToolTextEditor20250728` - `type BetaWebSearchTool20250305` - `type BetaWebFetchTool20250910` - `type BetaWebSearchTool20260209` - `type BetaWebFetchTool20260209` - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `type BetaWebSearchTool20260318` - `type BetaWebFetchTool20260318` - `type BetaAdvisorTool20260301` - `type BetaToolSearchToolBm25_20251119` - `type BetaToolSearchToolRegex20251119` - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Betas []AnthropicBeta Optional` (header parameter) Optional header to specify the beta version(s) you want to use. - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` - `const AnthropicBetaUserProfiles2026_09_04 AnthropicBeta = "user-profiles-2026-09-04"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` - `const AnthropicBetaMidConversationOutputConfig2026_07_01 AnthropicBeta = "mid-conversation-output-config-2026-07-01"` - `const AnthropicBetaThinkingBindingControls2026_08_01 AnthropicBeta = "thinking-binding-controls-2026-08-01"` - `const AnthropicBetaMidConversationSystemClearAt2026_08_21 AnthropicBeta = "mid-conversation-system-clear-at-2026-08-21"` - `const AnthropicBetaCompact2026_09_04 AnthropicBeta = "compact-2026-09-04"` - `const AnthropicBetaInlineTools2026_09_15 AnthropicBeta = "inline-tools-2026-09-15"` - `const AnthropicBetaMCPClient2026_09_15 AnthropicBeta = "mcp-client-2026-09-15"` - `const AnthropicBetaCEPlugins2026_09_01 AnthropicBeta = "ce-plugins-2026-09-01"` - `const AnthropicBetaSpendLimitReads2026_09_26 AnthropicBeta = "spend-limit-reads-2026-09-26"` - `const AnthropicBetaTelemetryDestinations2026_08_11 AnthropicBeta = "telemetry-destinations-2026-08-11"` - `UserProfileID param.Opt[string] Optional` (header parameter) The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. - `WorkspaceID param.Opt[string] Optional` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. - `OutputFormat BetaJSONOutputFormatParam Optional` **Deprecated** Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=go) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. ### Returns - `type BetaMessageTokensCount` - `ContextManagement BetaCountTokensContextManagementResponse` Information about context management applied to the message. - `OriginalInputTokens int64` The original token count before context management was applied - `InputTokens int64` The total number of tokens across the provided list of messages, system prompt, and tools. ### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaMessageTokensCount, err := client.Beta.Messages.CountTokens(context.TODO(), anthropic.BetaMessageCountTokensParams{ Messages: []anthropic.BetaMessageParam{anthropic.BetaMessageParam{ Content: []anthropic.BetaContentBlockParamUnion{anthropic.BetaContentBlockParamUnion{ OfText: &anthropic.BetaTextBlockParam{ Text: "x", }, }}, Role: anthropic.BetaMessageParamRoleUser, }}, Model: anthropic.ModelClaudeOpus5_5, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaMessageTokensCount.ContextManagement) } ``` #### Response (200) ```json { "context_management": { "original_input_tokens": 0 }, "input_tokens": 2095 } ``` ## Domain types ### Beta Advisor Message Iteration Usage - `type BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration default: advisor_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `OutputTokens int64` The number of output tokens which were used. minimum: 0 ### Beta Advisor Redacted Result Block - `type BetaAdvisorRedactedResultBlock` - `Type AdvisorRedactedResult` default: advisor_redacted_result - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). ### Beta Advisor Redacted Result Block Param - `type BetaAdvisorRedactedResultBlockParam` - `Type AdvisorRedactedResult` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `StopReason string Optional` ### Beta Advisor Result Block - `type BetaAdvisorResultBlock` - `Type AdvisorResult` default: advisor_result - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` ### Beta Advisor Result Block Param - `type BetaAdvisorResultBlockParam` - `Type AdvisorResult` - `Text string` - `StopReason string Optional` ### Beta Advisor Tool 20260301 - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Advisor Tool Result Block - `type BetaAdvisorToolResultBlock` - `Type AdvisorToolResult` default: advisor_tool_result - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError` - `Type AdvisorToolResultError` default: advisor_tool_result_error - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodeModelNotFound BetaAdvisorToolResultErrorErrorCode = "model_not_found"` - `type BetaAdvisorResultBlock` - `Type AdvisorResult` default: advisor_result - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `type BetaAdvisorRedactedResultBlock` - `Type AdvisorRedactedResult` default: advisor_redacted_result - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Advisor Tool Result Block Param - `type BetaAdvisorToolResultBlockParam` - `Type AdvisorToolResult` - `Content BetaAdvisorToolResultBlockParamContentUnion` - `type BetaAdvisorToolResultErrorParam` - `Type AdvisorToolResultError` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodeModelNotFound BetaAdvisorToolResultErrorParamErrorCode = "model_not_found"` - `type BetaAdvisorResultBlockParam` - `Type AdvisorResult` - `Text string` - `StopReason string Optional` - `type BetaAdvisorRedactedResultBlockParam` - `Type AdvisorRedactedResult` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `StopReason string Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Advisor Tool Result Error - `type BetaAdvisorToolResultError` - `Type AdvisorToolResultError` default: advisor_tool_result_error - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodeModelNotFound BetaAdvisorToolResultErrorErrorCode = "model_not_found"` ### Beta Advisor Tool Result Error Param - `type BetaAdvisorToolResultErrorParam` - `Type AdvisorToolResultError` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodeModelNotFound BetaAdvisorToolResultErrorParamErrorCode = "model_not_found"` ### Beta All Thinking Turns - `type BetaAllThinkingTurnsParam` - `Type All` ### Beta Base64 Image Source - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` ### Beta Base64 PDF Source - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` ### Beta Bash Code Execution Output Block - `type BetaBashCodeExecutionOutputBlock` - `Type BashCodeExecutionOutput` default: bash_code_execution_output - `FileID string` ### Beta Bash Code Execution Output Block Param - `type BetaBashCodeExecutionOutputBlockParam` - `Type BashCodeExecutionOutput` - `FileID string` ### Beta Bash Code Execution Result Block - `type BetaBashCodeExecutionResultBlock` - `Type BashCodeExecutionResult` default: bash_code_execution_result - `Content []BetaBashCodeExecutionOutputBlock` - `Type BashCodeExecutionOutput` default: bash_code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` ### Beta Bash Code Execution Result Block Param - `type BetaBashCodeExecutionResultBlockParam` - `Type BashCodeExecutionResult` - `Content []BetaBashCodeExecutionOutputBlockParam` - `Type BashCodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` ### Beta Bash Code Execution Tool Result Block - `type BetaBashCodeExecutionToolResultBlock` - `Type BashCodeExecutionToolResult` default: bash_code_execution_tool_result - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError` - `Type BashCodeExecutionToolResultError` default: bash_code_execution_tool_result_error - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlock` - `Type BashCodeExecutionResult` default: bash_code_execution_result - `Content []BetaBashCodeExecutionOutputBlock` - `Type BashCodeExecutionOutput` default: bash_code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Bash Code Execution Tool Result Block Param - `type BetaBashCodeExecutionToolResultBlockParam` - `Type BashCodeExecutionToolResult` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnion` - `type BetaBashCodeExecutionToolResultErrorParam` - `Type BashCodeExecutionToolResultError` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorParamErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlockParam` - `Type BashCodeExecutionResult` - `Content []BetaBashCodeExecutionOutputBlockParam` - `Type BashCodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Bash Code Execution Tool Result Error - `type BetaBashCodeExecutionToolResultError` - `Type BashCodeExecutionToolResultError` default: bash_code_execution_tool_result_error - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"` ### Beta Bash Code Execution Tool Result Error Param - `type BetaBashCodeExecutionToolResultErrorParam` - `Type BashCodeExecutionToolResultError` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorParamErrorCode = "output_file_too_large"` ### Beta Browser Click Target - `type BetaBrowserClickTargetUnion interface{…}` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. ### Beta Browser Close Tab Config - `type BetaBrowserCloseTabConfig` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Close Tab Input - `type BetaBrowserCloseTabInput` Close the tab with the given tab_id. - `TabID string` The tab to close. ### Beta Browser Close Tab Tool Use Block - `type BetaBrowserCloseTabToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserCloseTabInput` Close the tab with the given tab_id. - `TabID string` The tab to close. - `Name CloseTab` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Coordinate Target - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 ### Beta Browser Double Click Config - `type BetaBrowserDoubleClickConfig` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Double Click Input - `type BetaBrowserDoubleClickInput` Double left-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Double Click Tool Use Block - `type BetaBrowserDoubleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserDoubleClickInput` Double left-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name DoubleClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser File Upload Config - `type BetaBrowserFileUploadConfig` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser File Upload Input - `type BetaBrowserFileUploadInput` 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 BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `DocumentIDs []string Optional` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `Paths []string Optional` File paths on the browser executor's filesystem. minItems: 1 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser File Upload Tool Use Block - `type BetaBrowserFileUploadToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserFileUploadInput` 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 BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `DocumentIDs []string Optional` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `Paths []string Optional` File paths on the browser executor's filesystem. minItems: 1 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name FileUpload` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Find Config - `type BetaBrowserFindConfig` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Find Input - `type BetaBrowserFindInput` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `Query string` Natural-language description of the element(s) to find. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Find Tool Use Block - `type BetaBrowserFindToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserFindInput` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `Query string` Natural-language description of the element(s) to find. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Find` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Form Input Config - `type BetaBrowserFormInputConfig` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Form Input Input - `type BetaBrowserFormInputInput` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `Target BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Value BetaBrowserFormInputValueUnion` The value to set. - `string` - `float64` - `bool` - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Form Input Tool Use Block - `type BetaBrowserFormInputToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserFormInputInput` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `Target BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Value BetaBrowserFormInputValueUnion` The value to set. - `string` - `float64` - `bool` - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name FormInput` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Form Input Value - `type BetaBrowserFormInputValueUnion interface{…}` - `string` - `float64` - `bool` ### Beta Browser Get Page Text Config - `type BetaBrowserGetPageTextConfig` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Get Page Text Input - `type BetaBrowserGetPageTextInput` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Get Page Text Tool Use Block - `type BetaBrowserGetPageTextToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserGetPageTextInput` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name GetPageText` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Hold Key Config - `type BetaBrowserHoldKeyConfig` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Hold Key Input - `type BetaBrowserHoldKeyInput` 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 float64` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `Text string` The key or chord to hold. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Hold Key Tool Use Block - `type BetaBrowserHoldKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserHoldKeyInput` 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 float64` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `Text string` The key or chord to hold. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name HoldKey` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Hover Config - `type BetaBrowserHoverConfig` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Hover Input - `type BetaBrowserHoverInput` Move the cursor to a coordinate or element without clicking. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Hover Tool Use Block - `type BetaBrowserHoverToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserHoverInput` Move the cursor to a coordinate or element without clicking. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Hover` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Javascript Exec Config - `type BetaBrowserJavascriptExecConfig` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Javascript Exec Input - `type BetaBrowserJavascriptExecInput` 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`. - `Text string` JavaScript to execute in the page context. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Javascript Exec Tool Use Block - `type BetaBrowserJavascriptExecToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserJavascriptExecInput` 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`. - `Text string` JavaScript to execute in the page context. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name JavascriptExec` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Key Config - `type BetaBrowserKeyConfig` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Key Input - `type BetaBrowserKeyInput` 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. - `Text string` The key, chord, or space-separated sequence to press. - `Repeat int64 Optional` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Key Tool Use Block - `type BetaBrowserKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserKeyInput` 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. - `Text string` The key, chord, or space-separated sequence to press. - `Repeat int64 Optional` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Key` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Left Click Config - `type BetaBrowserLeftClickConfig` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Left Click Drag Config - `type BetaBrowserLeftClickDragConfig` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Left Click Drag Input - `type BetaBrowserLeftClickDragInput` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `From BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Left Click Drag Tool Use Block - `type BetaBrowserLeftClickDragToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftClickDragInput` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `From BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftClickDrag` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Left Click Input - `type BetaBrowserLeftClickInput` Left-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Left Click Tool Use Block - `type BetaBrowserLeftClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftClickInput` Left-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Left Mouse Down Config - `type BetaBrowserLeftMouseDownConfig` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Left Mouse Down Input - `type BetaBrowserLeftMouseDownInput` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Left Mouse Down Tool Use Block - `type BetaBrowserLeftMouseDownToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftMouseDownInput` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftMouseDown` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Left Mouse Up Config - `type BetaBrowserLeftMouseUpConfig` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Left Mouse Up Input - `type BetaBrowserLeftMouseUpInput` Release the left mouse button at a viewport coordinate. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Left Mouse Up Tool Use Block - `type BetaBrowserLeftMouseUpToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftMouseUpInput` Release the left mouse button at a viewport coordinate. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftMouseUp` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser List Tabs Config - `type BetaBrowserListTabsConfig` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser List Tabs Input - `type BetaBrowserListTabsInput struct{…}` List all open tabs with each tab's tab_id, title, and URL. ### Beta Browser List Tabs Tool Use Block - `type BetaBrowserListTabsToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserListTabsInput` List all open tabs with each tab's tab_id, title, and URL. - `Name ListTabs` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Middle Click Config - `type BetaBrowserMiddleClickConfig` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Middle Click Input - `type BetaBrowserMiddleClickInput` Middle-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Middle Click Tool Use Block - `type BetaBrowserMiddleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserMiddleClickInput` Middle-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name MiddleClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Mouse Move Config - `type BetaBrowserMouseMoveConfig` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Mouse Move Input - `type BetaBrowserMouseMoveInput` Move the pointer to a viewport coordinate without clicking. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Mouse Move Tool Use Block - `type BetaBrowserMouseMoveToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserMouseMoveInput` Move the pointer to a viewport coordinate without clicking. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name MouseMove` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Navigate Config - `type BetaBrowserNavigateConfig` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Navigate Input - `type BetaBrowserNavigateInput` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `URL string` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Navigate Tool Use Block - `type BetaBrowserNavigateToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserNavigateInput` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `URL string` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Navigate` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser New Tab Config - `type BetaBrowserNewTabConfig` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser New Tab Input - `type BetaBrowserNewTabInput struct{…}` Open a new empty tab and return its tab_id. ### Beta Browser New Tab Tool Use Block - `type BetaBrowserNewTabToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserNewTabInput` Open a new empty tab and return its tab_id. - `Name NewTab` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Read Console Config - `type BetaBrowserReadConsoleConfig` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Read Console Input - `type BetaBrowserReadConsoleInput` 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. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Read Console Tool Use Block - `type BetaBrowserReadConsoleToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserReadConsoleInput` 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. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ReadConsole` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Read Network Config - `type BetaBrowserReadNetworkConfig` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Read Network Input - `type BetaBrowserReadNetworkInput` 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. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Read Network Tool Use Block - `type BetaBrowserReadNetworkToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserReadNetworkInput` 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. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ReadNetwork` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Read Page Config - `type BetaBrowserReadPageConfig` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Read Page Filter - `type BetaBrowserReadPageFilter string` - `const BetaBrowserReadPageFilterAll BetaBrowserReadPageFilter = "all"` - `const BetaBrowserReadPageFilterInteractive BetaBrowserReadPageFilter = "interactive"` ### Beta Browser Read Page Input - `type BetaBrowserReadPageInput` 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 Optional` Maximum tree depth. Default 15. minimum: 1 - `Filter BetaBrowserReadPageFilter Optional` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `const BetaBrowserReadPageFilterAll BetaBrowserReadPageFilter = "all"` - `const BetaBrowserReadPageFilterInteractive BetaBrowserReadPageFilter = "interactive"` - `Ref string Optional` Element reference to read a subtree from. Omit to read from the page root. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Read Page Tool Use Block - `type BetaBrowserReadPageToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserReadPageInput` 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 Optional` Maximum tree depth. Default 15. minimum: 1 - `Filter BetaBrowserReadPageFilter Optional` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `const BetaBrowserReadPageFilterAll BetaBrowserReadPageFilter = "all"` - `const BetaBrowserReadPageFilterInteractive BetaBrowserReadPageFilter = "interactive"` - `Ref string Optional` Element reference to read a subtree from. Omit to read from the page root. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ReadPage` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Ref Target - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. ### Beta Browser Right Click Config - `type BetaBrowserRightClickConfig` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Right Click Input - `type BetaBrowserRightClickInput` Right-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Right Click Tool Use Block - `type BetaBrowserRightClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserRightClickInput` Right-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name RightClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Screenshot Config - `type BetaBrowserScreenshotConfig` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Screenshot Input - `type BetaBrowserScreenshotInput` Capture the current browser viewport. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Screenshot Tool Use Block - `type BetaBrowserScreenshotToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserScreenshotInput` Capture the current browser viewport. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Screenshot` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Scroll Config - `type BetaBrowserScrollConfig` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Scroll Direction - `type BetaBrowserScrollDirection string` - `const BetaBrowserScrollDirectionUp BetaBrowserScrollDirection = "up"` - `const BetaBrowserScrollDirectionDown BetaBrowserScrollDirection = "down"` - `const BetaBrowserScrollDirectionLeft BetaBrowserScrollDirection = "left"` - `const BetaBrowserScrollDirectionRight BetaBrowserScrollDirection = "right"` ### Beta Browser Scroll Input - `type BetaBrowserScrollInput` Scroll at a viewport position. `target` must be a coordinate target. - `ScrollDirection BetaBrowserScrollDirection` - `const BetaBrowserScrollDirectionUp BetaBrowserScrollDirection = "up"` - `const BetaBrowserScrollDirectionDown BetaBrowserScrollDirection = "down"` - `const BetaBrowserScrollDirectionLeft BetaBrowserScrollDirection = "left"` - `const BetaBrowserScrollDirectionRight BetaBrowserScrollDirection = "right"` - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `ScrollAmount int64 Optional` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Scroll To Config - `type BetaBrowserScrollToConfig` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Scroll To Input - `type BetaBrowserScrollToInput` Scroll an element into view. - `Target BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Scroll To Tool Use Block - `type BetaBrowserScrollToToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserScrollToInput` Scroll an element into view. - `Target BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ScrollTo` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Scroll Tool Use Block - `type BetaBrowserScrollToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserScrollInput` Scroll at a viewport position. `target` must be a coordinate target. - `ScrollDirection BetaBrowserScrollDirection` - `const BetaBrowserScrollDirectionUp BetaBrowserScrollDirection = "up"` - `const BetaBrowserScrollDirectionDown BetaBrowserScrollDirection = "down"` - `const BetaBrowserScrollDirectionLeft BetaBrowserScrollDirection = "left"` - `const BetaBrowserScrollDirectionRight BetaBrowserScrollDirection = "right"` - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `ScrollAmount int64 Optional` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Scroll` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser State Block Param - `type BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `Type BrowserState` - `Tabs []BetaBrowserStateTabEntryParam` 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`. maxItems: 100 - `TabID string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Title string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Active bool Optional` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `StateChanges []BetaBrowserStateChangeUnionParam Optional` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `type BetaBrowserStateChangeTabOpenedParam` 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. - `Type TabOpened` - `TabID string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadStartedParam` A file download that started during this call. - `Type DownloadStarted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadCompletedParam` 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). - `Type DownloadCompleted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Path string Optional` 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. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `SizeBytes int64 Optional` The completed download's size. minimum: 0 - `type BetaBrowserStateChangeDownloadFailedParam` A file download that failed — or was cancelled — during this call. - `Type DownloadFailed` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Error string Optional` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Beta Browser State Change - `type BetaBrowserStateChangeUnionParam interface{…}` - `type BetaBrowserStateChangeTabOpenedParam` 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. - `Type TabOpened` - `TabID string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadStartedParam` A file download that started during this call. - `Type DownloadStarted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadCompletedParam` 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). - `Type DownloadCompleted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Path string Optional` 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. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `SizeBytes int64 Optional` The completed download's size. minimum: 0 - `type BetaBrowserStateChangeDownloadFailedParam` A file download that failed — or was cancelled — during this call. - `Type DownloadFailed` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Error string Optional` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Beta Browser State Change Download Completed - `type BetaBrowserStateChangeDownloadCompletedParam` 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). - `Type DownloadCompleted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Path string Optional` 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. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `SizeBytes int64 Optional` The completed download's size. minimum: 0 ### Beta Browser State Change Download Failed - `type BetaBrowserStateChangeDownloadFailedParam` A file download that failed — or was cancelled — during this call. - `Type DownloadFailed` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Error string Optional` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Beta Browser State Change Download Started - `type BetaBrowserStateChangeDownloadStartedParam` A file download that started during this call. - `Type DownloadStarted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Beta Browser State Change Tab Opened - `type BetaBrowserStateChangeTabOpenedParam` 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. - `Type TabOpened` - `TabID string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Beta Browser State Tab Entry - `type BetaBrowserStateTabEntryParam` 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 string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Title string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Active bool Optional` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. ### Beta Browser Switch Tab Config - `type BetaBrowserSwitchTabConfig` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Switch Tab Input - `type BetaBrowserSwitchTabInput` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `TabID string` The tab to switch to. ### Beta Browser Switch Tab Tool Use Block - `type BetaBrowserSwitchTabToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserSwitchTabInput` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `TabID string` The tab to switch to. - `Name SwitchTab` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Tool Use Block - `type BetaBrowserToolUseBlockUnion interface{…}` - `type BetaBrowserNavigateToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserNavigateInput` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `URL string` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Navigate` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaBrowserListTabsToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserListTabsInput` List all open tabs with each tab's tab_id, title, and URL. - `Name ListTabs` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserNewTabToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserNewTabInput` Open a new empty tab and return its tab_id. - `Name NewTab` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserSwitchTabToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserSwitchTabInput` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `TabID string` The tab to switch to. - `Name SwitchTab` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserCloseTabToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserCloseTabInput` Close the tab with the given tab_id. - `TabID string` The tab to close. - `Name CloseTab` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserReadPageToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserReadPageInput` 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 Optional` Maximum tree depth. Default 15. minimum: 1 - `Filter BetaBrowserReadPageFilter Optional` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `const BetaBrowserReadPageFilterAll BetaBrowserReadPageFilter = "all"` - `const BetaBrowserReadPageFilterInteractive BetaBrowserReadPageFilter = "interactive"` - `Ref string Optional` Element reference to read a subtree from. Omit to read from the page root. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ReadPage` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserGetPageTextToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserGetPageTextInput` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name GetPageText` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserReadConsoleToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserReadConsoleInput` 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. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ReadConsole` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserReadNetworkToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserReadNetworkInput` 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. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ReadNetwork` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserFindToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserFindInput` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `Query string` Natural-language description of the element(s) to find. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Find` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserFormInputToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserFormInputInput` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `Target BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Value BetaBrowserFormInputValueUnion` The value to set. - `string` - `float64` - `bool` - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name FormInput` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserFileUploadToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserFileUploadInput` 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 BetaBrowserRefTarget` 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. - `DocumentIDs []string Optional` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `Paths []string Optional` File paths on the browser executor's filesystem. minItems: 1 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name FileUpload` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserScrollToToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserScrollToInput` Scroll an element into view. - `Target BetaBrowserRefTarget` 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. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ScrollTo` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserScreenshotToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserScreenshotInput` Capture the current browser viewport. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Screenshot` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserZoomToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserZoomInput` 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. minItems: 4, maxItems: 4 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Zoom` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserLeftClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftClickInput` Left-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserRightClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserRightClickInput` Right-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name RightClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserMiddleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserMiddleClickInput` Middle-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name MiddleClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserDoubleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserDoubleClickInput` Double left-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name DoubleClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserTripleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserTripleClickInput` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name TripleClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserHoverToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserHoverInput` Move the cursor to a coordinate or element without clicking. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Hover` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserLeftClickDragToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftClickDragInput` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `From BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftClickDrag` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserLeftMouseDownToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftMouseDownInput` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftMouseDown` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserLeftMouseUpToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftMouseUpInput` Release the left mouse button at a viewport coordinate. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftMouseUp` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserMouseMoveToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserMouseMoveInput` Move the pointer to a viewport coordinate without clicking. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name MouseMove` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserScrollToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserScrollInput` Scroll at a viewport position. `target` must be a coordinate target. - `ScrollDirection BetaBrowserScrollDirection` - `const BetaBrowserScrollDirectionUp BetaBrowserScrollDirection = "up"` - `const BetaBrowserScrollDirectionDown BetaBrowserScrollDirection = "down"` - `const BetaBrowserScrollDirectionLeft BetaBrowserScrollDirection = "left"` - `const BetaBrowserScrollDirectionRight BetaBrowserScrollDirection = "right"` - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `ScrollAmount int64 Optional` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Scroll` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserTypeToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserTypeInput` Type a literal string at the current focus. - `Text string` The text to type. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Type` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserKeyInput` 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. - `Text string` The key, chord, or space-separated sequence to press. - `Repeat int64 Optional` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Key` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserHoldKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserHoldKeyInput` 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 float64` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `Text string` The key or chord to hold. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name HoldKey` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserWaitToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserWaitInput` Pause for the given duration. - `Duration float64` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Wait` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserJavascriptExecToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserJavascriptExecInput` 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`. - `Text string` JavaScript to execute in the page context. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name JavascriptExec` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. ### Beta Browser Toolset 20260801 - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Toolset Configs - `type BetaBrowserToolsetConfigs` Per-member configuration for `browser_toolset_20260801`: one optional field per member tool, keyed by the member name — the same name the member's `tool_use` blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Triple Click Config - `type BetaBrowserTripleClickConfig` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Triple Click Input - `type BetaBrowserTripleClickInput` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Triple Click Tool Use Block - `type BetaBrowserTripleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserTripleClickInput` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name TripleClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Type Config - `type BetaBrowserTypeConfig` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Type Input - `type BetaBrowserTypeInput` Type a literal string at the current focus. - `Text string` The text to type. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Type Tool Use Block - `type BetaBrowserTypeToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserTypeInput` Type a literal string at the current focus. - `Text string` The text to type. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Type` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Wait Config - `type BetaBrowserWaitConfig` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Wait Input - `type BetaBrowserWaitInput` Pause for the given duration. - `Duration float64` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Wait Tool Use Block - `type BetaBrowserWaitToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserWaitInput` Pause for the given duration. - `Duration float64` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Wait` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Zoom Config - `type BetaBrowserZoomConfig` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Browser Zoom Input - `type BetaBrowserZoomInput` 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. minItems: 4, maxItems: 4 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Zoom Tool Use Block - `type BetaBrowserZoomToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserZoomInput` 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. minItems: 4, maxItems: 4 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Zoom` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Cache Control Ephemeral - `type BetaCacheControlEphemeral` - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Cache Creation - `type BetaCacheCreation` - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 ### Beta Cache Miss Messages Changed - `type BetaCacheMissMessagesChanged` - `Type MessagesChanged` default: messages_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Beta Cache Miss Model Changed - `type BetaCacheMissModelChanged` - `Type ModelChanged` default: model_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Beta Cache Miss Previous Message Not Found - `type BetaCacheMissPreviousMessageNotFound` - `Type PreviousMessageNotFound` default: previous_message_not_found ### Beta Cache Miss Reason - `type BetaCacheMissReasonUnion interface{…}` - `type BetaCacheMissModelChanged` - `Type ModelChanged` default: model_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissSystemChanged` - `Type SystemChanged` default: system_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissToolsChanged` - `Type ToolsChanged` default: tools_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissMessagesChanged` - `Type MessagesChanged` default: messages_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissPreviousMessageNotFound` - `Type PreviousMessageNotFound` default: previous_message_not_found - `type BetaCacheMissUnavailable` - `Type Unavailable` default: unavailable ### Beta Cache Miss System Changed - `type BetaCacheMissSystemChanged` - `Type SystemChanged` default: system_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Beta Cache Miss Tools Changed - `type BetaCacheMissToolsChanged` - `Type ToolsChanged` default: tools_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Beta Cache Miss Unavailable - `type BetaCacheMissUnavailable` - `Type Unavailable` default: unavailable ### Beta Citation Char Location - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 ### Beta Citation Char Location Param - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 ### Beta Citation Config - `type BetaCitationConfig` - `Enabled bool` default: false ### Beta Citation Content Block Location - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 ### Beta Citation Content Block Location Param - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 ### Beta Citation Page Location - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 ### Beta Citation Page Location Param - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 ### Beta Citation Search Result Location - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` ### Beta Citation Search Result Location Param - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` ### Beta Citation Web Search Result Location Param - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 ### Beta Citations Config Param - `type BetaCitationsConfigParamResp` - `Enabled bool Optional` ### Beta Citations Delta - `type BetaCitationsDelta` - `Type CitationsDelta` default: citations_delta - `Citation BetaCitationsDeltaCitationUnion` - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` ### Beta Citations Web Search Result Location - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` ### Beta Clear Thinking 20251015 Edit - `type BetaClearThinking20251015EditParam` - `Type ClearThinking20251015` - `Keep BetaClearThinking20251015EditKeepUnionParam Optional` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `type BetaThinkingTurnsParam` - `Type ThinkingTurns` - `Value int64` minimum: 1 - `type BetaAllThinkingTurnsParam` - `Type All` - `All` ### Beta Clear Thinking 20251015 Edit Response - `type BetaClearThinking20251015EditResponse` - `Type ClearThinking20251015` The type of context management edit applied. default: clear_thinking_20251015 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedThinkingTurns int64` Number of thinking turns that were cleared. minimum: 0 ### Beta Clear Tool Uses 20250919 Edit - `type BetaClearToolUses20250919EditParam` - `Type ClearToolUses20250919` - `ClearAtLeast BetaInputTokensClearAtLeastParam Optional` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `Type InputTokens` - `Value int64` minimum: 0 - `ClearToolInputs BetaClearToolUses20250919EditClearToolInputsUnionParam Optional` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `bool` - `[]string` - `ExcludeTools []string Optional` Tool names whose uses are preserved from clearing - `Keep BetaToolUsesKeepParam Optional` Number of tool uses to retain in the conversation - `Type ToolUses` - `Value int64` minimum: 0 - `Trigger BetaClearToolUses20250919EditTriggerUnionParam Optional` Condition that triggers the context management strategy - `type BetaInputTokensTriggerParam` - `Type InputTokens` - `Value int64` minimum: 1 - `type BetaToolUsesTriggerParam` - `Type ToolUses` - `Value int64` minimum: 1 ### Beta Clear Tool Uses 20250919 Edit Response - `type BetaClearToolUses20250919EditResponse` - `Type ClearToolUses20250919` The type of context management edit applied. default: clear_tool_uses_20250919 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedToolUses int64` Number of tool uses that were cleared. minimum: 0 ### Beta Code Execution Output Block - `type BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` ### Beta Code Execution Output Block Param - `type BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` ### Beta Code Execution Result Block - `type BetaCodeExecutionResultBlock` - `Type CodeExecutionResult` default: code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` ### Beta Code Execution Result Block Param - `type BetaCodeExecutionResultBlockParam` - `Type CodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` ### Beta Code Execution Tool 20250522 - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20250825 - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20260120 - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20260521 - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool Result Block - `type BetaCodeExecutionToolResultBlock` - `Type CodeExecutionToolResult` default: code_execution_tool_result - `Content BetaCodeExecutionToolResultBlockContentUnion` - `type BetaCodeExecutionToolResultError` - `Type CodeExecutionToolResultError` default: code_execution_tool_result_error - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlock` - `Type CodeExecutionResult` default: code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` default: encrypted_code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Code Execution Tool Result Block Content - `type BetaCodeExecutionToolResultBlockContentUnion interface{…}` - `type BetaCodeExecutionToolResultError` - `Type CodeExecutionToolResultError` default: code_execution_tool_result_error - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlock` - `Type CodeExecutionResult` default: code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` default: encrypted_code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` ### Beta Code Execution Tool Result Block Param - `type BetaCodeExecutionToolResultBlockParam` - `Type CodeExecutionToolResult` - `Content BetaCodeExecutionToolResultBlockParamContentUnion` - `type BetaCodeExecutionToolResultErrorParam` - `Type CodeExecutionToolResultError` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlockParam` - `Type CodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Code Execution Tool Result Block Param Content - `type BetaCodeExecutionToolResultBlockParamContentUnion interface{…}` - `type BetaCodeExecutionToolResultErrorParam` - `Type CodeExecutionToolResultError` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlockParam` - `Type CodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` ### Beta Code Execution Tool Result Error - `type BetaCodeExecutionToolResultError` - `Type CodeExecutionToolResultError` default: code_execution_tool_result_error - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` ### Beta Code Execution Tool Result Error Code - `type BetaCodeExecutionToolResultErrorCode string` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` ### Beta Code Execution Tool Result Error Param - `type BetaCodeExecutionToolResultErrorParam` - `Type CodeExecutionToolResultError` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` ### Beta Compact 20260112 Edit - `type BetaCompact20260112EditParam` Automatically compact older context when reaching the configured trigger threshold. - `Type Compact20260112` - `Instructions string Optional` Additional instructions for summarization. - `PauseAfterCompaction bool Optional` Whether to pause after compaction and return the compaction block to the user. - `Trigger BetaInputTokensTriggerParam Optional` When to trigger compaction. Defaults to 150000 input tokens. - `Type InputTokens` - `Value int64` minimum: 1 ### Beta Compaction Block - `type BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `Type Compaction` default: compaction - `Content string` Summary of compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` Signature over the summary, to be sent back with the block verbatim - `ToolChanges []BetaCompactionBlockToolChangeUnion Optional` 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` 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 ToolAddition` default: tool_addition - `Tool BetaResponseToolAdditionBlockToolUnion` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `type BetaResponseToolChangeToolReference` 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` default: tool_reference - `Name string` - `type BetaResponseToolChangeMCPToolReference` 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` default: mcp_tool_reference - `Name string` - `ServerName string` - `type BetaResponseToolChangeMCPToolsetReference` 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` default: mcp_toolset_reference - `ServerName string` - `type BetaToolChangeToolDefinition` 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` default: tool_definition - `Definition BetaResponseToolUnion` - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaResponseToolRemovalBlock` 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 ToolRemoval` default: tool_removal - `Tool BetaResponseToolRemovalBlockToolUnion` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `type BetaResponseToolChangeToolReference` 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 BetaResponseToolChangeMCPToolReference` 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 BetaResponseToolChangeMCPToolsetReference` 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. ### Beta Compaction Block Param - `type BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `Type Compaction` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Content string Optional` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string Optional` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` The block's signature as returned, to be sent back verbatim - `ToolChanges []BetaCompactionBlockParamToolChangeUnion Optional` The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block. - `type BetaRequestToolAdditionBlockParam` 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 ToolAddition` - `Tool BetaRequestToolAdditionBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `Type ToolReference` - `Name string` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `Type MCPToolReference` - `Name string` - `ServerName string` - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `Type MCPToolsetReference` - `ServerName string` - `type BetaToolChangeToolDefinitionParam` 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. - `Type ToolDefinition` - `Definition BetaToolUnionParam` - `type BetaToolParam` - `Type BetaToolType Optional` - `InputSchema BetaToolInputSchemaParam` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `const BetaToolAllowedCallerCodeExecution20260521 BetaToolAllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestToolRemovalBlockParam` 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 ToolRemoval` - `Tool BetaRequestToolRemovalBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. ### Beta Compaction Config - `type BetaCompactionConfigParam` 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. - `Type Summarize` - `Instructions string Optional` Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent. maxLength: 16384 ### Beta Compaction Content Block Delta - `type BetaCompactionContentBlockDelta` - `Type CompactionDelta` default: compaction_delta - `Content string` - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim ### Beta Compaction Iteration Usage - `type BetaCompactionIterationUsage` Token usage for a compaction iteration. - `Type Compaction` Usage for a compaction iteration default: compaction - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 ### Beta Computer Cursor Position Config - `type BetaComputerCursorPositionConfig` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Cursor Position Input - `type BetaComputerCursorPositionInput struct{…}` Get the current (x, y) pixel coordinate of the cursor. ### Beta Computer Cursor Position Tool Use Block - `type BetaComputerCursorPositionToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerCursorPositionInput` Get the current (x, y) pixel coordinate of the cursor. - `Name CursorPosition` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Double Click Config - `type BetaComputerDoubleClickConfig` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Double Click Input - `type BetaComputerDoubleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Double Click Tool Use Block - `type BetaComputerDoubleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerDoubleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name DoubleClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Hold Key Config - `type BetaComputerHoldKeyConfig` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Hold Key Input - `type BetaComputerHoldKeyInput` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `Duration int64` Duration to hold the key, in seconds. maximum: 300 - `Text string` The key or key-combination to hold. ### Beta Computer Hold Key Tool Use Block - `type BetaComputerHoldKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerHoldKeyInput` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `Duration int64` Duration to hold the key, in seconds. maximum: 300 - `Text string` The key or key-combination to hold. - `Name HoldKey` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Key Config - `type BetaComputerKeyConfig` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Key Input - `type BetaComputerKeyInput` 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. - `Text string` The key or key-combination to press. - `Repeat int64 Optional` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 ### Beta Computer Key Tool Use Block - `type BetaComputerKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerKeyInput` 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. - `Text string` The key or key-combination to press. - `Repeat int64 Optional` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `Name Key` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Left Click Config - `type BetaComputerLeftClickConfig` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Left Click Drag Config - `type BetaComputerLeftClickDragConfig` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Left Click Drag Input - `type BetaComputerLeftClickDragInput` 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. minItems: 2, maxItems: 2 - `StartCoordinate []int64` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Left Click Drag Tool Use Block - `type BetaComputerLeftClickDragToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftClickDragInput` 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. minItems: 2, maxItems: 2 - `StartCoordinate []int64` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name LeftClickDrag` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Left Click Input - `type BetaComputerLeftClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Left Click Tool Use Block - `type BetaComputerLeftClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name LeftClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Left Mouse Down Config - `type BetaComputerLeftMouseDownConfig` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Left Mouse Down Input - `type BetaComputerLeftMouseDownInput struct{…}` Press and hold the left mouse button at the current cursor position. ### Beta Computer Left Mouse Down Tool Use Block - `type BetaComputerLeftMouseDownToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftMouseDownInput` Press and hold the left mouse button at the current cursor position. - `Name LeftMouseDown` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Left Mouse Up Config - `type BetaComputerLeftMouseUpConfig` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Left Mouse Up Input - `type BetaComputerLeftMouseUpInput struct{…}` Release the left mouse button. ### Beta Computer Left Mouse Up Tool Use Block - `type BetaComputerLeftMouseUpToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftMouseUpInput` Release the left mouse button. - `Name LeftMouseUp` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Middle Click Config - `type BetaComputerMiddleClickConfig` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Middle Click Input - `type BetaComputerMiddleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Middle Click Tool Use Block - `type BetaComputerMiddleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerMiddleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name MiddleClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Mouse Move Config - `type BetaComputerMouseMoveConfig` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Mouse Move Input - `type BetaComputerMouseMoveInput` 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. minItems: 2, maxItems: 2 ### Beta Computer Mouse Move Tool Use Block - `type BetaComputerMouseMoveToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerMouseMoveInput` 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. minItems: 2, maxItems: 2 - `Name MouseMove` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Right Click Config - `type BetaComputerRightClickConfig` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Right Click Input - `type BetaComputerRightClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Right Click Tool Use Block - `type BetaComputerRightClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerRightClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name RightClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Screenshot Config - `type BetaComputerScreenshotConfig` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Screenshot Input - `type BetaComputerScreenshotInput struct{…}` Take a screenshot of the screen. ### Beta Computer Screenshot Tool Use Block - `type BetaComputerScreenshotToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerScreenshotInput` Take a screenshot of the screen. - `Name Screenshot` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Scroll Config - `type BetaComputerScrollConfig` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Scroll Direction - `type BetaComputerScrollDirection string` - `const BetaComputerScrollDirectionUp BetaComputerScrollDirection = "up"` - `const BetaComputerScrollDirectionDown BetaComputerScrollDirection = "down"` - `const BetaComputerScrollDirectionLeft BetaComputerScrollDirection = "left"` - `const BetaComputerScrollDirectionRight BetaComputerScrollDirection = "right"` ### Beta Computer Scroll Input - `type BetaComputerScrollInput` 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. - `ScrollAmount int64` Number of 'clicks' of the scroll wheel. - `ScrollDirection BetaComputerScrollDirection` - `const BetaComputerScrollDirectionUp BetaComputerScrollDirection = "up"` - `const BetaComputerScrollDirectionDown BetaComputerScrollDirection = "down"` - `const BetaComputerScrollDirectionLeft BetaComputerScrollDirection = "left"` - `const BetaComputerScrollDirectionRight BetaComputerScrollDirection = "right"` - `Coordinate []int64 Optional` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Scroll Tool Use Block - `type BetaComputerScrollToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerScrollInput` 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. - `ScrollAmount int64` Number of 'clicks' of the scroll wheel. - `ScrollDirection BetaComputerScrollDirection` - `const BetaComputerScrollDirectionUp BetaComputerScrollDirection = "up"` - `const BetaComputerScrollDirectionDown BetaComputerScrollDirection = "down"` - `const BetaComputerScrollDirectionLeft BetaComputerScrollDirection = "left"` - `const BetaComputerScrollDirectionRight BetaComputerScrollDirection = "right"` - `Coordinate []int64 Optional` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name Scroll` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Tool Use Block - `type BetaComputerToolUseBlockUnion interface{…}` - `type BetaComputerKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerKeyInput` 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. - `Text string` The key or key-combination to press. - `Repeat int64 Optional` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `Name Key` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaComputerHoldKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerHoldKeyInput` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `Duration int64` Duration to hold the key, in seconds. maximum: 300 - `Text string` The key or key-combination to hold. - `Name HoldKey` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerTypeToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerTypeInput` Type a string of text on the keyboard. - `Text string` The text to type. - `Name Type` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerCursorPositionToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerCursorPositionInput` Get the current (x, y) pixel coordinate of the cursor. - `Name CursorPosition` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerMouseMoveToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerMouseMoveInput` 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. minItems: 2, maxItems: 2 - `Name MouseMove` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerLeftMouseDownToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftMouseDownInput` Press and hold the left mouse button at the current cursor position. - `Name LeftMouseDown` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerLeftMouseUpToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftMouseUpInput` Release the left mouse button. - `Name LeftMouseUp` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerLeftClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name LeftClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerLeftClickDragToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftClickDragInput` 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. minItems: 2, maxItems: 2 - `StartCoordinate []int64` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name LeftClickDrag` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerRightClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerRightClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name RightClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerMiddleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerMiddleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name MiddleClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerDoubleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerDoubleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name DoubleClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerTripleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerTripleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name TripleClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerScrollToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerScrollInput` 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. - `ScrollAmount int64` Number of 'clicks' of the scroll wheel. - `ScrollDirection BetaComputerScrollDirection` - `const BetaComputerScrollDirectionUp BetaComputerScrollDirection = "up"` - `const BetaComputerScrollDirectionDown BetaComputerScrollDirection = "down"` - `const BetaComputerScrollDirectionLeft BetaComputerScrollDirection = "left"` - `const BetaComputerScrollDirectionRight BetaComputerScrollDirection = "right"` - `Coordinate []int64 Optional` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name Scroll` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerWaitToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerWaitInput` Wait for a specified duration. - `Duration int64` Duration to wait, in seconds. maximum: 300 - `Name Wait` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerScreenshotToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerScreenshotInput` Take a screenshot of the screen. - `Name Screenshot` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerZoomToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerZoomInput` 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. minItems: 4, maxItems: 4 - `Name Zoom` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. ### Beta Computer Toolset 20260801 - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Toolset Configs - `type BetaComputerToolsetConfigs` Per-member configuration for `computer_toolset_20260801`: one optional field per member tool, keyed by the member name — the same name the member's `tool_use` blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Triple Click Config - `type BetaComputerTripleClickConfig` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Triple Click Input - `type BetaComputerTripleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Triple Click Tool Use Block - `type BetaComputerTripleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerTripleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name TripleClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Type Config - `type BetaComputerTypeConfig` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Type Input - `type BetaComputerTypeInput` Type a string of text on the keyboard. - `Text string` The text to type. ### Beta Computer Type Tool Use Block - `type BetaComputerTypeToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerTypeInput` Type a string of text on the keyboard. - `Text string` The text to type. - `Name Type` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Wait Config - `type BetaComputerWaitConfig` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Wait Input - `type BetaComputerWaitInput` Wait for a specified duration. - `Duration int64` Duration to wait, in seconds. maximum: 300 ### Beta Computer Wait Tool Use Block - `type BetaComputerWaitToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerWaitInput` Wait for a specified duration. - `Duration int64` Duration to wait, in seconds. maximum: 300 - `Name Wait` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Zoom Config - `type BetaComputerZoomConfig` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. ### Beta Computer Zoom Input - `type BetaComputerZoomInput` 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. minItems: 4, maxItems: 4 ### Beta Computer Zoom Tool Use Block - `type BetaComputerZoomToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerZoomInput` 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. minItems: 4, maxItems: 4 - `Name Zoom` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Container - `type BetaContainer` Information about the container used in the request (for the code execution tool) - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. format: date-time - `Skills []BetaContainerSkill` Skills loaded in the container - `Type BetaContainerSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaContainerSkillTypeAnthropic BetaContainerSkillType = "anthropic"` - `const BetaContainerSkillTypeCustom BetaContainerSkillType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 ### Beta Container Params - `type BetaContainerParams` Container parameters with skills to be loaded. - `ID string Optional` Container id - `Skills []BetaSkillParams Optional` List of skills to load in the container maxItems: 20 - `Type BetaSkillParamsType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillParamsTypeAnthropic BetaSkillParamsType = "anthropic"` - `const BetaSkillParamsTypeCustom BetaSkillParamsType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string Optional` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 ### Beta Container Skill - `type BetaContainerSkill` A skill that was loaded in a container (response model). - `Type BetaContainerSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaContainerSkillTypeAnthropic BetaContainerSkillType = "anthropic"` - `const BetaContainerSkillTypeCustom BetaContainerSkillType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 ### Beta Container Upload Block - `type BetaContainerUploadBlock` Response model for a file uploaded to the container. - `Type ContainerUpload` default: container_upload - `FileID string` ### Beta Container Upload Block Param - `type BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `Type ContainerUpload` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Content Block - `type BetaContentBlockUnion interface{…}` - `type BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `Text string` - `type BetaThinkingBlock` - `Type Thinking` default: thinking - `Signature string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. - `Thinking string` The text of Claude's thinking process for this block. - `type BetaRedactedThinkingBlock` - `Type RedactedThinking` default: redacted_thinking - `Data string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go#redacted-thinking-blocks) for details. - `type BetaToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1 - `Caller BetaToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlock` - `Type ServerToolUse` default: server_tool_use - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"` - `const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"` - `const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"` - `const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"` - `const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"` - `const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"` - `Caller BetaServerToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlock` - `Type WebSearchToolResult` default: web_search_tool_result - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError` - `Type WebSearchToolResultError` default: web_search_tool_result_error - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `[]BetaWebSearchResultBlock` - `Type WebSearchResult` default: web_search_result - `EncryptedContent string` - `PageAge string` - `Title string` - `URL string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebSearchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlock` - `Type WebFetchToolResult` default: web_fetch_tool_result - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock` - `Type WebFetchToolResultError` default: web_fetch_tool_result_error - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlock` - `Type WebFetchResult` default: web_fetch_result - `Content BetaDocumentBlock` - `Type Document` default: document - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` default: false - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `Title string` The title of the document - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `URL string` Fetched content URL - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebFetchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlock` - `Type AdvisorToolResult` default: advisor_tool_result - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError` - `Type AdvisorToolResultError` default: advisor_tool_result_error - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodeModelNotFound BetaAdvisorToolResultErrorErrorCode = "model_not_found"` - `type BetaAdvisorResultBlock` - `Type AdvisorResult` default: advisor_result - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `type BetaAdvisorRedactedResultBlock` - `Type AdvisorRedactedResult` default: advisor_redacted_result - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaCodeExecutionToolResultBlock` - `Type CodeExecutionToolResult` default: code_execution_tool_result - `Content BetaCodeExecutionToolResultBlockContentUnion` - `type BetaCodeExecutionToolResultError` - `Type CodeExecutionToolResultError` default: code_execution_tool_result_error - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlock` - `Type CodeExecutionResult` default: code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` default: encrypted_code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaBashCodeExecutionToolResultBlock` - `Type BashCodeExecutionToolResult` default: bash_code_execution_tool_result - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError` - `Type BashCodeExecutionToolResultError` default: bash_code_execution_tool_result_error - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlock` - `Type BashCodeExecutionResult` default: bash_code_execution_result - `Content []BetaBashCodeExecutionOutputBlock` - `Type BashCodeExecutionOutput` default: bash_code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaTextEditorCodeExecutionToolResultBlock` - `Type TextEditorCodeExecutionToolResult` default: text_editor_code_execution_tool_result - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError` - `Type TextEditorCodeExecutionToolResultError` default: text_editor_code_execution_tool_result_error - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlock` - `Type TextEditorCodeExecutionViewResult` default: text_editor_code_execution_view_result - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlock` - `Type TextEditorCodeExecutionCreateResult` default: text_editor_code_execution_create_result - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock` - `Type TextEditorCodeExecutionStrReplaceResult` default: text_editor_code_execution_str_replace_result - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaToolSearchToolResultBlock` - `Type ToolSearchToolResult` default: tool_search_tool_result - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError` - `Type ToolSearchToolResultError` default: tool_search_tool_result_error - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"` - `ErrorMessage string` - `type BetaToolSearchToolSearchResultBlock` - `Type ToolSearchToolSearchResult` default: tool_search_tool_search_result - `ToolReferences []BetaToolReferenceBlock` - `Type ToolReference` default: tool_reference - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaMCPToolUseBlock` - `Type MCPToolUse` default: mcp_tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` The name of the MCP tool - `ServerName string` The name of the MCP server - `type BetaMCPToolResultBlock` - `Type MCPToolResult` default: mcp_tool_result - `Content BetaMCPToolResultBlockContentUnion` - `string` - `[]BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `Text string` - `IsError bool` default: false - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `type BetaContainerUploadBlock` Response model for a file uploaded to the container. - `Type ContainerUpload` default: container_upload - `FileID string` - `type BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `Type Compaction` default: compaction - `Content string` Summary of compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` Signature over the summary, to be sent back with the block verbatim - `ToolChanges []BetaCompactionBlockToolChangeUnion Optional` 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` 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 ToolAddition` default: tool_addition - `Tool BetaResponseToolAdditionBlockToolUnion` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `type BetaResponseToolChangeToolReference` 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` default: tool_reference - `Name string` - `type BetaResponseToolChangeMCPToolReference` 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` default: mcp_tool_reference - `Name string` - `ServerName string` - `type BetaResponseToolChangeMCPToolsetReference` 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` default: mcp_toolset_reference - `ServerName string` - `type BetaToolChangeToolDefinition` 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` default: tool_definition - `Definition BetaResponseToolUnion` - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaResponseToolRemovalBlock` 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 ToolRemoval` default: tool_removal - `Tool BetaResponseToolRemovalBlockToolUnion` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `type BetaResponseToolChangeToolReference` 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 BetaResponseToolChangeMCPToolReference` 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 BetaResponseToolChangeMCPToolsetReference` 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 BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `Type Fallback` default: fallback - `From BetaFallbackInfo` The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `Trigger BetaFallbackRefusalTrigger` What caused the `from` model to hand over at this hop. - `Type Refusal` default: refusal - `Category BetaFallbackRefusalTriggerCategory` 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`. - `const BetaFallbackRefusalTriggerCategoryCyber BetaFallbackRefusalTriggerCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryBio BetaFallbackRefusalTriggerCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryFrontierLLM BetaFallbackRefusalTriggerCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryReasoningExtraction BetaFallbackRefusalTriggerCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaFallbackRefusalTriggerCategoryGeneralHarms BetaFallbackRefusalTriggerCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `type BetaMCPToolListingBlock` 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` default: mcp_tool_listing - `MCPServerName string` - `Tools []BetaMCPTool` - `InputSchema map[string, any]` - `Name string` - `Description string Optional` ### Beta Content Block Param - `type BetaContentBlockParamUnion interface{…}` - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` - `type BetaRequestDocumentBlockParam` - `Type Document` - `Source BetaRequestDocumentBlockSourceUnionParam` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `type BetaContentBlockSourceParam` - `Type Content` - `Content BetaContentBlockSourceContentUnionParam` - `string` - `[]BetaContentBlockSourceContentUnionParam` - `type BetaTextBlockParam` - `type BetaImageBlockParam` - `type BetaURLPDFSourceParam` - `Type URL` - `URL string` - `type BetaFileDocumentSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `Enabled bool Optional` - `Context string Optional` minLength: 1 - `Title string Optional` minLength: 1, maxLength: 500 - `type BetaSearchResultBlockParam` - `Type SearchResult` - `Content []BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `Source string` - `Title string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `type BetaThinkingBlockParam` - `Type Thinking` - `Signature string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `Thinking string` The `thinking` text of this block as returned by the API. - `type BetaRedactedThinkingBlockParam` - `Type RedactedThinking` - `Data string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `type BetaToolUseBlockParam` - `Type ToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1, maxLength: 200 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaToolResultBlockParam` - `Type ToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content []BetaToolResultBlockParamContentUnion Optional` - `[]BetaToolResultBlockParamContentUnion` - `type BetaTextBlockParam` - `type BetaImageBlockParam` - `type BetaSearchResultBlockParam` - `type BetaRequestDocumentBlockParam` - `type BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `Type BrowserState` - `Tabs []BetaBrowserStateTabEntryParam` 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`. maxItems: 100 - `TabID string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Title string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Active bool Optional` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `StateChanges []BetaBrowserStateChangeUnionParam Optional` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `type BetaBrowserStateChangeTabOpenedParam` 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. - `Type TabOpened` - `TabID string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadStartedParam` A file download that started during this call. - `Type DownloadStarted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadCompletedParam` 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). - `Type DownloadCompleted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Path string Optional` 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. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `SizeBytes int64 Optional` The completed download's size. minimum: 0 - `type BetaBrowserStateChangeDownloadFailedParam` A file download that failed — or was cancelled — during this call. - `Type DownloadFailed` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Error string Optional` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `IsError bool Optional` - `ToolsetName string Optional` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlockParam` - `Type ServerToolUse` - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `const BetaServerToolUseBlockParamNameWebSearch BetaServerToolUseBlockParamName = "web_search"` - `const BetaServerToolUseBlockParamNameWebFetch BetaServerToolUseBlockParamName = "web_fetch"` - `const BetaServerToolUseBlockParamNameCodeExecution BetaServerToolUseBlockParamName = "code_execution"` - `const BetaServerToolUseBlockParamNameBashCodeExecution BetaServerToolUseBlockParamName = "bash_code_execution"` - `const BetaServerToolUseBlockParamNameTextEditorCodeExecution BetaServerToolUseBlockParamName = "text_editor_code_execution"` - `const BetaServerToolUseBlockParamNameToolSearchToolRegex BetaServerToolUseBlockParamName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockParamNameToolSearchToolBm25 BetaServerToolUseBlockParamName = "tool_search_tool_bm25"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaServerToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlockParam` - `Type WebSearchToolResult` - `Content BetaWebSearchToolResultBlockParamContentUnion` - `[]BetaWebSearchResultBlockParam` - `Type WebSearchResult` - `EncryptedContent string` - `Title string` - `URL string` - `PageAge string Optional` - `type BetaWebSearchToolRequestErrorParam` - `Type WebSearchToolResultError` - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaWebSearchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlockParam` - `Type WebFetchToolResult` - `Content BetaWebFetchToolResultBlockParamContentUnion` - `type BetaWebFetchToolResultErrorBlockParam` - `Type WebFetchToolResultError` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlockParam` - `Type WebFetchResult` - `Content BetaRequestDocumentBlockParam` - `URL string` Fetched content URL - `RetrievedAt string Optional` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlockParam` - `Type AdvisorToolResult` - `Content BetaAdvisorToolResultBlockParamContentUnion` - `type BetaAdvisorToolResultErrorParam` - `Type AdvisorToolResultError` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodeModelNotFound BetaAdvisorToolResultErrorParamErrorCode = "model_not_found"` - `type BetaAdvisorResultBlockParam` - `Type AdvisorResult` - `Text string` - `StopReason string Optional` - `type BetaAdvisorRedactedResultBlockParam` - `Type AdvisorRedactedResult` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `StopReason string Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaCodeExecutionToolResultBlockParam` - `Type CodeExecutionToolResult` - `Content BetaCodeExecutionToolResultBlockParamContentUnion` - `type BetaCodeExecutionToolResultErrorParam` - `Type CodeExecutionToolResultError` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlockParam` - `Type CodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaBashCodeExecutionToolResultBlockParam` - `Type BashCodeExecutionToolResult` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnion` - `type BetaBashCodeExecutionToolResultErrorParam` - `Type BashCodeExecutionToolResultError` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorParamErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlockParam` - `Type BashCodeExecutionResult` - `Content []BetaBashCodeExecutionOutputBlockParam` - `Type BashCodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaTextEditorCodeExecutionToolResultBlockParam` - `Type TextEditorCodeExecutionToolResult` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnion` - `type BetaTextEditorCodeExecutionToolResultErrorParam` - `Type TextEditorCodeExecutionToolResultError` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "file_not_found"` - `ErrorMessage string Optional` - `type BetaTextEditorCodeExecutionViewResultBlockParam` - `Type TextEditorCodeExecutionViewResult` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `NumLines int64 Optional` - `StartLine int64 Optional` - `TotalLines int64 Optional` - `type BetaTextEditorCodeExecutionCreateResultBlockParam` - `Type TextEditorCodeExecutionCreateResult` - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `Type TextEditorCodeExecutionStrReplaceResult` - `Lines []string Optional` - `NewLines int64 Optional` - `NewStart int64 Optional` - `OldLines int64 Optional` - `OldStart int64 Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaToolSearchToolResultBlockParam` - `Type ToolSearchToolResult` - `Content BetaToolSearchToolResultBlockParamContentUnion` - `type BetaToolSearchToolResultErrorParam` - `Type ToolSearchToolResultError` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `ErrorMessage string Optional` - `type BetaToolSearchToolSearchResultBlockParam` - `Type ToolSearchToolSearchResult` - `ToolReferences []BetaToolReferenceBlockParam` - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaMCPToolUseBlockParam` - `Type MCPToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestMCPToolResultBlockParam` - `Type MCPToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content BetaRequestMCPToolResultBlockParamContentUnion Optional` - `string` - `[]BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `IsError bool Optional` - `type BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `Type ContainerUpload` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `Type Compaction` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content string Optional` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string Optional` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` The block's signature as returned, to be sent back verbatim - `ToolChanges []BetaCompactionBlockParamToolChangeUnion Optional` The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block. - `type BetaRequestToolAdditionBlockParam` 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 ToolAddition` - `Tool BetaRequestToolAdditionBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `Type ToolReference` - `Name string` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `Type MCPToolReference` - `Name string` - `ServerName string` - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `Type MCPToolsetReference` - `ServerName string` - `type BetaToolChangeToolDefinitionParam` 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. - `Type ToolDefinition` - `Definition BetaToolUnionParam` - `type BetaToolParam` - `Type BetaToolType Optional` - `InputSchema BetaToolInputSchemaParam` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `const BetaToolAllowedCallerCodeExecution20260521 BetaToolAllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestToolRemovalBlockParam` 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 ToolRemoval` - `Tool BetaRequestToolRemovalBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestToolAdditionBlockParam` 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` 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 BetaMCPToolListingBlockParam` 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. - `Type MCPToolListing` - `MCPServerName string` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `Tools []BetaMCPToolParam` The server's tools, exactly as the response listed them. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `Type Fallback` - `From BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Trigger any Optional` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. ### Beta Content Block Source - `type BetaContentBlockSourceParam` - `Type Content` - `Content BetaContentBlockSourceContentUnionParam` - `string` - `[]BetaContentBlockSourceContentUnionParam` - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` ### Beta Content Block Source Content - `type BetaContentBlockSourceContentUnionParam interface{…}` - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` ### Beta Context Management Config - `type BetaContextManagementConfigParam` - `Edits []BetaContextManagementConfigEditUnionParam Optional` List of context management edits to apply - `type BetaClearToolUses20250919EditParam` - `Type ClearToolUses20250919` - `ClearAtLeast BetaInputTokensClearAtLeastParam Optional` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `Type InputTokens` - `Value int64` minimum: 0 - `ClearToolInputs BetaClearToolUses20250919EditClearToolInputsUnionParam Optional` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `bool` - `[]string` - `ExcludeTools []string Optional` Tool names whose uses are preserved from clearing - `Keep BetaToolUsesKeepParam Optional` Number of tool uses to retain in the conversation - `Type ToolUses` - `Value int64` minimum: 0 - `Trigger BetaClearToolUses20250919EditTriggerUnionParam Optional` Condition that triggers the context management strategy - `type BetaInputTokensTriggerParam` - `Type InputTokens` - `Value int64` minimum: 1 - `type BetaToolUsesTriggerParam` - `Type ToolUses` - `Value int64` minimum: 1 - `type BetaClearThinking20251015EditParam` - `Type ClearThinking20251015` - `Keep BetaClearThinking20251015EditKeepUnionParam Optional` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `type BetaThinkingTurnsParam` - `Type ThinkingTurns` - `Value int64` minimum: 1 - `type BetaAllThinkingTurnsParam` - `Type All` - `All` - `type BetaCompact20260112EditParam` Automatically compact older context when reaching the configured trigger threshold. - `Type Compact20260112` - `Instructions string Optional` Additional instructions for summarization. - `PauseAfterCompaction bool Optional` Whether to pause after compaction and return the compaction block to the user. - `Trigger BetaInputTokensTriggerParam Optional` When to trigger compaction. Defaults to 150000 input tokens. ### Beta Context Management Response - `type BetaContextManagementResponse` - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `type BetaClearToolUses20250919EditResponse` - `Type ClearToolUses20250919` The type of context management edit applied. default: clear_tool_uses_20250919 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedToolUses int64` Number of tool uses that were cleared. minimum: 0 - `type BetaClearThinking20251015EditResponse` - `Type ClearThinking20251015` The type of context management edit applied. default: clear_thinking_20251015 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedThinkingTurns int64` Number of thinking turns that were cleared. minimum: 0 ### Beta Count Tokens Context Management Response - `type BetaCountTokensContextManagementResponse` - `OriginalInputTokens int64` The original token count before context management was applied ### Beta Diagnostics - `type BetaDiagnostics` Request-level diagnostics: why the prompt cache could not fully reuse the prefix of the request named by `diagnostics.previous_message_id`. - `CacheMissReason BetaCacheMissReasonUnion` 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 BetaCacheMissModelChanged` - `Type ModelChanged` default: model_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissSystemChanged` - `Type SystemChanged` default: system_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissToolsChanged` - `Type ToolsChanged` default: tools_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissMessagesChanged` - `Type MessagesChanged` default: messages_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissPreviousMessageNotFound` - `Type PreviousMessageNotFound` default: previous_message_not_found - `type BetaCacheMissUnavailable` - `Type Unavailable` default: unavailable ### Beta Diagnostics Param - `type BetaDiagnosticsParam` Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `PreviousMessageID string Optional` 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. maxLength: 256 ### Beta Direct Caller - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` ### Beta Document Block - `type BetaDocumentBlock` - `Type Document` default: document - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` default: false - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `Title string` The title of the document ### Beta Encrypted Code Execution Result Block - `type BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` default: encrypted_code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` ### Beta Encrypted Code Execution Result Block Param - `type BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` ### Beta Fallback Block - `type BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `Type Fallback` default: fallback - `From BetaFallbackInfo` The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `To BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `Trigger BetaFallbackRefusalTrigger` What caused the `from` model to hand over at this hop. - `Type Refusal` default: refusal - `Category BetaFallbackRefusalTriggerCategory` 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`. - `const BetaFallbackRefusalTriggerCategoryCyber BetaFallbackRefusalTriggerCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryBio BetaFallbackRefusalTriggerCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryFrontierLLM BetaFallbackRefusalTriggerCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryReasoningExtraction BetaFallbackRefusalTriggerCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaFallbackRefusalTriggerCategoryGeneralHarms BetaFallbackRefusalTriggerCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. ### Beta Fallback Block Param - `type BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `Type Fallback` - `From BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `To BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Trigger any Optional` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. ### Beta Fallback Credit Not Applied - `type BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `Type NotApplied` default: not_applied - `Reason BetaFallbackCreditNotAppliedReason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `const BetaFallbackCreditNotAppliedReasonBodyMismatch BetaFallbackCreditNotAppliedReason = "body_mismatch"` - `const BetaFallbackCreditNotAppliedReasonContinuationExcluded BetaFallbackCreditNotAppliedReason = "continuation_excluded"` - `const BetaFallbackCreditNotAppliedReasonContinuationOnly BetaFallbackCreditNotAppliedReason = "continuation_only"` - `const BetaFallbackCreditNotAppliedReasonExpired BetaFallbackCreditNotAppliedReason = "expired"` - `const BetaFallbackCreditNotAppliedReasonInvalidTargetModel BetaFallbackCreditNotAppliedReason = "invalid_target_model"` - `const BetaFallbackCreditNotAppliedReasonNotEnabled BetaFallbackCreditNotAppliedReason = "not_enabled"` - `const BetaFallbackCreditNotAppliedReasonRepriceUnavailable BetaFallbackCreditNotAppliedReason = "reprice_unavailable"` - `const BetaFallbackCreditNotAppliedReasonTemporarilyUnavailable BetaFallbackCreditNotAppliedReason = "temporarily_unavailable"` - `const BetaFallbackCreditNotAppliedReasonVariantFieldsPresent BetaFallbackCreditNotAppliedReason = "variant_fields_present"` - `const BetaFallbackCreditNotAppliedReasonWrongOrganization BetaFallbackCreditNotAppliedReason = "wrong_organization"` - `const BetaFallbackCreditNotAppliedReasonWrongPlatform BetaFallbackCreditNotAppliedReason = "wrong_platform"` - `const BetaFallbackCreditNotAppliedReasonWrongWorkspace BetaFallbackCreditNotAppliedReason = "wrong_workspace"` - `RemoveToRedeem []string Optional` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. ### Beta Fallback Credit Redeemed - `type BetaFallbackCreditRedeemed` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `Type Redeemed` default: redeemed ### Beta Fallback Credit Token Param - `type BetaFallbackCreditTokenParam` Object form of `fallback_credit_token`: the token plus a redemption mode. Requires `anthropic-beta: fallback-credit-2026-07-01`; without that header the field accepts the bare string only. The bare string and the mode-less object are equivalent (both select `strict`), so wrapping an existing token changes nothing by itself. - `Token string` The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries. minLength: 1, maxLength: 2048 - `Mode BetaFallbackCreditTokenParamMode Optional` 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`. - `const BetaFallbackCreditTokenParamModeStrict BetaFallbackCreditTokenParamMode = "strict"` - `const BetaFallbackCreditTokenParamModeBestEffort BetaFallbackCreditTokenParamMode = "best_effort"` ### Beta Fallback Credit Usage - `type BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. - `Status BetaFallbackCreditUsageStatusUnion` 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` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `Type Redeemed` default: redeemed - `type BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `Type NotApplied` default: not_applied - `Reason BetaFallbackCreditNotAppliedReason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `const BetaFallbackCreditNotAppliedReasonBodyMismatch BetaFallbackCreditNotAppliedReason = "body_mismatch"` - `const BetaFallbackCreditNotAppliedReasonContinuationExcluded BetaFallbackCreditNotAppliedReason = "continuation_excluded"` - `const BetaFallbackCreditNotAppliedReasonContinuationOnly BetaFallbackCreditNotAppliedReason = "continuation_only"` - `const BetaFallbackCreditNotAppliedReasonExpired BetaFallbackCreditNotAppliedReason = "expired"` - `const BetaFallbackCreditNotAppliedReasonInvalidTargetModel BetaFallbackCreditNotAppliedReason = "invalid_target_model"` - `const BetaFallbackCreditNotAppliedReasonNotEnabled BetaFallbackCreditNotAppliedReason = "not_enabled"` - `const BetaFallbackCreditNotAppliedReasonRepriceUnavailable BetaFallbackCreditNotAppliedReason = "reprice_unavailable"` - `const BetaFallbackCreditNotAppliedReasonTemporarilyUnavailable BetaFallbackCreditNotAppliedReason = "temporarily_unavailable"` - `const BetaFallbackCreditNotAppliedReasonVariantFieldsPresent BetaFallbackCreditNotAppliedReason = "variant_fields_present"` - `const BetaFallbackCreditNotAppliedReasonWrongOrganization BetaFallbackCreditNotAppliedReason = "wrong_organization"` - `const BetaFallbackCreditNotAppliedReasonWrongPlatform BetaFallbackCreditNotAppliedReason = "wrong_platform"` - `const BetaFallbackCreditNotAppliedReasonWrongWorkspace BetaFallbackCreditNotAppliedReason = "wrong_workspace"` - `RemoveToRedeem []string Optional` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. ### Beta Fallback Info - `type BetaFallbackInfo` Identifies one hop of a fallback transition. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding ### Beta Fallback Info Param - `type BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding ### Beta Fallback Message Iteration Usage - `type BetaFallbackMessageIterationUsage` 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 FallbackMessage` Usage for the fallback-model attempt that served the response default: fallback_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `OutputTokens int64` The number of output tokens which were used. minimum: 0 ### Beta Fallback Param - `type BetaFallbackParam` One entry in the `fallbacks` chain on a `/v1/messages` request. `model` is required. The override fields (`max_tokens`, `thinking`, `output_config`, and `speed`) set the corresponding parameter for this attempt only and are validated as if the request were made to `model`. Any other key is rejected at parse time. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `MaxTokens int64 Optional` - `OutputConfig BetaOutputConfigParam Optional` - `Effort BetaOutputConfigEffort Optional` 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`. - `const BetaOutputConfigEffortLow BetaOutputConfigEffort = "low"` - `const BetaOutputConfigEffortMedium BetaOutputConfigEffort = "medium"` - `const BetaOutputConfigEffortHigh BetaOutputConfigEffort = "high"` - `const BetaOutputConfigEffortXhigh BetaOutputConfigEffort = "xhigh"` - `const BetaOutputConfigEffortMax BetaOutputConfigEffort = "max"` - `Format BetaJSONOutputFormatParam Optional` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=go) - `Type JSONSchema` - `Schema map[string, any]` The JSON schema of the format - `TaskBudget BetaTokenTaskBudgetParam Optional` Configuration for token budget tracking across contexts. - `Type Tokens` The budget type. Currently only 'tokens' is supported. - `Total int64` Total token budget across all contexts in the session. minimum: 1024 - `Remaining int64 Optional` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. minimum: 0 - `Speed BetaFallbackParamSpeed Optional` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaFallbackParamSpeedStandard BetaFallbackParamSpeed = "standard"` - `const BetaFallbackParamSpeedFast BetaFallbackParamSpeed = "fast"` - `Thinking BetaFallbackParamThinkingUnion Optional` - `type BetaThinkingConfigEnabledParam` - `Type Enabled` - `BudgetTokens int64` 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](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. minimum: 1024 - `BlockBinding BetaThinkingBlockBindingParam Optional` 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`. - `const BetaThinkingPrefixMismatchBehaviorError BetaThinkingPrefixMismatchBehavior = "error"` - `const BetaThinkingPrefixMismatchBehaviorDropBlock BetaThinkingPrefixMismatchBehavior = "drop_block"` - `Display BetaThinkingConfigEnabledDisplay Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#controlling-thinking-display). - `const BetaThinkingConfigEnabledDisplaySummarized BetaThinkingConfigEnabledDisplay = "summarized"` - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` - `type BetaThinkingConfigDisabledParam` - `Type Disabled` - `type BetaThinkingConfigBetweenToolsParam` - `Type BetweenTools` - `type BetaThinkingConfigAdaptiveParam` - `Type Adaptive` - `BlockBinding BetaThinkingBlockBindingParam Optional` 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. - `Display BetaThinkingConfigAdaptiveDisplay Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#controlling-thinking-display). - `const BetaThinkingConfigAdaptiveDisplaySummarized BetaThinkingConfigAdaptiveDisplay = "summarized"` - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` ### Beta Fallback Refusal Trigger - `type BetaFallbackRefusalTrigger` The `from` model declined for policy reasons. - `Type Refusal` default: refusal - `Category BetaFallbackRefusalTriggerCategory` 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`. - `const BetaFallbackRefusalTriggerCategoryCyber BetaFallbackRefusalTriggerCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryBio BetaFallbackRefusalTriggerCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryFrontierLLM BetaFallbackRefusalTriggerCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryReasoningExtraction BetaFallbackRefusalTriggerCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaFallbackRefusalTriggerCategoryGeneralHarms BetaFallbackRefusalTriggerCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. ### Beta Fallbacks Param - `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](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=go#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. - `[]BetaFallbackParam` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `MaxTokens int64 Optional` - `OutputConfig BetaOutputConfigParam Optional` - `Effort BetaOutputConfigEffort Optional` 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`. - `const BetaOutputConfigEffortLow BetaOutputConfigEffort = "low"` - `const BetaOutputConfigEffortMedium BetaOutputConfigEffort = "medium"` - `const BetaOutputConfigEffortHigh BetaOutputConfigEffort = "high"` - `const BetaOutputConfigEffortXhigh BetaOutputConfigEffort = "xhigh"` - `const BetaOutputConfigEffortMax BetaOutputConfigEffort = "max"` - `Format BetaJSONOutputFormatParam Optional` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=go) - `Type JSONSchema` - `Schema map[string, any]` The JSON schema of the format - `TaskBudget BetaTokenTaskBudgetParam Optional` Configuration for token budget tracking across contexts. - `Type Tokens` The budget type. Currently only 'tokens' is supported. - `Total int64` Total token budget across all contexts in the session. minimum: 1024 - `Remaining int64 Optional` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. minimum: 0 - `Speed BetaFallbackParamSpeed Optional` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaFallbackParamSpeedStandard BetaFallbackParamSpeed = "standard"` - `const BetaFallbackParamSpeedFast BetaFallbackParamSpeed = "fast"` - `Thinking BetaFallbackParamThinkingUnion Optional` - `type BetaThinkingConfigEnabledParam` - `Type Enabled` - `BudgetTokens int64` 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](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. minimum: 1024 - `BlockBinding BetaThinkingBlockBindingParam Optional` 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`. - `const BetaThinkingPrefixMismatchBehaviorError BetaThinkingPrefixMismatchBehavior = "error"` - `const BetaThinkingPrefixMismatchBehaviorDropBlock BetaThinkingPrefixMismatchBehavior = "drop_block"` - `Display BetaThinkingConfigEnabledDisplay Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#controlling-thinking-display). - `const BetaThinkingConfigEnabledDisplaySummarized BetaThinkingConfigEnabledDisplay = "summarized"` - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` - `type BetaThinkingConfigDisabledParam` - `Type Disabled` - `type BetaThinkingConfigBetweenToolsParam` - `Type BetweenTools` - `type BetaThinkingConfigAdaptiveParam` - `Type Adaptive` - `BlockBinding BetaThinkingBlockBindingParam Optional` 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. - `Display BetaThinkingConfigAdaptiveDisplay Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#controlling-thinking-display). - `const BetaThinkingConfigAdaptiveDisplaySummarized BetaThinkingConfigAdaptiveDisplay = "summarized"` - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` - `Default` ### Beta File Document Source - `type BetaFileDocumentSourceParam` - `Type File` - `FileID string` ### Beta File Image Source - `type BetaFileImageSourceParam` - `Type File` - `FileID string` ### Beta Image Block Param - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` ### Beta Image Transformations Param - `type BetaImageTransformationsParam` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `OversizedImage BetaImageTransformationsParamOversizedImage Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` ### Beta Input JSON Delta - `type BetaInputJSONDelta` - `Type InputJSONDelta` default: input_json_delta - `PartialJSON string` ### Beta Input Tokens Clear At Least - `type BetaInputTokensClearAtLeastParam` - `Type InputTokens` - `Value int64` minimum: 0 ### Beta Input Tokens Trigger - `type BetaInputTokensTriggerParam` - `Type InputTokens` - `Value int64` minimum: 1 ### Beta Input Transformation - `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. - `type BetaThinkingDroppedInputTransformation` - `Type ThinkingDropped` Always `thinking_dropped` for this entry type. default: thinking_dropped - `Path string` 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 BetaThinkingDroppedInputTransformationReason` 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`. - `const BetaThinkingDroppedInputTransformationReasonModelBindingMismatch BetaThinkingDroppedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonPrefixBindingMismatch BetaThinkingDroppedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonOrganizationBindingMismatch BetaThinkingDroppedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonEndUserBindingMismatch BetaThinkingDroppedInputTransformationReason = "end_user_binding_mismatch"` - `type BetaThinkingMismatchAllowedInputTransformation` - `Type ThinkingMismatchAllowed` Always `thinking_mismatch_allowed` for this entry type. default: thinking_mismatch_allowed - `Path string` 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 BetaThinkingMismatchAllowedInputTransformationReason` 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. - `const BetaThinkingMismatchAllowedInputTransformationReasonModelBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonPrefixBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonOrganizationBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonEndUserBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "end_user_binding_mismatch"` ### Beta Iterations Usage - `type BetaIterationsUsage []BetaIterationsUsageItemUnion` 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 `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `type BetaMessageIterationUsage` Token usage for a sampling iteration. - `Type Message` Usage for a sampling iteration default: message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaCompactionIterationUsage` Token usage for a compaction iteration. - `Type Compaction` Usage for a compaction iteration default: compaction - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration default: advisor_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaFallbackMessageIterationUsage` 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 FallbackMessage` Usage for the fallback-model attempt that served the response default: fallback_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 ### Beta JSON Output Format - `type BetaJSONOutputFormatParam` - `Type JSONSchema` - `Schema map[string, any]` The JSON schema of the format ### Beta MCP Tool - `type BetaMCPTool` A tool as an MCP server lists it: its name on that server, its description, and its input schema. - `InputSchema map[string, any]` - `Name string` - `Description string Optional` ### Beta MCP Tool Config - `type BetaMCPToolConfig` Configuration for a specific tool in an MCP toolset. - `DeferLoading bool Optional` - `Enabled bool Optional` ### Beta MCP Tool Default Config - `type BetaMCPToolDefaultConfig` Default configuration for tools in an MCP toolset. - `DeferLoading bool Optional` - `Enabled bool Optional` ### Beta MCP Tool Listing Block - `type BetaMCPToolListingBlock` 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` default: mcp_tool_listing - `MCPServerName string` - `Tools []BetaMCPTool` - `InputSchema map[string, any]` - `Name string` - `Description string Optional` ### Beta MCP Tool Listing Block Param - `type BetaMCPToolListingBlockParam` 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. - `Type MCPToolListing` - `MCPServerName string` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `Tools []BetaMCPToolParam` The server's tools, exactly as the response listed them. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. ### Beta MCP Tool Param - `type BetaMCPToolParamResp` A tool as an MCP server lists it: its name on that server, its description, and its input schema. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. ### Beta MCP Tool Result Block - `type BetaMCPToolResultBlock` - `Type MCPToolResult` default: mcp_tool_result - `Content BetaMCPToolResultBlockContentUnion` - `string` - `[]BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `Text string` - `IsError bool` default: false - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ ### Beta MCP Tool Use Block - `type BetaMCPToolUseBlock` - `Type MCPToolUse` default: mcp_tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` The name of the MCP tool - `ServerName string` The name of the MCP server ### Beta MCP Tool Use Block Param - `type BetaMCPToolUseBlockParam` - `Type MCPToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta MCP Toolset - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. ### Beta Memory Tool 20250818 - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Memory Tool 20250818 Command - `type BetaMemoryTool20250818CommandUnion interface{…}` - `type BetaMemoryTool20250818ViewCommand` - `Command View` Command type identifier default: view - `Path string` Path to directory or file to view - `ViewRange []int64 Optional` Optional line range for viewing specific lines minItems: 2, maxItems: 2 - `type BetaMemoryTool20250818CreateCommand` - `Command Create` Command type identifier default: create - `FileText string` Content to write to the file - `Path string` Path where the file should be created - `type BetaMemoryTool20250818StrReplaceCommand` - `Command StrReplace` Command type identifier default: str_replace - `NewStr string` Text to replace with - `OldStr string` Text to search for and replace - `Path string` Path to the file where text should be replaced - `type BetaMemoryTool20250818InsertCommand` - `Command Insert` Command type identifier default: insert - `InsertLine int64` Line number where text should be inserted minimum: 1 - `InsertText string` Text to insert at the specified line - `Path string` Path to the file where text should be inserted - `type BetaMemoryTool20250818DeleteCommand` - `Command Delete` Command type identifier default: delete - `Path string` Path to the file or directory to delete - `type BetaMemoryTool20250818RenameCommand` - `Command Rename` Command type identifier default: rename - `NewPath string` New path for the file or directory - `OldPath string` Current path of the file or directory ### Beta Memory Tool 20250818 Create Command - `type BetaMemoryTool20250818CreateCommand` - `Command Create` Command type identifier default: create - `FileText string` Content to write to the file - `Path string` Path where the file should be created ### Beta Memory Tool 20250818 Delete Command - `type BetaMemoryTool20250818DeleteCommand` - `Command Delete` Command type identifier default: delete - `Path string` Path to the file or directory to delete ### Beta Memory Tool 20250818 Insert Command - `type BetaMemoryTool20250818InsertCommand` - `Command Insert` Command type identifier default: insert - `InsertLine int64` Line number where text should be inserted minimum: 1 - `InsertText string` Text to insert at the specified line - `Path string` Path to the file where text should be inserted ### Beta Memory Tool 20250818 Rename Command - `type BetaMemoryTool20250818RenameCommand` - `Command Rename` Command type identifier default: rename - `NewPath string` New path for the file or directory - `OldPath string` Current path of the file or directory ### Beta Memory Tool 20250818 Str Replace Command - `type BetaMemoryTool20250818StrReplaceCommand` - `Command StrReplace` Command type identifier default: str_replace - `NewStr string` Text to replace with - `OldStr string` Text to search for and replace - `Path string` Path to the file where text should be replaced ### Beta Memory Tool 20250818 View Command - `type BetaMemoryTool20250818ViewCommand` - `Command View` Command type identifier default: view - `Path string` Path to directory or file to view - `ViewRange []int64 Optional` Optional line range for viewing specific lines minItems: 2, maxItems: 2 ### Beta Message - `type BetaMessage` - `Type Message` Object type. For Messages, this is always `"message"`. default: message - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. format: date-time - `Skills []BetaContainerSkill` Skills loaded in the container - `Type BetaContainerSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaContainerSkillTypeAnthropic BetaContainerSkillType = "anthropic"` - `const BetaContainerSkillTypeCustom BetaContainerSkillType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `Text string` - `type BetaThinkingBlock` - `Type Thinking` default: thinking - `Signature string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. - `Thinking string` The text of Claude's thinking process for this block. - `type BetaRedactedThinkingBlock` - `Type RedactedThinking` default: redacted_thinking - `Data string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go#redacted-thinking-blocks) for details. - `type BetaToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1 - `Caller BetaToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlock` - `Type ServerToolUse` default: server_tool_use - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"` - `const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"` - `const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"` - `const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"` - `const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"` - `const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"` - `Caller BetaServerToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlock` - `Type WebSearchToolResult` default: web_search_tool_result - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError` - `Type WebSearchToolResultError` default: web_search_tool_result_error - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `[]BetaWebSearchResultBlock` - `Type WebSearchResult` default: web_search_result - `EncryptedContent string` - `PageAge string` - `Title string` - `URL string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebSearchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlock` - `Type WebFetchToolResult` default: web_fetch_tool_result - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock` - `Type WebFetchToolResultError` default: web_fetch_tool_result_error - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlock` - `Type WebFetchResult` default: web_fetch_result - `Content BetaDocumentBlock` - `Type Document` default: document - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` default: false - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `Title string` The title of the document - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `URL string` Fetched content URL - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebFetchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlock` - `Type AdvisorToolResult` default: advisor_tool_result - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError` - `Type AdvisorToolResultError` default: advisor_tool_result_error - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodeModelNotFound BetaAdvisorToolResultErrorErrorCode = "model_not_found"` - `type BetaAdvisorResultBlock` - `Type AdvisorResult` default: advisor_result - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `type BetaAdvisorRedactedResultBlock` - `Type AdvisorRedactedResult` default: advisor_redacted_result - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaCodeExecutionToolResultBlock` - `Type CodeExecutionToolResult` default: code_execution_tool_result - `Content BetaCodeExecutionToolResultBlockContentUnion` - `type BetaCodeExecutionToolResultError` - `Type CodeExecutionToolResultError` default: code_execution_tool_result_error - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlock` - `Type CodeExecutionResult` default: code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` default: encrypted_code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaBashCodeExecutionToolResultBlock` - `Type BashCodeExecutionToolResult` default: bash_code_execution_tool_result - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError` - `Type BashCodeExecutionToolResultError` default: bash_code_execution_tool_result_error - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlock` - `Type BashCodeExecutionResult` default: bash_code_execution_result - `Content []BetaBashCodeExecutionOutputBlock` - `Type BashCodeExecutionOutput` default: bash_code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaTextEditorCodeExecutionToolResultBlock` - `Type TextEditorCodeExecutionToolResult` default: text_editor_code_execution_tool_result - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError` - `Type TextEditorCodeExecutionToolResultError` default: text_editor_code_execution_tool_result_error - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlock` - `Type TextEditorCodeExecutionViewResult` default: text_editor_code_execution_view_result - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlock` - `Type TextEditorCodeExecutionCreateResult` default: text_editor_code_execution_create_result - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock` - `Type TextEditorCodeExecutionStrReplaceResult` default: text_editor_code_execution_str_replace_result - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaToolSearchToolResultBlock` - `Type ToolSearchToolResult` default: tool_search_tool_result - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError` - `Type ToolSearchToolResultError` default: tool_search_tool_result_error - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"` - `ErrorMessage string` - `type BetaToolSearchToolSearchResultBlock` - `Type ToolSearchToolSearchResult` default: tool_search_tool_search_result - `ToolReferences []BetaToolReferenceBlock` - `Type ToolReference` default: tool_reference - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaMCPToolUseBlock` - `Type MCPToolUse` default: mcp_tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` The name of the MCP tool - `ServerName string` The name of the MCP server - `type BetaMCPToolResultBlock` - `Type MCPToolResult` default: mcp_tool_result - `Content BetaMCPToolResultBlockContentUnion` - `string` - `[]BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `Text string` - `IsError bool` default: false - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `type BetaContainerUploadBlock` Response model for a file uploaded to the container. - `Type ContainerUpload` default: container_upload - `FileID string` - `type BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `Type Compaction` default: compaction - `Content string` Summary of compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` Signature over the summary, to be sent back with the block verbatim - `ToolChanges []BetaCompactionBlockToolChangeUnion Optional` 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` 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 ToolAddition` default: tool_addition - `Tool BetaResponseToolAdditionBlockToolUnion` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `type BetaResponseToolChangeToolReference` 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` default: tool_reference - `Name string` - `type BetaResponseToolChangeMCPToolReference` 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` default: mcp_tool_reference - `Name string` - `ServerName string` - `type BetaResponseToolChangeMCPToolsetReference` 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` default: mcp_toolset_reference - `ServerName string` - `type BetaToolChangeToolDefinition` 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` default: tool_definition - `Definition BetaResponseToolUnion` - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaResponseToolRemovalBlock` 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 ToolRemoval` default: tool_removal - `Tool BetaResponseToolRemovalBlockToolUnion` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `type BetaResponseToolChangeToolReference` 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 BetaResponseToolChangeMCPToolReference` 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 BetaResponseToolChangeMCPToolsetReference` 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 BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `Type Fallback` default: fallback - `From BetaFallbackInfo` The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `Trigger BetaFallbackRefusalTrigger` What caused the `from` model to hand over at this hop. - `Type Refusal` default: refusal - `Category BetaFallbackRefusalTriggerCategory` 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`. - `const BetaFallbackRefusalTriggerCategoryCyber BetaFallbackRefusalTriggerCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryBio BetaFallbackRefusalTriggerCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryFrontierLLM BetaFallbackRefusalTriggerCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryReasoningExtraction BetaFallbackRefusalTriggerCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaFallbackRefusalTriggerCategoryGeneralHarms BetaFallbackRefusalTriggerCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `type BetaMCPToolListingBlock` 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` default: mcp_tool_listing - `MCPServerName string` - `Tools []BetaMCPTool` - `InputSchema map[string, any]` - `Name string` - `Description string Optional` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `type BetaClearToolUses20250919EditResponse` - `Type ClearToolUses20250919` The type of context management edit applied. default: clear_tool_uses_20250919 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedToolUses int64` Number of tool uses that were cleared. minimum: 0 - `type BetaClearThinking20251015EditResponse` - `Type ClearThinking20251015` The type of context management edit applied. default: clear_thinking_20251015 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedThinkingTurns int64` Number of thinking turns that were cleared. minimum: 0 - `Diagnostics BetaDiagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `CacheMissReason BetaCacheMissReasonUnion` 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 BetaCacheMissModelChanged` - `Type ModelChanged` default: model_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissSystemChanged` - `Type SystemChanged` default: system_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissToolsChanged` - `Type ToolsChanged` default: tools_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissMessagesChanged` - `Type MessagesChanged` default: messages_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissPreviousMessageNotFound` - `Type PreviousMessageNotFound` default: previous_message_not_found - `type BetaCacheMissUnavailable` - `Type Unavailable` default: unavailable - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `StopDetails BetaRefusalStopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `Type Refusal` default: refusal - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaRefusalStopDetailsCategoryFrontierLLM BetaRefusalStopDetailsCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaRefusalStopDetailsCategoryReasoningExtraction BetaRefusalStopDetailsCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaRefusalStopDetailsCategoryGeneralHarms BetaRefusalStopDetailsCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `FallbackCreditToken string` Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit. - `FallbackHasPrefillClaim bool` Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token. - `RecommendedModel string` The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise. - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Usage BetaUsage` 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`. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. minimum: 0 - `FallbackCredit BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `Status BetaFallbackCreditUsageStatusUnion` 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` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `Type Redeemed` default: redeemed - `type BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `Type NotApplied` default: not_applied - `Reason BetaFallbackCreditNotAppliedReason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `const BetaFallbackCreditNotAppliedReasonBodyMismatch BetaFallbackCreditNotAppliedReason = "body_mismatch"` - `const BetaFallbackCreditNotAppliedReasonContinuationExcluded BetaFallbackCreditNotAppliedReason = "continuation_excluded"` - `const BetaFallbackCreditNotAppliedReasonContinuationOnly BetaFallbackCreditNotAppliedReason = "continuation_only"` - `const BetaFallbackCreditNotAppliedReasonExpired BetaFallbackCreditNotAppliedReason = "expired"` - `const BetaFallbackCreditNotAppliedReasonInvalidTargetModel BetaFallbackCreditNotAppliedReason = "invalid_target_model"` - `const BetaFallbackCreditNotAppliedReasonNotEnabled BetaFallbackCreditNotAppliedReason = "not_enabled"` - `const BetaFallbackCreditNotAppliedReasonRepriceUnavailable BetaFallbackCreditNotAppliedReason = "reprice_unavailable"` - `const BetaFallbackCreditNotAppliedReasonTemporarilyUnavailable BetaFallbackCreditNotAppliedReason = "temporarily_unavailable"` - `const BetaFallbackCreditNotAppliedReasonVariantFieldsPresent BetaFallbackCreditNotAppliedReason = "variant_fields_present"` - `const BetaFallbackCreditNotAppliedReasonWrongOrganization BetaFallbackCreditNotAppliedReason = "wrong_organization"` - `const BetaFallbackCreditNotAppliedReasonWrongPlatform BetaFallbackCreditNotAppliedReason = "wrong_platform"` - `const BetaFallbackCreditNotAppliedReasonWrongWorkspace BetaFallbackCreditNotAppliedReason = "wrong_workspace"` - `RemoveToRedeem []string Optional` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Iterations BetaIterationsUsage` 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 `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `type BetaMessageIterationUsage` Token usage for a sampling iteration. - `Type Message` Usage for a sampling iteration default: message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaCompactionIterationUsage` Token usage for a compaction iteration. - `Type Compaction` Usage for a compaction iteration default: compaction - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration default: advisor_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaFallbackMessageIterationUsage` 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 FallbackMessage` Usage for the fallback-model attempt that served the response default: fallback_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokensDetails BetaOutputTokensDetails` 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. - `ThinkingTokens int64` 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. default: 0, minimum: 0 - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. default: 0, minimum: 0 - `WebSearchRequests int64` The number of web search tool requests. default: 0, minimum: 0 - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` - `InputTransformations []BetaInputTransformationUnion Optional` Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`. - `type BetaThinkingDroppedInputTransformation` - `Type ThinkingDropped` Always `thinking_dropped` for this entry type. default: thinking_dropped - `Path string` 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 BetaThinkingDroppedInputTransformationReason` 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`. - `const BetaThinkingDroppedInputTransformationReasonModelBindingMismatch BetaThinkingDroppedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonPrefixBindingMismatch BetaThinkingDroppedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonOrganizationBindingMismatch BetaThinkingDroppedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonEndUserBindingMismatch BetaThinkingDroppedInputTransformationReason = "end_user_binding_mismatch"` - `type BetaThinkingMismatchAllowedInputTransformation` - `Type ThinkingMismatchAllowed` Always `thinking_mismatch_allowed` for this entry type. default: thinking_mismatch_allowed - `Path string` 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 BetaThinkingMismatchAllowedInputTransformationReason` 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. - `const BetaThinkingMismatchAllowedInputTransformationReasonModelBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonPrefixBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonOrganizationBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonEndUserBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "end_user_binding_mismatch"` ### Beta Message Delta Usage - `type BetaMessageDeltaUsage` - `CacheCreationInputTokens int64` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `CacheReadInputTokens int64` The cumulative number of input tokens read from the cache. minimum: 0 - `FallbackCredit BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `Status BetaFallbackCreditUsageStatusUnion` 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` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `Type Redeemed` default: redeemed - `type BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `Type NotApplied` default: not_applied - `Reason BetaFallbackCreditNotAppliedReason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `const BetaFallbackCreditNotAppliedReasonBodyMismatch BetaFallbackCreditNotAppliedReason = "body_mismatch"` - `const BetaFallbackCreditNotAppliedReasonContinuationExcluded BetaFallbackCreditNotAppliedReason = "continuation_excluded"` - `const BetaFallbackCreditNotAppliedReasonContinuationOnly BetaFallbackCreditNotAppliedReason = "continuation_only"` - `const BetaFallbackCreditNotAppliedReasonExpired BetaFallbackCreditNotAppliedReason = "expired"` - `const BetaFallbackCreditNotAppliedReasonInvalidTargetModel BetaFallbackCreditNotAppliedReason = "invalid_target_model"` - `const BetaFallbackCreditNotAppliedReasonNotEnabled BetaFallbackCreditNotAppliedReason = "not_enabled"` - `const BetaFallbackCreditNotAppliedReasonRepriceUnavailable BetaFallbackCreditNotAppliedReason = "reprice_unavailable"` - `const BetaFallbackCreditNotAppliedReasonTemporarilyUnavailable BetaFallbackCreditNotAppliedReason = "temporarily_unavailable"` - `const BetaFallbackCreditNotAppliedReasonVariantFieldsPresent BetaFallbackCreditNotAppliedReason = "variant_fields_present"` - `const BetaFallbackCreditNotAppliedReasonWrongOrganization BetaFallbackCreditNotAppliedReason = "wrong_organization"` - `const BetaFallbackCreditNotAppliedReasonWrongPlatform BetaFallbackCreditNotAppliedReason = "wrong_platform"` - `const BetaFallbackCreditNotAppliedReasonWrongWorkspace BetaFallbackCreditNotAppliedReason = "wrong_workspace"` - `RemoveToRedeem []string Optional` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. - `InputTokens int64` The cumulative number of input tokens which were used. minimum: 0 - `Iterations BetaIterationsUsage` 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 `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `type BetaMessageIterationUsage` Token usage for a sampling iteration. - `Type Message` Usage for a sampling iteration default: message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaCompactionIterationUsage` Token usage for a compaction iteration. - `Type Compaction` Usage for a compaction iteration default: compaction - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration default: advisor_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaFallbackMessageIterationUsage` 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 FallbackMessage` Usage for the fallback-model attempt that served the response default: fallback_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokens int64` The cumulative number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` 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. - `ThinkingTokens int64` 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. default: 0, minimum: 0 - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. default: 0, minimum: 0 - `WebSearchRequests int64` The number of web search tool requests. default: 0, minimum: 0 ### Beta Message Iteration Usage - `type BetaMessageIterationUsage` Token usage for a sampling iteration. - `Type Message` Usage for a sampling iteration default: message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `OutputTokens int64` The number of output tokens which were used. minimum: 0 ### Beta Message Param - `type BetaMessageParam` - `Content []BetaContentBlockParamUnion` - `[]BetaContentBlockParamUnion` - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` - `type BetaRequestDocumentBlockParam` - `Type Document` - `Source BetaRequestDocumentBlockSourceUnionParam` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `type BetaContentBlockSourceParam` - `Type Content` - `Content BetaContentBlockSourceContentUnionParam` - `string` - `[]BetaContentBlockSourceContentUnionParam` - `type BetaTextBlockParam` - `type BetaImageBlockParam` - `type BetaURLPDFSourceParam` - `Type URL` - `URL string` - `type BetaFileDocumentSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `Enabled bool Optional` - `Context string Optional` minLength: 1 - `Title string Optional` minLength: 1, maxLength: 500 - `type BetaSearchResultBlockParam` - `Type SearchResult` - `Content []BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `Source string` - `Title string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `type BetaThinkingBlockParam` - `Type Thinking` - `Signature string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `Thinking string` The `thinking` text of this block as returned by the API. - `type BetaRedactedThinkingBlockParam` - `Type RedactedThinking` - `Data string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `type BetaToolUseBlockParam` - `Type ToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1, maxLength: 200 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaToolResultBlockParam` - `Type ToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content []BetaToolResultBlockParamContentUnion Optional` - `[]BetaToolResultBlockParamContentUnion` - `type BetaTextBlockParam` - `type BetaImageBlockParam` - `type BetaSearchResultBlockParam` - `type BetaRequestDocumentBlockParam` - `type BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `Type BrowserState` - `Tabs []BetaBrowserStateTabEntryParam` 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`. maxItems: 100 - `TabID string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Title string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Active bool Optional` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `StateChanges []BetaBrowserStateChangeUnionParam Optional` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `type BetaBrowserStateChangeTabOpenedParam` 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. - `Type TabOpened` - `TabID string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadStartedParam` A file download that started during this call. - `Type DownloadStarted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadCompletedParam` 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). - `Type DownloadCompleted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Path string Optional` 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. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `SizeBytes int64 Optional` The completed download's size. minimum: 0 - `type BetaBrowserStateChangeDownloadFailedParam` A file download that failed — or was cancelled — during this call. - `Type DownloadFailed` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Error string Optional` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `IsError bool Optional` - `ToolsetName string Optional` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlockParam` - `Type ServerToolUse` - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `const BetaServerToolUseBlockParamNameWebSearch BetaServerToolUseBlockParamName = "web_search"` - `const BetaServerToolUseBlockParamNameWebFetch BetaServerToolUseBlockParamName = "web_fetch"` - `const BetaServerToolUseBlockParamNameCodeExecution BetaServerToolUseBlockParamName = "code_execution"` - `const BetaServerToolUseBlockParamNameBashCodeExecution BetaServerToolUseBlockParamName = "bash_code_execution"` - `const BetaServerToolUseBlockParamNameTextEditorCodeExecution BetaServerToolUseBlockParamName = "text_editor_code_execution"` - `const BetaServerToolUseBlockParamNameToolSearchToolRegex BetaServerToolUseBlockParamName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockParamNameToolSearchToolBm25 BetaServerToolUseBlockParamName = "tool_search_tool_bm25"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaServerToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlockParam` - `Type WebSearchToolResult` - `Content BetaWebSearchToolResultBlockParamContentUnion` - `[]BetaWebSearchResultBlockParam` - `Type WebSearchResult` - `EncryptedContent string` - `Title string` - `URL string` - `PageAge string Optional` - `type BetaWebSearchToolRequestErrorParam` - `Type WebSearchToolResultError` - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaWebSearchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlockParam` - `Type WebFetchToolResult` - `Content BetaWebFetchToolResultBlockParamContentUnion` - `type BetaWebFetchToolResultErrorBlockParam` - `Type WebFetchToolResultError` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlockParam` - `Type WebFetchResult` - `Content BetaRequestDocumentBlockParam` - `URL string` Fetched content URL - `RetrievedAt string Optional` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlockParam` - `Type AdvisorToolResult` - `Content BetaAdvisorToolResultBlockParamContentUnion` - `type BetaAdvisorToolResultErrorParam` - `Type AdvisorToolResultError` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodeModelNotFound BetaAdvisorToolResultErrorParamErrorCode = "model_not_found"` - `type BetaAdvisorResultBlockParam` - `Type AdvisorResult` - `Text string` - `StopReason string Optional` - `type BetaAdvisorRedactedResultBlockParam` - `Type AdvisorRedactedResult` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `StopReason string Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaCodeExecutionToolResultBlockParam` - `Type CodeExecutionToolResult` - `Content BetaCodeExecutionToolResultBlockParamContentUnion` - `type BetaCodeExecutionToolResultErrorParam` - `Type CodeExecutionToolResultError` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlockParam` - `Type CodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaBashCodeExecutionToolResultBlockParam` - `Type BashCodeExecutionToolResult` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnion` - `type BetaBashCodeExecutionToolResultErrorParam` - `Type BashCodeExecutionToolResultError` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorParamErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlockParam` - `Type BashCodeExecutionResult` - `Content []BetaBashCodeExecutionOutputBlockParam` - `Type BashCodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaTextEditorCodeExecutionToolResultBlockParam` - `Type TextEditorCodeExecutionToolResult` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnion` - `type BetaTextEditorCodeExecutionToolResultErrorParam` - `Type TextEditorCodeExecutionToolResultError` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "file_not_found"` - `ErrorMessage string Optional` - `type BetaTextEditorCodeExecutionViewResultBlockParam` - `Type TextEditorCodeExecutionViewResult` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `NumLines int64 Optional` - `StartLine int64 Optional` - `TotalLines int64 Optional` - `type BetaTextEditorCodeExecutionCreateResultBlockParam` - `Type TextEditorCodeExecutionCreateResult` - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `Type TextEditorCodeExecutionStrReplaceResult` - `Lines []string Optional` - `NewLines int64 Optional` - `NewStart int64 Optional` - `OldLines int64 Optional` - `OldStart int64 Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaToolSearchToolResultBlockParam` - `Type ToolSearchToolResult` - `Content BetaToolSearchToolResultBlockParamContentUnion` - `type BetaToolSearchToolResultErrorParam` - `Type ToolSearchToolResultError` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `ErrorMessage string Optional` - `type BetaToolSearchToolSearchResultBlockParam` - `Type ToolSearchToolSearchResult` - `ToolReferences []BetaToolReferenceBlockParam` - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaMCPToolUseBlockParam` - `Type MCPToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestMCPToolResultBlockParam` - `Type MCPToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content BetaRequestMCPToolResultBlockParamContentUnion Optional` - `string` - `[]BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `IsError bool Optional` - `type BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `Type ContainerUpload` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `Type Compaction` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content string Optional` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string Optional` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` The block's signature as returned, to be sent back verbatim - `ToolChanges []BetaCompactionBlockParamToolChangeUnion Optional` The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block. - `type BetaRequestToolAdditionBlockParam` 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 ToolAddition` - `Tool BetaRequestToolAdditionBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `Type ToolReference` - `Name string` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `Type MCPToolReference` - `Name string` - `ServerName string` - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `Type MCPToolsetReference` - `ServerName string` - `type BetaToolChangeToolDefinitionParam` 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. - `Type ToolDefinition` - `Definition BetaToolUnionParam` - `type BetaToolParam` - `Type BetaToolType Optional` - `InputSchema BetaToolInputSchemaParam` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `const BetaToolAllowedCallerCodeExecution20260521 BetaToolAllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestToolRemovalBlockParam` 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 ToolRemoval` - `Tool BetaRequestToolRemovalBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestToolAdditionBlockParam` 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` 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 BetaMCPToolListingBlockParam` 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. - `Type MCPToolListing` - `MCPServerName string` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `Tools []BetaMCPToolParam` The server's tools, exactly as the response listed them. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `Type Fallback` - `From BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Trigger any Optional` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `Role BetaMessageParamRole` - `const BetaMessageParamRoleUser BetaMessageParamRole = "user"` - `const BetaMessageParamRoleAssistant BetaMessageParamRole = "assistant"` - `const BetaMessageParamRoleSystem BetaMessageParamRole = "system"` - `ClearAt BetaMessageParamClearAt Optional` How long this system message's text stays in front of the model. `"never"` (the default) renders it on every request that includes it. `"next_user_message"` renders it only for the user turn it follows: once a later `role: "user"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: "system"` messages. - `const BetaMessageParamClearAtNextUserMessage BetaMessageParamClearAt = "next_user_message"` - `const BetaMessageParamClearAtNever BetaMessageParamClearAt = "never"` - `OutputConfig BetaSystemMessageOutputConfigParam Optional` 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 Optional` 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`. - `const BetaSystemMessageOutputConfigEffortLow BetaSystemMessageOutputConfigEffort = "low"` - `const BetaSystemMessageOutputConfigEffortMedium BetaSystemMessageOutputConfigEffort = "medium"` - `const BetaSystemMessageOutputConfigEffortHigh BetaSystemMessageOutputConfigEffort = "high"` - `const BetaSystemMessageOutputConfigEffortXhigh BetaSystemMessageOutputConfigEffort = "xhigh"` - `const BetaSystemMessageOutputConfigEffortMax BetaSystemMessageOutputConfigEffort = "max"` ### Beta Message Tokens Count - `type BetaMessageTokensCount` - `ContextManagement BetaCountTokensContextManagementResponse` Information about context management applied to the message. - `OriginalInputTokens int64` The original token count before context management was applied - `InputTokens int64` The total number of tokens across the provided list of messages, system prompt, and tools. ### Beta Metadata - `type BetaMetadataParam` - `UserID string Optional` 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. maxLength: 512 ### Beta Output Config - `type BetaOutputConfigParam` - `Effort BetaOutputConfigEffort Optional` 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`. - `const BetaOutputConfigEffortLow BetaOutputConfigEffort = "low"` - `const BetaOutputConfigEffortMedium BetaOutputConfigEffort = "medium"` - `const BetaOutputConfigEffortHigh BetaOutputConfigEffort = "high"` - `const BetaOutputConfigEffortXhigh BetaOutputConfigEffort = "xhigh"` - `const BetaOutputConfigEffortMax BetaOutputConfigEffort = "max"` - `Format BetaJSONOutputFormatParam Optional` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=go) - `Type JSONSchema` - `Schema map[string, any]` The JSON schema of the format - `TaskBudget BetaTokenTaskBudgetParam Optional` Configuration for token budget tracking across contexts. - `Type Tokens` The budget type. Currently only 'tokens' is supported. - `Total int64` Total token budget across all contexts in the session. minimum: 1024 - `Remaining int64 Optional` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. minimum: 0 ### Beta Output Tokens Details - `type BetaOutputTokensDetails` - `ThinkingTokens int64` 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. default: 0, minimum: 0 ### Beta Plain Text Source - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` ### Beta Raw Content Block Delta - `type BetaRawContentBlockDeltaUnion interface{…}` - `type BetaTextDelta` - `Type TextDelta` default: text_delta - `Text string` - `type BetaInputJSONDelta` - `Type InputJSONDelta` default: input_json_delta - `PartialJSON string` - `type BetaCitationsDelta` - `Type CitationsDelta` default: citations_delta - `Citation BetaCitationsDeltaCitationUnion` - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaThinkingDelta` - `Type ThinkingDelta` default: thinking_delta - `EstimatedTokens int64` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `Thinking string` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `type BetaSignatureDelta` - `Type SignatureDelta` default: signature_delta - `Signature string` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `type BetaCompactionContentBlockDelta` - `Type CompactionDelta` default: compaction_delta - `Content string` - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim ### Beta Raw Content Block Delta Event - `type BetaRawContentBlockDeltaEvent` - `Type ContentBlockDelta` default: content_block_delta - `Delta BetaRawContentBlockDeltaUnion` - `type BetaTextDelta` - `Type TextDelta` default: text_delta - `Text string` - `type BetaInputJSONDelta` - `Type InputJSONDelta` default: input_json_delta - `PartialJSON string` - `type BetaCitationsDelta` - `Type CitationsDelta` default: citations_delta - `Citation BetaCitationsDeltaCitationUnion` - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaThinkingDelta` - `Type ThinkingDelta` default: thinking_delta - `EstimatedTokens int64` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `Thinking string` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `type BetaSignatureDelta` - `Type SignatureDelta` default: signature_delta - `Signature string` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `type BetaCompactionContentBlockDelta` - `Type CompactionDelta` default: compaction_delta - `Content string` - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Index int64` ### Beta Raw Content Block Start Event - `type BetaRawContentBlockStartEvent` - `Type ContentBlockStart` default: content_block_start - `ContentBlock BetaRawContentBlockStartEventContentBlockUnion` - `type BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `Text string` - `type BetaThinkingBlock` - `Type Thinking` default: thinking - `Signature string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. - `Thinking string` The text of Claude's thinking process for this block. - `type BetaRedactedThinkingBlock` - `Type RedactedThinking` default: redacted_thinking - `Data string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go#redacted-thinking-blocks) for details. - `type BetaToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1 - `Caller BetaToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlock` - `Type ServerToolUse` default: server_tool_use - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"` - `const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"` - `const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"` - `const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"` - `const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"` - `const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"` - `Caller BetaServerToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlock` - `Type WebSearchToolResult` default: web_search_tool_result - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError` - `Type WebSearchToolResultError` default: web_search_tool_result_error - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `[]BetaWebSearchResultBlock` - `Type WebSearchResult` default: web_search_result - `EncryptedContent string` - `PageAge string` - `Title string` - `URL string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebSearchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlock` - `Type WebFetchToolResult` default: web_fetch_tool_result - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock` - `Type WebFetchToolResultError` default: web_fetch_tool_result_error - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlock` - `Type WebFetchResult` default: web_fetch_result - `Content BetaDocumentBlock` - `Type Document` default: document - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` default: false - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `Title string` The title of the document - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `URL string` Fetched content URL - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebFetchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlock` - `Type AdvisorToolResult` default: advisor_tool_result - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError` - `Type AdvisorToolResultError` default: advisor_tool_result_error - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodeModelNotFound BetaAdvisorToolResultErrorErrorCode = "model_not_found"` - `type BetaAdvisorResultBlock` - `Type AdvisorResult` default: advisor_result - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `type BetaAdvisorRedactedResultBlock` - `Type AdvisorRedactedResult` default: advisor_redacted_result - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaCodeExecutionToolResultBlock` - `Type CodeExecutionToolResult` default: code_execution_tool_result - `Content BetaCodeExecutionToolResultBlockContentUnion` - `type BetaCodeExecutionToolResultError` - `Type CodeExecutionToolResultError` default: code_execution_tool_result_error - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlock` - `Type CodeExecutionResult` default: code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` default: encrypted_code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaBashCodeExecutionToolResultBlock` - `Type BashCodeExecutionToolResult` default: bash_code_execution_tool_result - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError` - `Type BashCodeExecutionToolResultError` default: bash_code_execution_tool_result_error - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlock` - `Type BashCodeExecutionResult` default: bash_code_execution_result - `Content []BetaBashCodeExecutionOutputBlock` - `Type BashCodeExecutionOutput` default: bash_code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaTextEditorCodeExecutionToolResultBlock` - `Type TextEditorCodeExecutionToolResult` default: text_editor_code_execution_tool_result - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError` - `Type TextEditorCodeExecutionToolResultError` default: text_editor_code_execution_tool_result_error - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlock` - `Type TextEditorCodeExecutionViewResult` default: text_editor_code_execution_view_result - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlock` - `Type TextEditorCodeExecutionCreateResult` default: text_editor_code_execution_create_result - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock` - `Type TextEditorCodeExecutionStrReplaceResult` default: text_editor_code_execution_str_replace_result - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaToolSearchToolResultBlock` - `Type ToolSearchToolResult` default: tool_search_tool_result - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError` - `Type ToolSearchToolResultError` default: tool_search_tool_result_error - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"` - `ErrorMessage string` - `type BetaToolSearchToolSearchResultBlock` - `Type ToolSearchToolSearchResult` default: tool_search_tool_search_result - `ToolReferences []BetaToolReferenceBlock` - `Type ToolReference` default: tool_reference - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaMCPToolUseBlock` - `Type MCPToolUse` default: mcp_tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` The name of the MCP tool - `ServerName string` The name of the MCP server - `type BetaMCPToolResultBlock` - `Type MCPToolResult` default: mcp_tool_result - `Content BetaMCPToolResultBlockContentUnion` - `string` - `[]BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `Text string` - `IsError bool` default: false - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `type BetaContainerUploadBlock` Response model for a file uploaded to the container. - `Type ContainerUpload` default: container_upload - `FileID string` - `type BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `Type Compaction` default: compaction - `Content string` Summary of compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` Signature over the summary, to be sent back with the block verbatim - `ToolChanges []BetaCompactionBlockToolChangeUnion Optional` 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` 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 ToolAddition` default: tool_addition - `Tool BetaResponseToolAdditionBlockToolUnion` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `type BetaResponseToolChangeToolReference` 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` default: tool_reference - `Name string` - `type BetaResponseToolChangeMCPToolReference` 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` default: mcp_tool_reference - `Name string` - `ServerName string` - `type BetaResponseToolChangeMCPToolsetReference` 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` default: mcp_toolset_reference - `ServerName string` - `type BetaToolChangeToolDefinition` 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` default: tool_definition - `Definition BetaResponseToolUnion` - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaResponseToolRemovalBlock` 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 ToolRemoval` default: tool_removal - `Tool BetaResponseToolRemovalBlockToolUnion` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `type BetaResponseToolChangeToolReference` 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 BetaResponseToolChangeMCPToolReference` 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 BetaResponseToolChangeMCPToolsetReference` 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 BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `Type Fallback` default: fallback - `From BetaFallbackInfo` The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `Trigger BetaFallbackRefusalTrigger` What caused the `from` model to hand over at this hop. - `Type Refusal` default: refusal - `Category BetaFallbackRefusalTriggerCategory` 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`. - `const BetaFallbackRefusalTriggerCategoryCyber BetaFallbackRefusalTriggerCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryBio BetaFallbackRefusalTriggerCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryFrontierLLM BetaFallbackRefusalTriggerCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryReasoningExtraction BetaFallbackRefusalTriggerCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaFallbackRefusalTriggerCategoryGeneralHarms BetaFallbackRefusalTriggerCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `type BetaMCPToolListingBlock` 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` default: mcp_tool_listing - `MCPServerName string` - `Tools []BetaMCPTool` - `InputSchema map[string, any]` - `Name string` - `Description string Optional` - `Index int64` ### Beta Raw Content Block Stop Event - `type BetaRawContentBlockStopEvent` - `Type ContentBlockStop` default: content_block_stop - `Index int64` ### Beta Raw Message Delta Event - `type BetaRawMessageDeltaEvent` - `Type MessageDelta` default: message_delta - `ContextManagement BetaContextManagementResponse` Information about context management strategies applied during the request - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `type BetaClearToolUses20250919EditResponse` - `Type ClearToolUses20250919` The type of context management edit applied. default: clear_tool_uses_20250919 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedToolUses int64` Number of tool uses that were cleared. minimum: 0 - `type BetaClearThinking20251015EditResponse` - `Type ClearThinking20251015` The type of context management edit applied. default: clear_thinking_20251015 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedThinkingTurns int64` Number of thinking turns that were cleared. minimum: 0 - `Delta BetaRawMessageDeltaEventDelta` - `Container BetaContainer` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. format: date-time - `Skills []BetaContainerSkill` Skills loaded in the container - `Type BetaContainerSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaContainerSkillTypeAnthropic BetaContainerSkillType = "anthropic"` - `const BetaContainerSkillTypeCustom BetaContainerSkillType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `StopDetails BetaRefusalStopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `Type Refusal` default: refusal - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaRefusalStopDetailsCategoryFrontierLLM BetaRefusalStopDetailsCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaRefusalStopDetailsCategoryReasoningExtraction BetaRefusalStopDetailsCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaRefusalStopDetailsCategoryGeneralHarms BetaRefusalStopDetailsCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `FallbackCreditToken string` Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit. - `FallbackHasPrefillClaim bool` Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token. - `RecommendedModel string` The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise. - `StopReason BetaStopReason` - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` - `Usage BetaMessageDeltaUsage` 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`. - `CacheCreationInputTokens int64` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `CacheReadInputTokens int64` The cumulative number of input tokens read from the cache. minimum: 0 - `FallbackCredit BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `Status BetaFallbackCreditUsageStatusUnion` 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` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `Type Redeemed` default: redeemed - `type BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `Type NotApplied` default: not_applied - `Reason BetaFallbackCreditNotAppliedReason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `const BetaFallbackCreditNotAppliedReasonBodyMismatch BetaFallbackCreditNotAppliedReason = "body_mismatch"` - `const BetaFallbackCreditNotAppliedReasonContinuationExcluded BetaFallbackCreditNotAppliedReason = "continuation_excluded"` - `const BetaFallbackCreditNotAppliedReasonContinuationOnly BetaFallbackCreditNotAppliedReason = "continuation_only"` - `const BetaFallbackCreditNotAppliedReasonExpired BetaFallbackCreditNotAppliedReason = "expired"` - `const BetaFallbackCreditNotAppliedReasonInvalidTargetModel BetaFallbackCreditNotAppliedReason = "invalid_target_model"` - `const BetaFallbackCreditNotAppliedReasonNotEnabled BetaFallbackCreditNotAppliedReason = "not_enabled"` - `const BetaFallbackCreditNotAppliedReasonRepriceUnavailable BetaFallbackCreditNotAppliedReason = "reprice_unavailable"` - `const BetaFallbackCreditNotAppliedReasonTemporarilyUnavailable BetaFallbackCreditNotAppliedReason = "temporarily_unavailable"` - `const BetaFallbackCreditNotAppliedReasonVariantFieldsPresent BetaFallbackCreditNotAppliedReason = "variant_fields_present"` - `const BetaFallbackCreditNotAppliedReasonWrongOrganization BetaFallbackCreditNotAppliedReason = "wrong_organization"` - `const BetaFallbackCreditNotAppliedReasonWrongPlatform BetaFallbackCreditNotAppliedReason = "wrong_platform"` - `const BetaFallbackCreditNotAppliedReasonWrongWorkspace BetaFallbackCreditNotAppliedReason = "wrong_workspace"` - `RemoveToRedeem []string Optional` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. - `InputTokens int64` The cumulative number of input tokens which were used. minimum: 0 - `Iterations BetaIterationsUsage` 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 `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `type BetaMessageIterationUsage` Token usage for a sampling iteration. - `Type Message` Usage for a sampling iteration default: message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaCompactionIterationUsage` Token usage for a compaction iteration. - `Type Compaction` Usage for a compaction iteration default: compaction - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration default: advisor_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaFallbackMessageIterationUsage` 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 FallbackMessage` Usage for the fallback-model attempt that served the response default: fallback_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokens int64` The cumulative number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` 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. - `ThinkingTokens int64` 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. default: 0, minimum: 0 - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. default: 0, minimum: 0 - `WebSearchRequests int64` The number of web search tool requests. default: 0, minimum: 0 - `InputTransformations []BetaInputTransformationUnion Optional` Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`. - `type BetaThinkingDroppedInputTransformation` - `Type ThinkingDropped` Always `thinking_dropped` for this entry type. default: thinking_dropped - `Path string` 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 BetaThinkingDroppedInputTransformationReason` 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`. - `const BetaThinkingDroppedInputTransformationReasonModelBindingMismatch BetaThinkingDroppedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonPrefixBindingMismatch BetaThinkingDroppedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonOrganizationBindingMismatch BetaThinkingDroppedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonEndUserBindingMismatch BetaThinkingDroppedInputTransformationReason = "end_user_binding_mismatch"` - `type BetaThinkingMismatchAllowedInputTransformation` - `Type ThinkingMismatchAllowed` Always `thinking_mismatch_allowed` for this entry type. default: thinking_mismatch_allowed - `Path string` 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 BetaThinkingMismatchAllowedInputTransformationReason` 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. - `const BetaThinkingMismatchAllowedInputTransformationReasonModelBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonPrefixBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonOrganizationBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonEndUserBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "end_user_binding_mismatch"` ### Beta Raw Message Start Event - `type BetaRawMessageStartEvent` - `Type MessageStart` default: message_start - `Message BetaMessage` - `Type Message` Object type. For Messages, this is always `"message"`. default: message - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. format: date-time - `Skills []BetaContainerSkill` Skills loaded in the container - `Type BetaContainerSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaContainerSkillTypeAnthropic BetaContainerSkillType = "anthropic"` - `const BetaContainerSkillTypeCustom BetaContainerSkillType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `Text string` - `type BetaThinkingBlock` - `Type Thinking` default: thinking - `Signature string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. - `Thinking string` The text of Claude's thinking process for this block. - `type BetaRedactedThinkingBlock` - `Type RedactedThinking` default: redacted_thinking - `Data string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go#redacted-thinking-blocks) for details. - `type BetaToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1 - `Caller BetaToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlock` - `Type ServerToolUse` default: server_tool_use - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"` - `const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"` - `const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"` - `const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"` - `const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"` - `const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"` - `Caller BetaServerToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlock` - `Type WebSearchToolResult` default: web_search_tool_result - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError` - `Type WebSearchToolResultError` default: web_search_tool_result_error - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `[]BetaWebSearchResultBlock` - `Type WebSearchResult` default: web_search_result - `EncryptedContent string` - `PageAge string` - `Title string` - `URL string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebSearchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlock` - `Type WebFetchToolResult` default: web_fetch_tool_result - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock` - `Type WebFetchToolResultError` default: web_fetch_tool_result_error - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlock` - `Type WebFetchResult` default: web_fetch_result - `Content BetaDocumentBlock` - `Type Document` default: document - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` default: false - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `Title string` The title of the document - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `URL string` Fetched content URL - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebFetchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlock` - `Type AdvisorToolResult` default: advisor_tool_result - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError` - `Type AdvisorToolResultError` default: advisor_tool_result_error - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodeModelNotFound BetaAdvisorToolResultErrorErrorCode = "model_not_found"` - `type BetaAdvisorResultBlock` - `Type AdvisorResult` default: advisor_result - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `type BetaAdvisorRedactedResultBlock` - `Type AdvisorRedactedResult` default: advisor_redacted_result - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaCodeExecutionToolResultBlock` - `Type CodeExecutionToolResult` default: code_execution_tool_result - `Content BetaCodeExecutionToolResultBlockContentUnion` - `type BetaCodeExecutionToolResultError` - `Type CodeExecutionToolResultError` default: code_execution_tool_result_error - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlock` - `Type CodeExecutionResult` default: code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` default: encrypted_code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaBashCodeExecutionToolResultBlock` - `Type BashCodeExecutionToolResult` default: bash_code_execution_tool_result - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError` - `Type BashCodeExecutionToolResultError` default: bash_code_execution_tool_result_error - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlock` - `Type BashCodeExecutionResult` default: bash_code_execution_result - `Content []BetaBashCodeExecutionOutputBlock` - `Type BashCodeExecutionOutput` default: bash_code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaTextEditorCodeExecutionToolResultBlock` - `Type TextEditorCodeExecutionToolResult` default: text_editor_code_execution_tool_result - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError` - `Type TextEditorCodeExecutionToolResultError` default: text_editor_code_execution_tool_result_error - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlock` - `Type TextEditorCodeExecutionViewResult` default: text_editor_code_execution_view_result - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlock` - `Type TextEditorCodeExecutionCreateResult` default: text_editor_code_execution_create_result - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock` - `Type TextEditorCodeExecutionStrReplaceResult` default: text_editor_code_execution_str_replace_result - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaToolSearchToolResultBlock` - `Type ToolSearchToolResult` default: tool_search_tool_result - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError` - `Type ToolSearchToolResultError` default: tool_search_tool_result_error - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"` - `ErrorMessage string` - `type BetaToolSearchToolSearchResultBlock` - `Type ToolSearchToolSearchResult` default: tool_search_tool_search_result - `ToolReferences []BetaToolReferenceBlock` - `Type ToolReference` default: tool_reference - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaMCPToolUseBlock` - `Type MCPToolUse` default: mcp_tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` The name of the MCP tool - `ServerName string` The name of the MCP server - `type BetaMCPToolResultBlock` - `Type MCPToolResult` default: mcp_tool_result - `Content BetaMCPToolResultBlockContentUnion` - `string` - `[]BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `Text string` - `IsError bool` default: false - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `type BetaContainerUploadBlock` Response model for a file uploaded to the container. - `Type ContainerUpload` default: container_upload - `FileID string` - `type BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `Type Compaction` default: compaction - `Content string` Summary of compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` Signature over the summary, to be sent back with the block verbatim - `ToolChanges []BetaCompactionBlockToolChangeUnion Optional` 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` 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 ToolAddition` default: tool_addition - `Tool BetaResponseToolAdditionBlockToolUnion` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `type BetaResponseToolChangeToolReference` 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` default: tool_reference - `Name string` - `type BetaResponseToolChangeMCPToolReference` 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` default: mcp_tool_reference - `Name string` - `ServerName string` - `type BetaResponseToolChangeMCPToolsetReference` 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` default: mcp_toolset_reference - `ServerName string` - `type BetaToolChangeToolDefinition` 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` default: tool_definition - `Definition BetaResponseToolUnion` - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaResponseToolRemovalBlock` 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 ToolRemoval` default: tool_removal - `Tool BetaResponseToolRemovalBlockToolUnion` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `type BetaResponseToolChangeToolReference` 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 BetaResponseToolChangeMCPToolReference` 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 BetaResponseToolChangeMCPToolsetReference` 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 BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `Type Fallback` default: fallback - `From BetaFallbackInfo` The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `Trigger BetaFallbackRefusalTrigger` What caused the `from` model to hand over at this hop. - `Type Refusal` default: refusal - `Category BetaFallbackRefusalTriggerCategory` 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`. - `const BetaFallbackRefusalTriggerCategoryCyber BetaFallbackRefusalTriggerCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryBio BetaFallbackRefusalTriggerCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryFrontierLLM BetaFallbackRefusalTriggerCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryReasoningExtraction BetaFallbackRefusalTriggerCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaFallbackRefusalTriggerCategoryGeneralHarms BetaFallbackRefusalTriggerCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `type BetaMCPToolListingBlock` 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` default: mcp_tool_listing - `MCPServerName string` - `Tools []BetaMCPTool` - `InputSchema map[string, any]` - `Name string` - `Description string Optional` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `type BetaClearToolUses20250919EditResponse` - `Type ClearToolUses20250919` The type of context management edit applied. default: clear_tool_uses_20250919 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedToolUses int64` Number of tool uses that were cleared. minimum: 0 - `type BetaClearThinking20251015EditResponse` - `Type ClearThinking20251015` The type of context management edit applied. default: clear_thinking_20251015 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedThinkingTurns int64` Number of thinking turns that were cleared. minimum: 0 - `Diagnostics BetaDiagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `CacheMissReason BetaCacheMissReasonUnion` 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 BetaCacheMissModelChanged` - `Type ModelChanged` default: model_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissSystemChanged` - `Type SystemChanged` default: system_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissToolsChanged` - `Type ToolsChanged` default: tools_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissMessagesChanged` - `Type MessagesChanged` default: messages_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissPreviousMessageNotFound` - `Type PreviousMessageNotFound` default: previous_message_not_found - `type BetaCacheMissUnavailable` - `Type Unavailable` default: unavailable - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `StopDetails BetaRefusalStopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `Type Refusal` default: refusal - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaRefusalStopDetailsCategoryFrontierLLM BetaRefusalStopDetailsCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaRefusalStopDetailsCategoryReasoningExtraction BetaRefusalStopDetailsCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaRefusalStopDetailsCategoryGeneralHarms BetaRefusalStopDetailsCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `FallbackCreditToken string` Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit. - `FallbackHasPrefillClaim bool` Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token. - `RecommendedModel string` The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise. - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Usage BetaUsage` 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`. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. minimum: 0 - `FallbackCredit BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `Status BetaFallbackCreditUsageStatusUnion` 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` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `Type Redeemed` default: redeemed - `type BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `Type NotApplied` default: not_applied - `Reason BetaFallbackCreditNotAppliedReason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `const BetaFallbackCreditNotAppliedReasonBodyMismatch BetaFallbackCreditNotAppliedReason = "body_mismatch"` - `const BetaFallbackCreditNotAppliedReasonContinuationExcluded BetaFallbackCreditNotAppliedReason = "continuation_excluded"` - `const BetaFallbackCreditNotAppliedReasonContinuationOnly BetaFallbackCreditNotAppliedReason = "continuation_only"` - `const BetaFallbackCreditNotAppliedReasonExpired BetaFallbackCreditNotAppliedReason = "expired"` - `const BetaFallbackCreditNotAppliedReasonInvalidTargetModel BetaFallbackCreditNotAppliedReason = "invalid_target_model"` - `const BetaFallbackCreditNotAppliedReasonNotEnabled BetaFallbackCreditNotAppliedReason = "not_enabled"` - `const BetaFallbackCreditNotAppliedReasonRepriceUnavailable BetaFallbackCreditNotAppliedReason = "reprice_unavailable"` - `const BetaFallbackCreditNotAppliedReasonTemporarilyUnavailable BetaFallbackCreditNotAppliedReason = "temporarily_unavailable"` - `const BetaFallbackCreditNotAppliedReasonVariantFieldsPresent BetaFallbackCreditNotAppliedReason = "variant_fields_present"` - `const BetaFallbackCreditNotAppliedReasonWrongOrganization BetaFallbackCreditNotAppliedReason = "wrong_organization"` - `const BetaFallbackCreditNotAppliedReasonWrongPlatform BetaFallbackCreditNotAppliedReason = "wrong_platform"` - `const BetaFallbackCreditNotAppliedReasonWrongWorkspace BetaFallbackCreditNotAppliedReason = "wrong_workspace"` - `RemoveToRedeem []string Optional` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Iterations BetaIterationsUsage` 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 `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `type BetaMessageIterationUsage` Token usage for a sampling iteration. - `Type Message` Usage for a sampling iteration default: message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaCompactionIterationUsage` Token usage for a compaction iteration. - `Type Compaction` Usage for a compaction iteration default: compaction - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration default: advisor_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaFallbackMessageIterationUsage` 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 FallbackMessage` Usage for the fallback-model attempt that served the response default: fallback_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokensDetails BetaOutputTokensDetails` 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. - `ThinkingTokens int64` 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. default: 0, minimum: 0 - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. default: 0, minimum: 0 - `WebSearchRequests int64` The number of web search tool requests. default: 0, minimum: 0 - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` - `InputTransformations []BetaInputTransformationUnion Optional` Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`. - `type BetaThinkingDroppedInputTransformation` - `Type ThinkingDropped` Always `thinking_dropped` for this entry type. default: thinking_dropped - `Path string` 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 BetaThinkingDroppedInputTransformationReason` 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`. - `const BetaThinkingDroppedInputTransformationReasonModelBindingMismatch BetaThinkingDroppedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonPrefixBindingMismatch BetaThinkingDroppedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonOrganizationBindingMismatch BetaThinkingDroppedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonEndUserBindingMismatch BetaThinkingDroppedInputTransformationReason = "end_user_binding_mismatch"` - `type BetaThinkingMismatchAllowedInputTransformation` - `Type ThinkingMismatchAllowed` Always `thinking_mismatch_allowed` for this entry type. default: thinking_mismatch_allowed - `Path string` 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 BetaThinkingMismatchAllowedInputTransformationReason` 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. - `const BetaThinkingMismatchAllowedInputTransformationReasonModelBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonPrefixBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonOrganizationBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonEndUserBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "end_user_binding_mismatch"` ### Beta Raw Message Stop Event - `type BetaRawMessageStopEvent` - `Type MessageStop` default: message_stop ### Beta Raw Message Stream Event - `type BetaRawMessageStreamEventUnion interface{…}` - `type BetaRawMessageStartEvent` - `Type MessageStart` default: message_start - `Message BetaMessage` - `Type Message` Object type. For Messages, this is always `"message"`. default: message - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. format: date-time - `Skills []BetaContainerSkill` Skills loaded in the container - `Type BetaContainerSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaContainerSkillTypeAnthropic BetaContainerSkillType = "anthropic"` - `const BetaContainerSkillTypeCustom BetaContainerSkillType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `Text string` - `type BetaThinkingBlock` - `Type Thinking` default: thinking - `Signature string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. - `Thinking string` The text of Claude's thinking process for this block. - `type BetaRedactedThinkingBlock` - `Type RedactedThinking` default: redacted_thinking - `Data string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go#redacted-thinking-blocks) for details. - `type BetaToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1 - `Caller BetaToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlock` - `Type ServerToolUse` default: server_tool_use - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"` - `const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"` - `const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"` - `const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"` - `const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"` - `const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"` - `Caller BetaServerToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlock` - `Type WebSearchToolResult` default: web_search_tool_result - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError` - `Type WebSearchToolResultError` default: web_search_tool_result_error - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `[]BetaWebSearchResultBlock` - `Type WebSearchResult` default: web_search_result - `EncryptedContent string` - `PageAge string` - `Title string` - `URL string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebSearchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlock` - `Type WebFetchToolResult` default: web_fetch_tool_result - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock` - `Type WebFetchToolResultError` default: web_fetch_tool_result_error - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlock` - `Type WebFetchResult` default: web_fetch_result - `Content BetaDocumentBlock` - `Type Document` default: document - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` default: false - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `Title string` The title of the document - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `URL string` Fetched content URL - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebFetchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlock` - `Type AdvisorToolResult` default: advisor_tool_result - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError` - `Type AdvisorToolResultError` default: advisor_tool_result_error - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodeModelNotFound BetaAdvisorToolResultErrorErrorCode = "model_not_found"` - `type BetaAdvisorResultBlock` - `Type AdvisorResult` default: advisor_result - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `type BetaAdvisorRedactedResultBlock` - `Type AdvisorRedactedResult` default: advisor_redacted_result - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaCodeExecutionToolResultBlock` - `Type CodeExecutionToolResult` default: code_execution_tool_result - `Content BetaCodeExecutionToolResultBlockContentUnion` - `type BetaCodeExecutionToolResultError` - `Type CodeExecutionToolResultError` default: code_execution_tool_result_error - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlock` - `Type CodeExecutionResult` default: code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` default: encrypted_code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaBashCodeExecutionToolResultBlock` - `Type BashCodeExecutionToolResult` default: bash_code_execution_tool_result - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError` - `Type BashCodeExecutionToolResultError` default: bash_code_execution_tool_result_error - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlock` - `Type BashCodeExecutionResult` default: bash_code_execution_result - `Content []BetaBashCodeExecutionOutputBlock` - `Type BashCodeExecutionOutput` default: bash_code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaTextEditorCodeExecutionToolResultBlock` - `Type TextEditorCodeExecutionToolResult` default: text_editor_code_execution_tool_result - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError` - `Type TextEditorCodeExecutionToolResultError` default: text_editor_code_execution_tool_result_error - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlock` - `Type TextEditorCodeExecutionViewResult` default: text_editor_code_execution_view_result - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlock` - `Type TextEditorCodeExecutionCreateResult` default: text_editor_code_execution_create_result - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock` - `Type TextEditorCodeExecutionStrReplaceResult` default: text_editor_code_execution_str_replace_result - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaToolSearchToolResultBlock` - `Type ToolSearchToolResult` default: tool_search_tool_result - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError` - `Type ToolSearchToolResultError` default: tool_search_tool_result_error - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"` - `ErrorMessage string` - `type BetaToolSearchToolSearchResultBlock` - `Type ToolSearchToolSearchResult` default: tool_search_tool_search_result - `ToolReferences []BetaToolReferenceBlock` - `Type ToolReference` default: tool_reference - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaMCPToolUseBlock` - `Type MCPToolUse` default: mcp_tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` The name of the MCP tool - `ServerName string` The name of the MCP server - `type BetaMCPToolResultBlock` - `Type MCPToolResult` default: mcp_tool_result - `Content BetaMCPToolResultBlockContentUnion` - `string` - `[]BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `Text string` - `IsError bool` default: false - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `type BetaContainerUploadBlock` Response model for a file uploaded to the container. - `Type ContainerUpload` default: container_upload - `FileID string` - `type BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `Type Compaction` default: compaction - `Content string` Summary of compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` Signature over the summary, to be sent back with the block verbatim - `ToolChanges []BetaCompactionBlockToolChangeUnion Optional` 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` 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 ToolAddition` default: tool_addition - `Tool BetaResponseToolAdditionBlockToolUnion` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `type BetaResponseToolChangeToolReference` 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` default: tool_reference - `Name string` - `type BetaResponseToolChangeMCPToolReference` 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` default: mcp_tool_reference - `Name string` - `ServerName string` - `type BetaResponseToolChangeMCPToolsetReference` 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` default: mcp_toolset_reference - `ServerName string` - `type BetaToolChangeToolDefinition` 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` default: tool_definition - `Definition BetaResponseToolUnion` - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaResponseToolRemovalBlock` 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 ToolRemoval` default: tool_removal - `Tool BetaResponseToolRemovalBlockToolUnion` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `type BetaResponseToolChangeToolReference` 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 BetaResponseToolChangeMCPToolReference` 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 BetaResponseToolChangeMCPToolsetReference` 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 BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `Type Fallback` default: fallback - `From BetaFallbackInfo` The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `Trigger BetaFallbackRefusalTrigger` What caused the `from` model to hand over at this hop. - `Type Refusal` default: refusal - `Category BetaFallbackRefusalTriggerCategory` 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`. - `const BetaFallbackRefusalTriggerCategoryCyber BetaFallbackRefusalTriggerCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryBio BetaFallbackRefusalTriggerCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryFrontierLLM BetaFallbackRefusalTriggerCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryReasoningExtraction BetaFallbackRefusalTriggerCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaFallbackRefusalTriggerCategoryGeneralHarms BetaFallbackRefusalTriggerCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `type BetaMCPToolListingBlock` 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` default: mcp_tool_listing - `MCPServerName string` - `Tools []BetaMCPTool` - `InputSchema map[string, any]` - `Name string` - `Description string Optional` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `type BetaClearToolUses20250919EditResponse` - `Type ClearToolUses20250919` The type of context management edit applied. default: clear_tool_uses_20250919 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedToolUses int64` Number of tool uses that were cleared. minimum: 0 - `type BetaClearThinking20251015EditResponse` - `Type ClearThinking20251015` The type of context management edit applied. default: clear_thinking_20251015 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedThinkingTurns int64` Number of thinking turns that were cleared. minimum: 0 - `Diagnostics BetaDiagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `CacheMissReason BetaCacheMissReasonUnion` 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 BetaCacheMissModelChanged` - `Type ModelChanged` default: model_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissSystemChanged` - `Type SystemChanged` default: system_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissToolsChanged` - `Type ToolsChanged` default: tools_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissMessagesChanged` - `Type MessagesChanged` default: messages_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissPreviousMessageNotFound` - `Type PreviousMessageNotFound` default: previous_message_not_found - `type BetaCacheMissUnavailable` - `Type Unavailable` default: unavailable - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `StopDetails BetaRefusalStopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `Type Refusal` default: refusal - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaRefusalStopDetailsCategoryFrontierLLM BetaRefusalStopDetailsCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaRefusalStopDetailsCategoryReasoningExtraction BetaRefusalStopDetailsCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaRefusalStopDetailsCategoryGeneralHarms BetaRefusalStopDetailsCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `FallbackCreditToken string` Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit. - `FallbackHasPrefillClaim bool` Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token. - `RecommendedModel string` The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise. - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Usage BetaUsage` 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`. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. minimum: 0 - `FallbackCredit BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `Status BetaFallbackCreditUsageStatusUnion` 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` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `Type Redeemed` default: redeemed - `type BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `Type NotApplied` default: not_applied - `Reason BetaFallbackCreditNotAppliedReason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `const BetaFallbackCreditNotAppliedReasonBodyMismatch BetaFallbackCreditNotAppliedReason = "body_mismatch"` - `const BetaFallbackCreditNotAppliedReasonContinuationExcluded BetaFallbackCreditNotAppliedReason = "continuation_excluded"` - `const BetaFallbackCreditNotAppliedReasonContinuationOnly BetaFallbackCreditNotAppliedReason = "continuation_only"` - `const BetaFallbackCreditNotAppliedReasonExpired BetaFallbackCreditNotAppliedReason = "expired"` - `const BetaFallbackCreditNotAppliedReasonInvalidTargetModel BetaFallbackCreditNotAppliedReason = "invalid_target_model"` - `const BetaFallbackCreditNotAppliedReasonNotEnabled BetaFallbackCreditNotAppliedReason = "not_enabled"` - `const BetaFallbackCreditNotAppliedReasonRepriceUnavailable BetaFallbackCreditNotAppliedReason = "reprice_unavailable"` - `const BetaFallbackCreditNotAppliedReasonTemporarilyUnavailable BetaFallbackCreditNotAppliedReason = "temporarily_unavailable"` - `const BetaFallbackCreditNotAppliedReasonVariantFieldsPresent BetaFallbackCreditNotAppliedReason = "variant_fields_present"` - `const BetaFallbackCreditNotAppliedReasonWrongOrganization BetaFallbackCreditNotAppliedReason = "wrong_organization"` - `const BetaFallbackCreditNotAppliedReasonWrongPlatform BetaFallbackCreditNotAppliedReason = "wrong_platform"` - `const BetaFallbackCreditNotAppliedReasonWrongWorkspace BetaFallbackCreditNotAppliedReason = "wrong_workspace"` - `RemoveToRedeem []string Optional` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Iterations BetaIterationsUsage` 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 `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `type BetaMessageIterationUsage` Token usage for a sampling iteration. - `Type Message` Usage for a sampling iteration default: message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaCompactionIterationUsage` Token usage for a compaction iteration. - `Type Compaction` Usage for a compaction iteration default: compaction - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration default: advisor_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaFallbackMessageIterationUsage` 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 FallbackMessage` Usage for the fallback-model attempt that served the response default: fallback_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokensDetails BetaOutputTokensDetails` 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. - `ThinkingTokens int64` 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. default: 0, minimum: 0 - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. default: 0, minimum: 0 - `WebSearchRequests int64` The number of web search tool requests. default: 0, minimum: 0 - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` - `InputTransformations []BetaInputTransformationUnion Optional` Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`. - `type BetaThinkingDroppedInputTransformation` - `Type ThinkingDropped` Always `thinking_dropped` for this entry type. default: thinking_dropped - `Path string` 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 BetaThinkingDroppedInputTransformationReason` 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`. - `const BetaThinkingDroppedInputTransformationReasonModelBindingMismatch BetaThinkingDroppedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonPrefixBindingMismatch BetaThinkingDroppedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonOrganizationBindingMismatch BetaThinkingDroppedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonEndUserBindingMismatch BetaThinkingDroppedInputTransformationReason = "end_user_binding_mismatch"` - `type BetaThinkingMismatchAllowedInputTransformation` - `Type ThinkingMismatchAllowed` Always `thinking_mismatch_allowed` for this entry type. default: thinking_mismatch_allowed - `Path string` 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 BetaThinkingMismatchAllowedInputTransformationReason` 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. - `const BetaThinkingMismatchAllowedInputTransformationReasonModelBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonPrefixBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonOrganizationBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonEndUserBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "end_user_binding_mismatch"` - `type BetaRawMessageDeltaEvent` - `Type MessageDelta` default: message_delta - `ContextManagement BetaContextManagementResponse` Information about context management strategies applied during the request - `Delta BetaRawMessageDeltaEventDelta` - `Container BetaContainer` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `StopDetails BetaRefusalStopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `StopReason BetaStopReason` - `StopSequence string` - `Usage BetaMessageDeltaUsage` 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`. - `CacheCreationInputTokens int64` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `CacheReadInputTokens int64` The cumulative number of input tokens read from the cache. minimum: 0 - `FallbackCredit BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `InputTokens int64` The cumulative number of input tokens which were used. minimum: 0 - `Iterations BetaIterationsUsage` 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 `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `OutputTokens int64` The cumulative number of output tokens which were used. - `OutputTokensDetails BetaOutputTokensDetails` 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. - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `InputTransformations []BetaInputTransformationUnion Optional` Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`. - `type BetaThinkingDroppedInputTransformation` - `type BetaThinkingMismatchAllowedInputTransformation` - `type BetaRawMessageStopEvent` - `Type MessageStop` default: message_stop - `type BetaRawContentBlockStartEvent` - `Type ContentBlockStart` default: content_block_start - `ContentBlock BetaRawContentBlockStartEventContentBlockUnion` - `type BetaTextBlock` - `type BetaThinkingBlock` - `type BetaRedactedThinkingBlock` - `type BetaToolUseBlock` - `type BetaServerToolUseBlock` - `type BetaWebSearchToolResultBlock` - `type BetaWebFetchToolResultBlock` - `type BetaAdvisorToolResultBlock` - `type BetaCodeExecutionToolResultBlock` - `type BetaBashCodeExecutionToolResultBlock` - `type BetaTextEditorCodeExecutionToolResultBlock` - `type BetaToolSearchToolResultBlock` - `type BetaMCPToolUseBlock` - `type BetaMCPToolResultBlock` - `type BetaContainerUploadBlock` Response model for a file uploaded to the container. - `type BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `type BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `type BetaMCPToolListingBlock` 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. - `Index int64` - `type BetaRawContentBlockDeltaEvent` - `Type ContentBlockDelta` default: content_block_delta - `Delta BetaRawContentBlockDeltaUnion` - `type BetaTextDelta` - `Type TextDelta` default: text_delta - `Text string` - `type BetaInputJSONDelta` - `Type InputJSONDelta` default: input_json_delta - `PartialJSON string` - `type BetaCitationsDelta` - `Type CitationsDelta` default: citations_delta - `Citation BetaCitationsDeltaCitationUnion` - `type BetaCitationCharLocation` - `type BetaCitationPageLocation` - `type BetaCitationContentBlockLocation` - `type BetaCitationsWebSearchResultLocation` - `type BetaCitationSearchResultLocation` - `type BetaThinkingDelta` - `Type ThinkingDelta` default: thinking_delta - `EstimatedTokens int64` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `Thinking string` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `type BetaSignatureDelta` - `Type SignatureDelta` default: signature_delta - `Signature string` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `type BetaCompactionContentBlockDelta` - `Type CompactionDelta` default: compaction_delta - `Content string` - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Index int64` - `type BetaRawContentBlockStopEvent` - `Type ContentBlockStop` default: content_block_stop - `Index int64` ### Beta Redacted Thinking Block - `type BetaRedactedThinkingBlock` - `Type RedactedThinking` default: redacted_thinking - `Data string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go#redacted-thinking-blocks) for details. ### Beta Redacted Thinking Block Param - `type BetaRedactedThinkingBlockParam` - `Type RedactedThinking` - `Data string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. ### Beta Refusal Stop Details - `type BetaRefusalStopDetails` Structured information about a refusal. - `Type Refusal` default: refusal - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaRefusalStopDetailsCategoryFrontierLLM BetaRefusalStopDetailsCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaRefusalStopDetailsCategoryReasoningExtraction BetaRefusalStopDetailsCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaRefusalStopDetailsCategoryGeneralHarms BetaRefusalStopDetailsCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `FallbackCreditToken string` Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit. - `FallbackHasPrefillClaim bool` Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token. - `RecommendedModel string` The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise. ### Beta Request Document Block - `type BetaRequestDocumentBlockParam` - `Type Document` - `Source BetaRequestDocumentBlockSourceUnionParam` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `type BetaContentBlockSourceParam` - `Type Content` - `Content BetaContentBlockSourceContentUnionParam` - `string` - `[]BetaContentBlockSourceContentUnionParam` - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` - `type BetaURLPDFSourceParam` - `Type URL` - `URL string` - `type BetaFileDocumentSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `Enabled bool Optional` - `Context string Optional` minLength: 1 - `Title string Optional` minLength: 1, maxLength: 500 ### Beta Request MCP Server Tool Configuration - `type BetaRequestMCPServerToolConfigurationParam` - `AllowedTools []string Optional` - `Enabled bool Optional` ### Beta Request MCP Server URL Definition - `type BetaRequestMCPServerURLDefinitionParam` - `Type URL` - `Name string` - `URL string` - `AuthorizationToken string Optional` - `ToolConfiguration BetaRequestMCPServerToolConfigurationParam Optional` - `AllowedTools []string Optional` - `Enabled bool Optional` ### Beta Request MCP Tool Result Block Param - `type BetaRequestMCPToolResultBlockParam` - `Type MCPToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Content BetaRequestMCPToolResultBlockParamContentUnion Optional` - `string` - `[]BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `IsError bool Optional` ### Beta Request Tool Addition Block - `type BetaRequestToolAdditionBlockParam` 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 ToolAddition` - `Tool BetaRequestToolAdditionBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `Type ToolReference` - `Name string` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `Type MCPToolReference` - `Name string` - `ServerName string` - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `Type MCPToolsetReference` - `ServerName string` - `type BetaToolChangeToolDefinitionParam` 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. - `Type ToolDefinition` - `Definition BetaToolUnionParam` - `type BetaToolParam` - `Type BetaToolType Optional` - `InputSchema BetaToolInputSchemaParam` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `const BetaToolAllowedCallerCodeExecution20260521 BetaToolAllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. ### Beta Request Tool Removal Block - `type BetaRequestToolRemovalBlockParam` 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 ToolRemoval` - `Tool BetaRequestToolRemovalBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `Type ToolReference` - `Name string` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `Type MCPToolReference` - `Name string` - `ServerName string` - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `Type MCPToolsetReference` - `ServerName string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Response Tool - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Response Tool Addition Block - `type BetaResponseToolAdditionBlock` 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 ToolAddition` default: tool_addition - `Tool BetaResponseToolAdditionBlockToolUnion` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `type BetaResponseToolChangeToolReference` 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` default: tool_reference - `Name string` - `type BetaResponseToolChangeMCPToolReference` 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` default: mcp_tool_reference - `Name string` - `ServerName string` - `type BetaResponseToolChangeMCPToolsetReference` 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` default: mcp_toolset_reference - `ServerName string` - `type BetaToolChangeToolDefinition` 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` default: tool_definition - `Definition BetaResponseToolUnion` - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. ### Beta Response Tool Change MCP Tool Reference - `type BetaResponseToolChangeMCPToolReference` 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` default: mcp_tool_reference - `Name string` - `ServerName string` ### Beta Response Tool Change MCP Toolset Reference - `type BetaResponseToolChangeMCPToolsetReference` 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` default: mcp_toolset_reference - `ServerName string` ### Beta Response Tool Change Tool Reference - `type BetaResponseToolChangeToolReference` 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` default: tool_reference - `Name string` ### Beta Response Tool Input Schema - `type BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` ### Beta Response Tool Removal Block - `type BetaResponseToolRemovalBlock` 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 ToolRemoval` default: tool_removal - `Tool BetaResponseToolRemovalBlockToolUnion` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `type BetaResponseToolChangeToolReference` 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` default: tool_reference - `Name string` - `type BetaResponseToolChangeMCPToolReference` 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` default: mcp_tool_reference - `Name string` - `ServerName string` - `type BetaResponseToolChangeMCPToolsetReference` 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` default: mcp_toolset_reference - `ServerName string` ### Beta Response Tool Union - `type BetaResponseToolUnion interface{…}` - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. ### Beta Search Result Block Param - `type BetaSearchResultBlockParam` - `Type SearchResult` - `Content []BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `Source string` - `Title string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `Enabled bool Optional` ### Beta Server Tool Caller - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Server Tool Caller 20260120 - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Server Tool Usage - `type BetaServerToolUsage` - `WebFetchRequests int64` The number of web fetch tool requests. default: 0, minimum: 0 - `WebSearchRequests int64` The number of web search tool requests. default: 0, minimum: 0 ### Beta Server Tool Use Block - `type BetaServerToolUseBlock` - `Type ServerToolUse` default: server_tool_use - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"` - `const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"` - `const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"` - `const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"` - `const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"` - `const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"` - `Caller BetaServerToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Server Tool Use Block Param - `type BetaServerToolUseBlockParam` - `Type ServerToolUse` - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `const BetaServerToolUseBlockParamNameWebSearch BetaServerToolUseBlockParamName = "web_search"` - `const BetaServerToolUseBlockParamNameWebFetch BetaServerToolUseBlockParamName = "web_fetch"` - `const BetaServerToolUseBlockParamNameCodeExecution BetaServerToolUseBlockParamName = "code_execution"` - `const BetaServerToolUseBlockParamNameBashCodeExecution BetaServerToolUseBlockParamName = "bash_code_execution"` - `const BetaServerToolUseBlockParamNameTextEditorCodeExecution BetaServerToolUseBlockParamName = "text_editor_code_execution"` - `const BetaServerToolUseBlockParamNameToolSearchToolRegex BetaServerToolUseBlockParamName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockParamNameToolSearchToolBm25 BetaServerToolUseBlockParamName = "tool_search_tool_bm25"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Caller BetaServerToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Signature Delta - `type BetaSignatureDelta` - `Type SignatureDelta` default: signature_delta - `Signature string` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. ### Beta Skill Params - `type BetaSkillParams` Specification for a skill to be loaded in a container (request model). - `Type BetaSkillParamsType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillParamsTypeAnthropic BetaSkillParamsType = "anthropic"` - `const BetaSkillParamsTypeCustom BetaSkillParamsType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string Optional` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 ### Beta Stop Reason - `type BetaStopReason string` - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` ### Beta Summarize Compaction - `type BetaSummarizeCompaction` 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. - `Type Summarize` - `Instructions string Optional` Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent. maxLength: 16384 ### Beta System Message Output Config - `type BetaSystemMessageOutputConfigParam` 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 Optional` 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`. - `const BetaSystemMessageOutputConfigEffortLow BetaSystemMessageOutputConfigEffort = "low"` - `const BetaSystemMessageOutputConfigEffortMedium BetaSystemMessageOutputConfigEffort = "medium"` - `const BetaSystemMessageOutputConfigEffortHigh BetaSystemMessageOutputConfigEffort = "high"` - `const BetaSystemMessageOutputConfigEffortXhigh BetaSystemMessageOutputConfigEffort = "xhigh"` - `const BetaSystemMessageOutputConfigEffortMax BetaSystemMessageOutputConfigEffort = "max"` ### Beta Text Block - `type BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `Text string` ### Beta Text Block Param - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` ### Beta Text Citation - `type BetaTextCitationUnion interface{…}` - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` ### Beta Text Citation Param - `type BetaTextCitationParamUnion interface{…}` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` ### Beta Text Delta - `type BetaTextDelta` - `Type TextDelta` default: text_delta - `Text string` ### Beta Text Editor Code Execution Create Result Block - `type BetaTextEditorCodeExecutionCreateResultBlock` - `Type TextEditorCodeExecutionCreateResult` default: text_editor_code_execution_create_result - `IsFileUpdate bool` ### Beta Text Editor Code Execution Create Result Block Param - `type BetaTextEditorCodeExecutionCreateResultBlockParam` - `Type TextEditorCodeExecutionCreateResult` - `IsFileUpdate bool` ### Beta Text Editor Code Execution Str Replace Result Block - `type BetaTextEditorCodeExecutionStrReplaceResultBlock` - `Type TextEditorCodeExecutionStrReplaceResult` default: text_editor_code_execution_str_replace_result - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` ### Beta Text Editor Code Execution Str Replace Result Block Param - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `Type TextEditorCodeExecutionStrReplaceResult` - `Lines []string Optional` - `NewLines int64 Optional` - `NewStart int64 Optional` - `OldLines int64 Optional` - `OldStart int64 Optional` ### Beta Text Editor Code Execution Tool Result Block - `type BetaTextEditorCodeExecutionToolResultBlock` - `Type TextEditorCodeExecutionToolResult` default: text_editor_code_execution_tool_result - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError` - `Type TextEditorCodeExecutionToolResultError` default: text_editor_code_execution_tool_result_error - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlock` - `Type TextEditorCodeExecutionViewResult` default: text_editor_code_execution_view_result - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlock` - `Type TextEditorCodeExecutionCreateResult` default: text_editor_code_execution_create_result - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock` - `Type TextEditorCodeExecutionStrReplaceResult` default: text_editor_code_execution_str_replace_result - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Text Editor Code Execution Tool Result Block Param - `type BetaTextEditorCodeExecutionToolResultBlockParam` - `Type TextEditorCodeExecutionToolResult` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnion` - `type BetaTextEditorCodeExecutionToolResultErrorParam` - `Type TextEditorCodeExecutionToolResultError` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "file_not_found"` - `ErrorMessage string Optional` - `type BetaTextEditorCodeExecutionViewResultBlockParam` - `Type TextEditorCodeExecutionViewResult` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `NumLines int64 Optional` - `StartLine int64 Optional` - `TotalLines int64 Optional` - `type BetaTextEditorCodeExecutionCreateResultBlockParam` - `Type TextEditorCodeExecutionCreateResult` - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `Type TextEditorCodeExecutionStrReplaceResult` - `Lines []string Optional` - `NewLines int64 Optional` - `NewStart int64 Optional` - `OldLines int64 Optional` - `OldStart int64 Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Text Editor Code Execution Tool Result Error - `type BetaTextEditorCodeExecutionToolResultError` - `Type TextEditorCodeExecutionToolResultError` default: text_editor_code_execution_tool_result_error - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"` - `ErrorMessage string` ### Beta Text Editor Code Execution Tool Result Error Param - `type BetaTextEditorCodeExecutionToolResultErrorParam` - `Type TextEditorCodeExecutionToolResultError` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "file_not_found"` - `ErrorMessage string Optional` ### Beta Text Editor Code Execution View Result Block - `type BetaTextEditorCodeExecutionViewResultBlock` - `Type TextEditorCodeExecutionViewResult` default: text_editor_code_execution_view_result - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` ### Beta Text Editor Code Execution View Result Block Param - `type BetaTextEditorCodeExecutionViewResultBlockParam` - `Type TextEditorCodeExecutionViewResult` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `NumLines int64 Optional` - `StartLine int64 Optional` - `TotalLines int64 Optional` ### Beta Thinking Block - `type BetaThinkingBlock` - `Type Thinking` default: thinking - `Signature string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. - `Thinking string` The text of Claude's thinking process for this block. ### Beta Thinking Block Binding - `type BetaThinkingBlockBindingParam` 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`. - `const BetaThinkingPrefixMismatchBehaviorError BetaThinkingPrefixMismatchBehavior = "error"` - `const BetaThinkingPrefixMismatchBehaviorDropBlock BetaThinkingPrefixMismatchBehavior = "drop_block"` ### Beta Thinking Block Param - `type BetaThinkingBlockParam` - `Type Thinking` - `Signature string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `Thinking string` The `thinking` text of this block as returned by the API. ### Beta Thinking Config Adaptive - `type BetaThinkingConfigAdaptiveParam` - `Type Adaptive` - `BlockBinding BetaThinkingBlockBindingParam Optional` 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`. - `const BetaThinkingPrefixMismatchBehaviorError BetaThinkingPrefixMismatchBehavior = "error"` - `const BetaThinkingPrefixMismatchBehaviorDropBlock BetaThinkingPrefixMismatchBehavior = "drop_block"` - `Display BetaThinkingConfigAdaptiveDisplay Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#controlling-thinking-display). - `const BetaThinkingConfigAdaptiveDisplaySummarized BetaThinkingConfigAdaptiveDisplay = "summarized"` - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` ### Beta Thinking Config Between Tools - `type BetaThinkingConfigBetweenToolsParam` - `Type BetweenTools` ### Beta Thinking Config Disabled - `type BetaThinkingConfigDisabledParam` - `Type Disabled` ### Beta Thinking Config Enabled - `type BetaThinkingConfigEnabledParam` - `Type Enabled` - `BudgetTokens int64` 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](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. minimum: 1024 - `BlockBinding BetaThinkingBlockBindingParam Optional` 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`. - `const BetaThinkingPrefixMismatchBehaviorError BetaThinkingPrefixMismatchBehavior = "error"` - `const BetaThinkingPrefixMismatchBehaviorDropBlock BetaThinkingPrefixMismatchBehavior = "drop_block"` - `Display BetaThinkingConfigEnabledDisplay Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#controlling-thinking-display). - `const BetaThinkingConfigEnabledDisplaySummarized BetaThinkingConfigEnabledDisplay = "summarized"` - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` ### Beta Thinking Config Param - `type BetaThinkingConfigParamUnion interface{…}` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#configuring-thinking) for each model's behavior. - `type BetaThinkingConfigEnabledParam` - `Type Enabled` - `BudgetTokens int64` 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](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. minimum: 1024 - `BlockBinding BetaThinkingBlockBindingParam Optional` 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`. - `const BetaThinkingPrefixMismatchBehaviorError BetaThinkingPrefixMismatchBehavior = "error"` - `const BetaThinkingPrefixMismatchBehaviorDropBlock BetaThinkingPrefixMismatchBehavior = "drop_block"` - `Display BetaThinkingConfigEnabledDisplay Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#controlling-thinking-display). - `const BetaThinkingConfigEnabledDisplaySummarized BetaThinkingConfigEnabledDisplay = "summarized"` - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` - `type BetaThinkingConfigDisabledParam` - `Type Disabled` - `type BetaThinkingConfigBetweenToolsParam` - `Type BetweenTools` - `type BetaThinkingConfigAdaptiveParam` - `Type Adaptive` - `BlockBinding BetaThinkingBlockBindingParam Optional` 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. - `Display BetaThinkingConfigAdaptiveDisplay Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#controlling-thinking-display). - `const BetaThinkingConfigAdaptiveDisplaySummarized BetaThinkingConfigAdaptiveDisplay = "summarized"` - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` ### Beta Thinking Delta - `type BetaThinkingDelta` - `Type ThinkingDelta` default: thinking_delta - `EstimatedTokens int64` Per-frame increment of a coarse, running estimate of the tokens this thinking block has produced so far. Present whenever the `thinking-token-count-2026-05-13` beta is set; `null` unless `thinking.display` resolves to `"omitted"` and a count is due this frame. Sum the increments across `thinking_delta` frames on this block for a progress indicator. Each increment is a non-negative multiple of a fixed quantum and the cadence is rate-limited, so this is a deliberately lossy display hint, not a billable count; `usage.output_tokens` remains authoritative. - `Thinking string` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. ### Beta Thinking Dropped Input Transformation - `type BetaThinkingDroppedInputTransformation` - `Type ThinkingDropped` Always `thinking_dropped` for this entry type. default: thinking_dropped - `Path string` 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 BetaThinkingDroppedInputTransformationReason` 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`. - `const BetaThinkingDroppedInputTransformationReasonModelBindingMismatch BetaThinkingDroppedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonPrefixBindingMismatch BetaThinkingDroppedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonOrganizationBindingMismatch BetaThinkingDroppedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonEndUserBindingMismatch BetaThinkingDroppedInputTransformationReason = "end_user_binding_mismatch"` ### Beta Thinking Mismatch Allowed Input Transformation - `type BetaThinkingMismatchAllowedInputTransformation` - `Type ThinkingMismatchAllowed` Always `thinking_mismatch_allowed` for this entry type. default: thinking_mismatch_allowed - `Path string` 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 BetaThinkingMismatchAllowedInputTransformationReason` 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. - `const BetaThinkingMismatchAllowedInputTransformationReasonModelBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonPrefixBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonOrganizationBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonEndUserBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "end_user_binding_mismatch"` ### Beta Thinking Prefix Mismatch Behavior - `type BetaThinkingPrefixMismatchBehavior string` 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. - `const BetaThinkingPrefixMismatchBehaviorError BetaThinkingPrefixMismatchBehavior = "error"` - `const BetaThinkingPrefixMismatchBehaviorDropBlock BetaThinkingPrefixMismatchBehavior = "drop_block"` ### Beta Thinking Turns - `type BetaThinkingTurnsParam` - `Type ThinkingTurns` - `Value int64` minimum: 1 ### Beta Token Task Budget - `type BetaTokenTaskBudgetParam` User-configurable total token budget across contexts. - `Type Tokens` The budget type. Currently only 'tokens' is supported. - `Total int64` Total token budget across all contexts in the session. minimum: 1024 - `Remaining int64 Optional` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. minimum: 0 ### Beta Tool - `type BetaToolParam` - `Type BetaToolType Optional` - `InputSchema BetaToolInputSchemaParam` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `const BetaToolAllowedCallerCodeExecution20260521 BetaToolAllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Bash 20241022 - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Bash 20250124 - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Change MCP Tool Reference - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `Type MCPToolReference` - `Name string` - `ServerName string` ### Beta Tool Change MCP Toolset Reference - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `Type MCPToolsetReference` - `ServerName string` ### Beta Tool Change Tool Definition - `type BetaToolChangeToolDefinition` 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` default: tool_definition - `Definition BetaResponseToolUnion` - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. ### Beta Tool Change Tool Definition Param - `type BetaToolChangeToolDefinitionParam` 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. - `Type ToolDefinition` - `Definition BetaToolUnionParam` - `type BetaToolParam` - `Type BetaToolType Optional` - `InputSchema BetaToolInputSchemaParam` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `const BetaToolAllowedCallerCodeExecution20260521 BetaToolAllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. ### Beta Tool Change Tool Reference - `type BetaToolChangeToolReferenceParam` 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. - `Type ToolReference` - `Name string` pattern: ^[a-zA-Z0-9_-]{1,128}$ ### Beta Tool Choice - `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. - `type BetaToolChoiceAutoParam` The model will automatically decide whether to use tools. - `Type Auto` - `DisableParallelToolUse bool Optional` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `type BetaToolChoiceAnyParam` The model will use any available tools. - `Type Any` - `DisableParallelToolUse bool Optional` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `type BetaToolChoiceToolParam` The model will use the specified tool with `tool_choice.name`. - `Type Tool` - `Name string` The name of the tool to use. - `DisableParallelToolUse bool Optional` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `type BetaToolChoiceNoneParam` The model will not be allowed to use tools. - `Type None` ### Beta Tool Choice Any - `type BetaToolChoiceAnyParam` The model will use any available tools. - `Type Any` - `DisableParallelToolUse bool Optional` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. ### Beta Tool Choice Auto - `type BetaToolChoiceAutoParam` The model will automatically decide whether to use tools. - `Type Auto` - `DisableParallelToolUse bool Optional` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. ### Beta Tool Choice None - `type BetaToolChoiceNoneParam` The model will not be allowed to use tools. - `Type None` ### Beta Tool Choice Tool - `type BetaToolChoiceToolParam` The model will use the specified tool with `tool_choice.name`. - `Type Tool` - `Name string` The name of the tool to use. - `DisableParallelToolUse bool Optional` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. ### Beta Tool Computer Use 20241022 - `type BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Computer Use 20250124 - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Computer Use 20251124 - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Reference Block - `type BetaToolReferenceBlock` - `Type ToolReference` default: tool_reference - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ ### Beta Tool Reference Block Param - `type BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Tool Result Block Param - `type BetaToolResultBlockParam` - `Type ToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Content []BetaToolResultBlockParamContentUnion Optional` - `[]BetaToolResultBlockParamContentUnion` - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` - `type BetaSearchResultBlockParam` - `Type SearchResult` - `Content []BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `Source string` - `Title string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `Enabled bool Optional` - `type BetaRequestDocumentBlockParam` - `Type Document` - `Source BetaRequestDocumentBlockSourceUnionParam` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `type BetaContentBlockSourceParam` - `Type Content` - `Content BetaContentBlockSourceContentUnionParam` - `string` - `[]BetaContentBlockSourceContentUnionParam` - `type BetaTextBlockParam` - `type BetaImageBlockParam` - `type BetaURLPDFSourceParam` - `Type URL` - `URL string` - `type BetaFileDocumentSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `Context string Optional` minLength: 1 - `Title string Optional` minLength: 1, maxLength: 500 - `type BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `Type BrowserState` - `Tabs []BetaBrowserStateTabEntryParam` 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`. maxItems: 100 - `TabID string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Title string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Active bool Optional` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `StateChanges []BetaBrowserStateChangeUnionParam Optional` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `type BetaBrowserStateChangeTabOpenedParam` 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. - `Type TabOpened` - `TabID string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadStartedParam` A file download that started during this call. - `Type DownloadStarted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadCompletedParam` 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). - `Type DownloadCompleted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Path string Optional` 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. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `SizeBytes int64 Optional` The completed download's size. minimum: 0 - `type BetaBrowserStateChangeDownloadFailedParam` A file download that failed — or was cancelled — during this call. - `Type DownloadFailed` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Error string Optional` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `IsError bool Optional` - `ToolsetName string Optional` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Beta Tool Search Tool Bm25 20251119 - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Search Tool Regex 20251119 - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Search Tool Result Block - `type BetaToolSearchToolResultBlock` - `Type ToolSearchToolResult` default: tool_search_tool_result - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError` - `Type ToolSearchToolResultError` default: tool_search_tool_result_error - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"` - `ErrorMessage string` - `type BetaToolSearchToolSearchResultBlock` - `Type ToolSearchToolSearchResult` default: tool_search_tool_search_result - `ToolReferences []BetaToolReferenceBlock` - `Type ToolReference` default: tool_reference - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Tool Search Tool Result Block Param - `type BetaToolSearchToolResultBlockParam` - `Type ToolSearchToolResult` - `Content BetaToolSearchToolResultBlockParamContentUnion` - `type BetaToolSearchToolResultErrorParam` - `Type ToolSearchToolResultError` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `ErrorMessage string Optional` - `type BetaToolSearchToolSearchResultBlockParam` - `Type ToolSearchToolSearchResult` - `ToolReferences []BetaToolReferenceBlockParam` - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. ### Beta Tool Search Tool Result Error - `type BetaToolSearchToolResultError` - `Type ToolSearchToolResultError` default: tool_search_tool_result_error - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"` - `ErrorMessage string` ### Beta Tool Search Tool Result Error Param - `type BetaToolSearchToolResultErrorParam` - `Type ToolSearchToolResultError` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `ErrorMessage string Optional` ### Beta Tool Search Tool Search Result Block - `type BetaToolSearchToolSearchResultBlock` - `Type ToolSearchToolSearchResult` default: tool_search_tool_search_result - `ToolReferences []BetaToolReferenceBlock` - `Type ToolReference` default: tool_reference - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ ### Beta Tool Search Tool Search Result Block Param - `type BetaToolSearchToolSearchResultBlockParam` - `Type ToolSearchToolSearchResult` - `ToolReferences []BetaToolReferenceBlockParam` - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` ### Beta Tool Text Editor 20241022 - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250124 - `type BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250429 - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250728 - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs ### Beta Tool Union - `type BetaToolUnionParam interface{…}` - `type BetaToolParam` - `Type BetaToolType Optional` - `InputSchema BetaToolInputSchemaParam` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `const BetaToolAllowedCallerCodeExecution20260521 BetaToolAllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. ### Beta Tool Use Block - `type BetaToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1 - `Caller BetaToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Beta Tool Use Block Param - `type BetaToolUseBlockParam` - `Type ToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1, maxLength: 200 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Caller BetaToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Beta Tool Use Caller - `type BetaToolUseCallerUnion interface{…}` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Tool Uses Keep - `type BetaToolUsesKeepParam` - `Type ToolUses` - `Value int64` minimum: 0 ### Beta Tool Uses Trigger - `type BetaToolUsesTriggerParam` - `Type ToolUses` - `Value int64` minimum: 1 ### Beta Toolset Tool Use Block - `type BetaToolsetToolUseBlockUnion interface{…}` - `type BetaBrowserToolUseBlockUnion interface{…}` - `type BetaBrowserNavigateToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserNavigateInput` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `URL string` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Navigate` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaBrowserListTabsToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserListTabsInput` List all open tabs with each tab's tab_id, title, and URL. - `Name ListTabs` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserNewTabToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserNewTabInput` Open a new empty tab and return its tab_id. - `Name NewTab` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserSwitchTabToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserSwitchTabInput` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `TabID string` The tab to switch to. - `Name SwitchTab` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserCloseTabToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserCloseTabInput` Close the tab with the given tab_id. - `TabID string` The tab to close. - `Name CloseTab` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserReadPageToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserReadPageInput` 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 Optional` Maximum tree depth. Default 15. minimum: 1 - `Filter BetaBrowserReadPageFilter Optional` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `const BetaBrowserReadPageFilterAll BetaBrowserReadPageFilter = "all"` - `const BetaBrowserReadPageFilterInteractive BetaBrowserReadPageFilter = "interactive"` - `Ref string Optional` Element reference to read a subtree from. Omit to read from the page root. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ReadPage` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserGetPageTextToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserGetPageTextInput` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name GetPageText` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserReadConsoleToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserReadConsoleInput` 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. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ReadConsole` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserReadNetworkToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserReadNetworkInput` 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. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ReadNetwork` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserFindToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserFindInput` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `Query string` Natural-language description of the element(s) to find. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Find` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserFormInputToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserFormInputInput` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `Target BetaBrowserRefTarget` 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. - `Type Ref` - `Ref string` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `Value BetaBrowserFormInputValueUnion` The value to set. - `string` - `float64` - `bool` - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name FormInput` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserFileUploadToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserFileUploadInput` 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 BetaBrowserRefTarget` 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. - `DocumentIDs []string Optional` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `Paths []string Optional` File paths on the browser executor's filesystem. minItems: 1 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name FileUpload` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserScrollToToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserScrollToInput` Scroll an element into view. - `Target BetaBrowserRefTarget` 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. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name ScrollTo` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserScreenshotToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserScreenshotInput` Capture the current browser viewport. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Screenshot` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserZoomToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserZoomInput` 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. minItems: 4, maxItems: 4 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Zoom` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserLeftClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftClickInput` Left-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `type BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Type Coordinate` - `X int64` Pixels from the left edge of the viewport. minimum: 0 - `Y int64` Pixels from the top edge of the viewport. minimum: 0 - `type BetaBrowserRefTarget` 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. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserRightClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserRightClickInput` Right-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name RightClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserMiddleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserMiddleClickInput` Middle-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name MiddleClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserDoubleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserDoubleClickInput` Double left-click at a viewport coordinate or on an element by reference. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name DoubleClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserTripleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserTripleClickInput` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `Modifiers string Optional` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name TripleClick` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserHoverToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserHoverInput` Move the cursor to a coordinate or element without clicking. - `Target BetaBrowserClickTargetUnion` Where to act: either a viewport coordinate or an element reference. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Hover` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserLeftClickDragToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftClickDragInput` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `From BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftClickDrag` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserLeftMouseDownToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftMouseDownInput` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftMouseDown` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserLeftMouseUpToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserLeftMouseUpInput` Release the left mouse button at a viewport coordinate. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name LeftMouseUp` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserMouseMoveToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserMouseMoveInput` Move the pointer to a viewport coordinate without clicking. - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name MouseMove` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserScrollToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserScrollInput` Scroll at a viewport position. `target` must be a coordinate target. - `ScrollDirection BetaBrowserScrollDirection` - `const BetaBrowserScrollDirectionUp BetaBrowserScrollDirection = "up"` - `const BetaBrowserScrollDirectionDown BetaBrowserScrollDirection = "down"` - `const BetaBrowserScrollDirectionLeft BetaBrowserScrollDirection = "left"` - `const BetaBrowserScrollDirectionRight BetaBrowserScrollDirection = "right"` - `Target BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `ScrollAmount int64 Optional` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Scroll` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserTypeToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserTypeInput` Type a literal string at the current focus. - `Text string` The text to type. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Type` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserKeyInput` 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. - `Text string` The key, chord, or space-separated sequence to press. - `Repeat int64 Optional` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Key` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserHoldKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserHoldKeyInput` 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 float64` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `Text string` The key or chord to hold. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name HoldKey` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserWaitToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserWaitInput` Pause for the given duration. - `Duration float64` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name Wait` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaBrowserJavascriptExecToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaBrowserJavascriptExecInput` 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`. - `Text string` JavaScript to execute in the page context. - `TabID string Optional` Tab to act on. Defaults to the active tab when omitted. - `Name JavascriptExec` - `ToolsetName Browser` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerToolUseBlockUnion interface{…}` - `type BetaComputerKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerKeyInput` 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. - `Text string` The key or key-combination to press. - `Repeat int64 Optional` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `Name Key` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerHoldKeyToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerHoldKeyInput` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `Duration int64` Duration to hold the key, in seconds. maximum: 300 - `Text string` The key or key-combination to hold. - `Name HoldKey` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerTypeToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerTypeInput` Type a string of text on the keyboard. - `Text string` The text to type. - `Name Type` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerCursorPositionToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerCursorPositionInput` Get the current (x, y) pixel coordinate of the cursor. - `Name CursorPosition` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerMouseMoveToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerMouseMoveInput` 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. minItems: 2, maxItems: 2 - `Name MouseMove` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerLeftMouseDownToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftMouseDownInput` Press and hold the left mouse button at the current cursor position. - `Name LeftMouseDown` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerLeftMouseUpToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftMouseUpInput` Release the left mouse button. - `Name LeftMouseUp` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerLeftClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name LeftClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerLeftClickDragToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerLeftClickDragInput` 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. minItems: 2, maxItems: 2 - `StartCoordinate []int64` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name LeftClickDrag` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerRightClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerRightClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name RightClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerMiddleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerMiddleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name MiddleClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerDoubleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerDoubleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name DoubleClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerTripleClickToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerTripleClickInput` 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. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name TripleClick` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerScrollToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerScrollInput` 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. - `ScrollAmount int64` Number of 'clicks' of the scroll wheel. - `ScrollDirection BetaComputerScrollDirection` - `const BetaComputerScrollDirectionUp BetaComputerScrollDirection = "up"` - `const BetaComputerScrollDirectionDown BetaComputerScrollDirection = "down"` - `const BetaComputerScrollDirectionLeft BetaComputerScrollDirection = "left"` - `const BetaComputerScrollDirectionRight BetaComputerScrollDirection = "right"` - `Coordinate []int64 Optional` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `Text string Optional` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `Name Scroll` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerWaitToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerWaitInput` Wait for a specified duration. - `Duration int64` Duration to wait, in seconds. maximum: 300 - `Name Wait` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerScreenshotToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerScreenshotInput` Take a screenshot of the screen. - `Name Screenshot` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaComputerZoomToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input BetaComputerZoomInput` 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. minItems: 4, maxItems: 4 - `Name Zoom` - `ToolsetName Computer` - `Caller BetaToolUseCallerUnion Optional` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `type BetaToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1 - `Caller BetaToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `ToolsetName string Optional` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Beta URL Image Source - `type BetaURLImageSourceParam` - `Type URL` - `URL string` ### Beta URL PDF Source - `type BetaURLPDFSourceParam` - `Type URL` - `URL string` ### Beta Usage - `type BetaUsage` - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. minimum: 0 - `FallbackCredit BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `Status BetaFallbackCreditUsageStatusUnion` 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` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `Type Redeemed` default: redeemed - `type BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `Type NotApplied` default: not_applied - `Reason BetaFallbackCreditNotAppliedReason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `const BetaFallbackCreditNotAppliedReasonBodyMismatch BetaFallbackCreditNotAppliedReason = "body_mismatch"` - `const BetaFallbackCreditNotAppliedReasonContinuationExcluded BetaFallbackCreditNotAppliedReason = "continuation_excluded"` - `const BetaFallbackCreditNotAppliedReasonContinuationOnly BetaFallbackCreditNotAppliedReason = "continuation_only"` - `const BetaFallbackCreditNotAppliedReasonExpired BetaFallbackCreditNotAppliedReason = "expired"` - `const BetaFallbackCreditNotAppliedReasonInvalidTargetModel BetaFallbackCreditNotAppliedReason = "invalid_target_model"` - `const BetaFallbackCreditNotAppliedReasonNotEnabled BetaFallbackCreditNotAppliedReason = "not_enabled"` - `const BetaFallbackCreditNotAppliedReasonRepriceUnavailable BetaFallbackCreditNotAppliedReason = "reprice_unavailable"` - `const BetaFallbackCreditNotAppliedReasonTemporarilyUnavailable BetaFallbackCreditNotAppliedReason = "temporarily_unavailable"` - `const BetaFallbackCreditNotAppliedReasonVariantFieldsPresent BetaFallbackCreditNotAppliedReason = "variant_fields_present"` - `const BetaFallbackCreditNotAppliedReasonWrongOrganization BetaFallbackCreditNotAppliedReason = "wrong_organization"` - `const BetaFallbackCreditNotAppliedReasonWrongPlatform BetaFallbackCreditNotAppliedReason = "wrong_platform"` - `const BetaFallbackCreditNotAppliedReasonWrongWorkspace BetaFallbackCreditNotAppliedReason = "wrong_workspace"` - `RemoveToRedeem []string Optional` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Iterations BetaIterationsUsage` 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 `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `type BetaMessageIterationUsage` Token usage for a sampling iteration. - `Type Message` Usage for a sampling iteration default: message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaCompactionIterationUsage` Token usage for a compaction iteration. - `Type Compaction` Usage for a compaction iteration default: compaction - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration default: advisor_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaFallbackMessageIterationUsage` 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 FallbackMessage` Usage for the fallback-model attempt that served the response default: fallback_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokensDetails BetaOutputTokensDetails` 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. - `ThinkingTokens int64` 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. default: 0, minimum: 0 - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. default: 0, minimum: 0 - `WebSearchRequests int64` The number of web search tool requests. default: 0, minimum: 0 - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` ### Beta User Location - `type BetaUserLocation` - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Beta Web Fetch Block - `type BetaWebFetchBlock` - `Type WebFetchResult` default: web_fetch_result - `Content BetaDocumentBlock` - `Type Document` default: document - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` default: false - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `Title string` The title of the document - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `URL string` Fetched content URL ### Beta Web Fetch Block Param - `type BetaWebFetchBlockParam` - `Type WebFetchResult` - `Content BetaRequestDocumentBlockParam` - `Type Document` - `Source BetaRequestDocumentBlockSourceUnionParam` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `type BetaContentBlockSourceParam` - `Type Content` - `Content BetaContentBlockSourceContentUnionParam` - `string` - `[]BetaContentBlockSourceContentUnionParam` - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` - `type BetaURLPDFSourceParam` - `Type URL` - `URL string` - `type BetaFileDocumentSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `Enabled bool Optional` - `Context string Optional` minLength: 1 - `Title string Optional` minLength: 1, maxLength: 500 - `URL string` Fetched content URL - `RetrievedAt string Optional` ISO 8601 timestamp when the content was retrieved ### Beta Web Fetch Tool 20250910 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. ### Beta Web Fetch Tool 20260209 - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. ### Beta Web Fetch Tool 20260309 - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. ### Beta Web Fetch Tool 20260318 - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. ### Beta Web Fetch Tool Result Block - `type BetaWebFetchToolResultBlock` - `Type WebFetchToolResult` default: web_fetch_tool_result - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock` - `Type WebFetchToolResultError` default: web_fetch_tool_result_error - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlock` - `Type WebFetchResult` default: web_fetch_result - `Content BetaDocumentBlock` - `Type Document` default: document - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` default: false - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `Title string` The title of the document - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `URL string` Fetched content URL - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebFetchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Web Fetch Tool Result Block Param - `type BetaWebFetchToolResultBlockParam` - `Type WebFetchToolResult` - `Content BetaWebFetchToolResultBlockParamContentUnion` - `type BetaWebFetchToolResultErrorBlockParam` - `Type WebFetchToolResultError` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlockParam` - `Type WebFetchResult` - `Content BetaRequestDocumentBlockParam` - `Type Document` - `Source BetaRequestDocumentBlockSourceUnionParam` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `type BetaContentBlockSourceParam` - `Type Content` - `Content BetaContentBlockSourceContentUnionParam` - `string` - `[]BetaContentBlockSourceContentUnionParam` - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` - `type BetaURLPDFSourceParam` - `Type URL` - `URL string` - `type BetaFileDocumentSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `Enabled bool Optional` - `Context string Optional` minLength: 1 - `Title string Optional` minLength: 1, maxLength: 500 - `URL string` Fetched content URL - `RetrievedAt string Optional` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Web Fetch Tool Result Error Block - `type BetaWebFetchToolResultErrorBlock` - `Type WebFetchToolResultError` default: web_fetch_tool_result_error - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` ### Beta Web Fetch Tool Result Error Block Param - `type BetaWebFetchToolResultErrorBlockParam` - `Type WebFetchToolResultError` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` ### Beta Web Fetch Tool Result Error Code - `type BetaWebFetchToolResultErrorCode string` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` ### Beta Web Fetch URL Source All - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` ### Beta Web Fetch URL Source Except - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` ### Beta Web Fetch URL Source None - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` ### Beta Web Fetch URL Source Only - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` ### Beta Web Fetch URL Source Tool Reference - `type BetaWebFetchURLSourceToolReference` One entry of a tool filter's `tools`: it must name a tool declared in this request's `tools[]`. - `Type ToolReference` - `Name string` ### Beta Web Fetch URL Sources - `type BetaWebFetchURLSources` 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[]`. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. ### Beta Web Search Result Block - `type BetaWebSearchResultBlock` - `Type WebSearchResult` default: web_search_result - `EncryptedContent string` - `PageAge string` - `Title string` - `URL string` ### Beta Web Search Result Block Param - `type BetaWebSearchResultBlockParam` - `Type WebSearchResult` - `EncryptedContent string` - `Title string` - `URL string` - `PageAge string Optional` ### Beta Web Search Tool 20250305 - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Beta Web Search Tool 20260209 - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Beta Web Search Tool 20260318 - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Beta Web Search Tool Request Error - `type BetaWebSearchToolRequestErrorParam` - `Type WebSearchToolResultError` - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` ### Beta Web Search Tool Result Block - `type BetaWebSearchToolResultBlock` - `Type WebSearchToolResult` default: web_search_tool_result - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError` - `Type WebSearchToolResultError` default: web_search_tool_result_error - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `[]BetaWebSearchResultBlock` - `Type WebSearchResult` default: web_search_result - `EncryptedContent string` - `PageAge string` - `Title string` - `URL string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebSearchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Web Search Tool Result Block Content - `type BetaWebSearchToolResultBlockContentUnion interface{…}` - `type BetaWebSearchToolResultError` - `Type WebSearchToolResultError` default: web_search_tool_result_error - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `[]BetaWebSearchResultBlock` - `Type WebSearchResult` default: web_search_result - `EncryptedContent string` - `PageAge string` - `Title string` - `URL string` ### Beta Web Search Tool Result Block Param - `type BetaWebSearchToolResultBlockParam` - `Type WebSearchToolResult` - `Content BetaWebSearchToolResultBlockParamContentUnion` - `[]BetaWebSearchResultBlockParam` - `Type WebSearchResult` - `EncryptedContent string` - `Title string` - `URL string` - `PageAge string Optional` - `type BetaWebSearchToolRequestErrorParam` - `Type WebSearchToolResultError` - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Caller BetaWebSearchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Web Search Tool Result Block Param Content - `type BetaWebSearchToolResultBlockParamContentUnion interface{…}` - `[]BetaWebSearchResultBlockParam` - `Type WebSearchResult` - `EncryptedContent string` - `Title string` - `URL string` - `PageAge string Optional` - `type BetaWebSearchToolRequestErrorParam` - `Type WebSearchToolResultError` - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` ### Beta Web Search Tool Result Error - `type BetaWebSearchToolResultError` - `Type WebSearchToolResultError` default: web_search_tool_result_error - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` ### Beta Web Search Tool Result Error Code - `type BetaWebSearchToolResultErrorCode string` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` ## Messages › Batches ### Create a Message Batch `client.Beta.Messages.Batches.New(ctx, params) (*BetaMessageBatch, error)` **POST** `/v1/messages/batches` Send a batch of Message creation requests. The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=go) #### Parameters - `params BetaMessageBatchNewParams` - `Requests []BetaMessageBatchNewParamsRequest` List of requests for prompt completion. Each is an individual request to create a Message. minItems: 1, maxItems: 100000 - `CustomID string` Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]{1,64}$ - `Params BetaMessageBatchNewParamsRequestParams` Messages API creation parameters for the individual request. See the [Messages API reference](https://platform.claude.com/docs/en/api/messages?sdk_languages=go) for full documentation on available parameters. - `MaxTokens int64` The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview?sdk_languages=go) for details. minimum: 0 - `Messages []BetaMessageParam` Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. This is called prefill. On models that don't support prefill, creating a message that ends with a partial `assistant` response returns a 400 error. See [Prefill not supported](https://platform.claude.com/docs/en/api/errors?sdk_languages=go#prefill-not-supported). Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude, for models that support prefill: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages?sdk_languages=go). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=go#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `Content []BetaContentBlockParamUnion` - `[]BetaContentBlockParamUnion` - `type BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `Citations []BetaTextCitationParamUnion Optional` - `type BetaCitationCharLocationParam` - `Type CharLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndCharIndex int64` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocationParam` - `Type PageLocation` - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndPageNumber int64` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocationParam` - `Type ContentBlockLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` minLength: 1, maxLength: 500 - `EndBlockIndex int64` 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 int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationWebSearchResultLocationParam` - `Type WebSearchResultLocation` - `CitedText string` - `EncryptedIndex string` - `Title string` minLength: 1, maxLength: 512 - `URL string` minLength: 1 - `type BetaCitationSearchResultLocationParam` - `Type SearchResultLocation` - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `type BetaImageBlockParam` - `Type Image` - `Source BetaImageBlockParamSourceUnion` - `type BetaBase64ImageSourceParam` - `Type Base64` - `Data string` format: byte - `MediaType BetaBase64ImageSourceMediaType` - `const BetaBase64ImageSourceMediaTypeImageJPEG BetaBase64ImageSourceMediaType = "image/jpeg"` - `const BetaBase64ImageSourceMediaTypeImagePNG BetaBase64ImageSourceMediaType = "image/png"` - `const BetaBase64ImageSourceMediaTypeImageGIF BetaBase64ImageSourceMediaType = "image/gif"` - `const BetaBase64ImageSourceMediaTypeImageWebP BetaBase64ImageSourceMediaType = "image/webp"` - `type BetaURLImageSourceParam` - `Type URL` - `URL string` - `type BetaFileImageSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Transformations BetaImageTransformationsParam Optional` 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 Optional` 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. - `const BetaImageTransformationsParamOversizedImageDownsize BetaImageTransformationsParamOversizedImage = "downsize"` - `const BetaImageTransformationsParamOversizedImageError BetaImageTransformationsParamOversizedImage = "error"` - `type BetaRequestDocumentBlockParam` - `Type Document` - `Source BetaRequestDocumentBlockSourceUnionParam` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `type BetaContentBlockSourceParam` - `Type Content` - `Content BetaContentBlockSourceContentUnionParam` - `string` - `[]BetaContentBlockSourceContentUnionParam` - `type BetaTextBlockParam` - `type BetaImageBlockParam` - `type BetaURLPDFSourceParam` - `Type URL` - `URL string` - `type BetaFileDocumentSourceParam` - `Type File` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `Enabled bool Optional` - `Context string Optional` minLength: 1 - `Title string Optional` minLength: 1, maxLength: 500 - `type BetaSearchResultBlockParam` - `Type SearchResult` - `Content []BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `Source string` - `Title string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParam Optional` - `type BetaThinkingBlockParam` - `Type Thinking` - `Signature string` The `signature` value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude. Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 `invalid_request_error`. - `Thinking string` The `thinking` text of this block as returned by the API. - `type BetaRedactedThinkingBlockParam` - `Type RedactedThinking` - `Data string` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `type BetaToolUseBlockParam` - `Type ToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1, maxLength: 200 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaToolResultBlockParam` - `Type ToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content []BetaToolResultBlockParamContentUnion Optional` - `[]BetaToolResultBlockParamContentUnion` - `type BetaTextBlockParam` - `type BetaImageBlockParam` - `type BetaSearchResultBlockParam` - `type BetaRequestDocumentBlockParam` - `type BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `Type BrowserState` - `Tabs []BetaBrowserStateTabEntryParam` 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`. maxItems: 100 - `TabID string` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Title string` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Active bool Optional` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `StateChanges []BetaBrowserStateChangeUnionParam Optional` Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. minItems: 1, maxItems: 200 - `type BetaBrowserStateChangeTabOpenedParam` 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. - `Type TabOpened` - `TabID string` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadStartedParam` A file download that started during this call. - `Type DownloadStarted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `type BetaBrowserStateChangeDownloadCompletedParam` 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). - `Type DownloadCompleted` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Path string Optional` 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. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `SizeBytes int64 Optional` The completed download's size. minimum: 0 - `type BetaBrowserStateChangeDownloadFailedParam` A file download that failed — or was cancelled — during this call. - `Type DownloadFailed` - `DownloadID string` The caller-assigned identifier for this download, stable across the state changes reporting it. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `URL string` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `Error string Optional` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `IsError bool Optional` - `ToolsetName string Optional` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlockParam` - `Type ServerToolUse` - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockParamName` - `const BetaServerToolUseBlockParamNameAdvisor BetaServerToolUseBlockParamName = "advisor"` - `const BetaServerToolUseBlockParamNameWebSearch BetaServerToolUseBlockParamName = "web_search"` - `const BetaServerToolUseBlockParamNameWebFetch BetaServerToolUseBlockParamName = "web_fetch"` - `const BetaServerToolUseBlockParamNameCodeExecution BetaServerToolUseBlockParamName = "code_execution"` - `const BetaServerToolUseBlockParamNameBashCodeExecution BetaServerToolUseBlockParamName = "bash_code_execution"` - `const BetaServerToolUseBlockParamNameTextEditorCodeExecution BetaServerToolUseBlockParamName = "text_editor_code_execution"` - `const BetaServerToolUseBlockParamNameToolSearchToolRegex BetaServerToolUseBlockParamName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockParamNameToolSearchToolBm25 BetaServerToolUseBlockParamName = "tool_search_tool_bm25"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaServerToolUseBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlockParam` - `Type WebSearchToolResult` - `Content BetaWebSearchToolResultBlockParamContentUnion` - `[]BetaWebSearchResultBlockParam` - `Type WebSearchResult` - `EncryptedContent string` - `Title string` - `URL string` - `PageAge string Optional` - `type BetaWebSearchToolRequestErrorParam` - `Type WebSearchToolResultError` - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaWebSearchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlockParam` - `Type WebFetchToolResult` - `Content BetaWebFetchToolResultBlockParamContentUnion` - `type BetaWebFetchToolResultErrorBlockParam` - `Type WebFetchToolResultError` - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlockParam` - `Type WebFetchResult` - `Content BetaRequestDocumentBlockParam` - `URL string` Fetched content URL - `RetrievedAt string Optional` ISO 8601 timestamp when the content was retrieved - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Caller BetaWebFetchToolResultBlockParamCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlockParam` - `Type AdvisorToolResult` - `Content BetaAdvisorToolResultBlockParamContentUnion` - `type BetaAdvisorToolResultErrorParam` - `Type AdvisorToolResultError` - `ErrorCode BetaAdvisorToolResultErrorParamErrorCode` - `const BetaAdvisorToolResultErrorParamErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorParamErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodePromptTooLong BetaAdvisorToolResultErrorParamErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorParamErrorCodeTooManyRequests BetaAdvisorToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorParamErrorCodeOverloaded BetaAdvisorToolResultErrorParamErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorParamErrorCodeUnavailable BetaAdvisorToolResultErrorParamErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorParamErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorParamErrorCodeModelNotFound BetaAdvisorToolResultErrorParamErrorCode = "model_not_found"` - `type BetaAdvisorResultBlockParam` - `Type AdvisorResult` - `Text string` - `StopReason string Optional` - `type BetaAdvisorRedactedResultBlockParam` - `Type AdvisorRedactedResult` - `EncryptedContent string` Opaque blob produced by a prior response; must be round-tripped verbatim. - `StopReason string Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaCodeExecutionToolResultBlockParam` - `Type CodeExecutionToolResult` - `Content BetaCodeExecutionToolResultBlockParamContentUnion` - `type BetaCodeExecutionToolResultErrorParam` - `Type CodeExecutionToolResultError` - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlockParam` - `Type CodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlockParam` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` - `Content []BetaCodeExecutionOutputBlockParam` - `Type CodeExecutionOutput` - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaBashCodeExecutionToolResultBlockParam` - `Type BashCodeExecutionToolResult` - `Content BetaBashCodeExecutionToolResultBlockParamContentUnion` - `type BetaBashCodeExecutionToolResultErrorParam` - `Type BashCodeExecutionToolResultError` - `ErrorCode BetaBashCodeExecutionToolResultErrorParamErrorCode` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorParamErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorParamErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlockParam` - `Type BashCodeExecutionResult` - `Content []BetaBashCodeExecutionOutputBlockParam` - `Type BashCodeExecutionOutput` - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaTextEditorCodeExecutionToolResultBlockParam` - `Type TextEditorCodeExecutionToolResult` - `Content BetaTextEditorCodeExecutionToolResultBlockParamContentUnion` - `type BetaTextEditorCodeExecutionToolResultErrorParam` - `Type TextEditorCodeExecutionToolResultError` - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorParamErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorParamErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorParamErrorCode = "file_not_found"` - `ErrorMessage string Optional` - `type BetaTextEditorCodeExecutionViewResultBlockParam` - `Type TextEditorCodeExecutionViewResult` - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockParamFileType` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeText BetaTextEditorCodeExecutionViewResultBlockParamFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypeImage BetaTextEditorCodeExecutionViewResultBlockParamFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockParamFileTypePDF BetaTextEditorCodeExecutionViewResultBlockParamFileType = "pdf"` - `NumLines int64 Optional` - `StartLine int64 Optional` - `TotalLines int64 Optional` - `type BetaTextEditorCodeExecutionCreateResultBlockParam` - `Type TextEditorCodeExecutionCreateResult` - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `Type TextEditorCodeExecutionStrReplaceResult` - `Lines []string Optional` - `NewLines int64 Optional` - `NewStart int64 Optional` - `OldLines int64 Optional` - `OldStart int64 Optional` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaToolSearchToolResultBlockParam` - `Type ToolSearchToolResult` - `Content BetaToolSearchToolResultBlockParamContentUnion` - `type BetaToolSearchToolResultErrorParam` - `Type ToolSearchToolResultError` - `ErrorCode BetaToolSearchToolResultErrorParamErrorCode` - `const BetaToolSearchToolResultErrorParamErrorCodeInvalidToolInput BetaToolSearchToolResultErrorParamErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorParamErrorCodeUnavailable BetaToolSearchToolResultErrorParamErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorParamErrorCodeTooManyRequests BetaToolSearchToolResultErrorParamErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorParamErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorParamErrorCode = "execution_time_exceeded"` - `ErrorMessage string Optional` - `type BetaToolSearchToolSearchResultBlockParam` - `Type ToolSearchToolSearchResult` - `ToolReferences []BetaToolReferenceBlockParam` - `Type ToolReference` - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaMCPToolUseBlockParam` - `Type MCPToolUse` - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` - `ServerName string` The name of the MCP server - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestMCPToolResultBlockParam` - `Type MCPToolResult` - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content BetaRequestMCPToolResultBlockParamContentUnion Optional` - `string` - `[]BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `IsError bool Optional` - `type BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `Type ContainerUpload` - `FileID string` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `Type Compaction` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Content string Optional` Summary of previously compacted content, or null if compaction failed - `EncryptedContent string Optional` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` The block's signature as returned, to be sent back verbatim - `ToolChanges []BetaCompactionBlockParamToolChangeUnion Optional` The tool changes of the compacted range, as the server returned them on this block: the `tool_addition` and `tool_removal` entries that take the request's `tools` to the tool set in effect at the end of the range. Send them back unchanged with the block. - `type BetaRequestToolAdditionBlockParam` 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 ToolAddition` - `Tool BetaRequestToolAdditionBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `Type ToolReference` - `Name string` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `Type MCPToolReference` - `Name string` - `ServerName string` - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `Type MCPToolsetReference` - `ServerName string` - `type BetaToolChangeToolDefinitionParam` 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. - `Type ToolDefinition` - `Definition BetaToolUnionParam` - `type BetaToolParam` - `Type BetaToolType Optional` - `InputSchema BetaToolInputSchemaParam` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaToolAllowedCallerDirect BetaToolAllowedCaller = "direct"` - `const BetaToolAllowedCallerCodeExecution20250825 BetaToolAllowedCaller = "code_execution_20250825"` - `const BetaToolAllowedCallerCodeExecution20260120 BetaToolAllowedCaller = "code_execution_20260120"` - `const BetaToolAllowedCallerCodeExecution20260521 BetaToolAllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestToolRemovalBlockParam` 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 ToolRemoval` - `Tool BetaRequestToolRemovalBlockToolUnionParam` - `type BetaToolChangeToolReferenceParam` 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. - `type BetaToolChangeMCPToolReferenceParam` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `type BetaToolChangeMCPToolsetReferenceParam` Reference to every tool in the named MCP server's toolset. - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `type BetaRequestToolAdditionBlockParam` 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` 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 BetaMCPToolListingBlockParam` 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. - `Type MCPToolListing` - `MCPServerName string` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `Tools []BetaMCPToolParam` The server's tools, exactly as the response listed them. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `Type Fallback` - `From BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `Trigger any Optional` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `Role BetaMessageParamRole` - `const BetaMessageParamRoleUser BetaMessageParamRole = "user"` - `const BetaMessageParamRoleAssistant BetaMessageParamRole = "assistant"` - `const BetaMessageParamRoleSystem BetaMessageParamRole = "system"` - `ClearAt BetaMessageParamClearAt Optional` How long this system message's text stays in front of the model. `"never"` (the default) renders it on every request that includes it. `"next_user_message"` renders it only for the user turn it follows: once a later `role: "user"` message exists in `messages` the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on `role: "system"` messages. - `const BetaMessageParamClearAtNextUserMessage BetaMessageParamClearAt = "next_user_message"` - `const BetaMessageParamClearAtNever BetaMessageParamClearAt = "never"` - `OutputConfig BetaSystemMessageOutputConfigParam Optional` 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 Optional` 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`. - `const BetaSystemMessageOutputConfigEffortLow BetaSystemMessageOutputConfigEffort = "low"` - `const BetaSystemMessageOutputConfigEffortMedium BetaSystemMessageOutputConfigEffort = "medium"` - `const BetaSystemMessageOutputConfigEffortHigh BetaSystemMessageOutputConfigEffort = "high"` - `const BetaSystemMessageOutputConfigEffortXhigh BetaSystemMessageOutputConfigEffort = "xhigh"` - `const BetaSystemMessageOutputConfigEffortMax BetaSystemMessageOutputConfigEffort = "max"` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `CacheControl BetaCacheControlEphemeralParam Optional` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `Compaction BetaCompactionConfigParam Optional` Compaction configuration. When set on `POST /v1/messages`, the request is a compaction request: the conversation in `messages` is summarized and the response holds only the resulting `compaction` block (`stop_reason` `"compaction"`), which later requests send first in `messages` in place of the messages it summarizes. `POST /v1/messages/count_tokens` accepts this parameter and ignores it: the count it returns is for the conversation in `messages` as sent. Cannot be combined with `context_management`. - `Type Summarize` - `Instructions string Optional` Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent. maxLength: 16384 - `Container BetaMessageBatchNewParamsRequestParamsContainerUnion Optional` Container identifier for reuse across requests. - `type BetaContainerParams` Container parameters with skills to be loaded. - `ID string Optional` Container id - `Skills []BetaSkillParams Optional` List of skills to load in the container maxItems: 20 - `Type BetaSkillParamsType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaSkillParamsTypeAnthropic BetaSkillParamsType = "anthropic"` - `const BetaSkillParamsTypeCustom BetaSkillParamsType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string Optional` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 - `string` - `ContextManagement BetaContextManagementConfigParam Optional` Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `Edits []BetaContextManagementConfigEditUnionParam Optional` List of context management edits to apply - `type BetaClearToolUses20250919EditParam` - `Type ClearToolUses20250919` - `ClearAtLeast BetaInputTokensClearAtLeastParam Optional` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `Type InputTokens` - `Value int64` minimum: 0 - `ClearToolInputs BetaClearToolUses20250919EditClearToolInputsUnionParam Optional` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `bool` - `[]string` - `ExcludeTools []string Optional` Tool names whose uses are preserved from clearing - `Keep BetaToolUsesKeepParam Optional` Number of tool uses to retain in the conversation - `Type ToolUses` - `Value int64` minimum: 0 - `Trigger BetaClearToolUses20250919EditTriggerUnionParam Optional` Condition that triggers the context management strategy - `type BetaInputTokensTriggerParam` - `Type InputTokens` - `Value int64` minimum: 1 - `type BetaToolUsesTriggerParam` - `Type ToolUses` - `Value int64` minimum: 1 - `type BetaClearThinking20251015EditParam` - `Type ClearThinking20251015` - `Keep BetaClearThinking20251015EditKeepUnionParam Optional` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `type BetaThinkingTurnsParam` - `Type ThinkingTurns` - `Value int64` minimum: 1 - `type BetaAllThinkingTurnsParam` - `Type All` - `All` - `type BetaCompact20260112EditParam` Automatically compact older context when reaching the configured trigger threshold. - `Type Compact20260112` - `Instructions string Optional` Additional instructions for summarization. - `PauseAfterCompaction bool Optional` Whether to pause after compaction and return the compaction block to the user. - `Trigger BetaInputTokensTriggerParam Optional` When to trigger compaction. Defaults to 150000 input tokens. - `Diagnostics BetaDiagnosticsParam Optional` Request-level diagnostics. Supply `previous_message_id` to have the response include `diagnostics.cache_miss_reason` explaining any prompt-cache divergence from that prior request. - `PreviousMessageID string Optional` 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. maxLength: 256 - `FallbackCreditToken BetaMessageBatchNewParamsRequestParamsFallbackCreditTokenUnion Optional` The `fallback_credit_token` from a prior refusal's `stop_details`. When a preceding request was refused and returned a `fallback_credit_token`, pass that code here on the retry to have the retry's cache-creation tokens for the prefix that was warm on the refused model billed at the cache-read rate. Must be redeemed by the same organization and workspace, with the same request body (optionally extended by one appended `assistant` message whose content is the partial text — with any trailing whitespace stripped from the final text block — and paired server-tool blocks streamed before the refusal; the appended-assistant form is not available for requests with `output_format` set or forced `tool_choice`), on an eligible fallback model, on the same platform, and within 5 minutes of the refusal; a mismatch is a 400. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed with the appended-assistant form — if an exact-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry with the appended-assistant form instead. When the appended-assistant form is used on a model that otherwise disallows assistant-turn prefill, this token also authorizes that one prefill. - `string` - `type BetaFallbackCreditTokenParam` Object form of `fallback_credit_token`: the token plus a redemption mode. Requires `anthropic-beta: fallback-credit-2026-07-01`; without that header the field accepts the bare string only. The bare string and the mode-less object are equivalent (both select `strict`), so wrapping an existing token changes nothing by itself. - `Token string` The opaque `fallback_credit_token` from a prior refusal's `stop_details` — the same string the bare-string form carries. minLength: 1, maxLength: 2048 - `Mode BetaFallbackCreditTokenParamMode Optional` 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`. - `const BetaFallbackCreditTokenParamModeStrict BetaFallbackCreditTokenParamMode = "strict"` - `const BetaFallbackCreditTokenParamModeBestEffort BetaFallbackCreditTokenParamMode = "best_effort"` - `Fallbacks BetaFallbacksParamUnion Optional` 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](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=go#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. - `[]BetaFallbackParam` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `MaxTokens int64 Optional` - `OutputConfig BetaOutputConfigParam Optional` - `Effort BetaOutputConfigEffort Optional` 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`. - `const BetaOutputConfigEffortLow BetaOutputConfigEffort = "low"` - `const BetaOutputConfigEffortMedium BetaOutputConfigEffort = "medium"` - `const BetaOutputConfigEffortHigh BetaOutputConfigEffort = "high"` - `const BetaOutputConfigEffortXhigh BetaOutputConfigEffort = "xhigh"` - `const BetaOutputConfigEffortMax BetaOutputConfigEffort = "max"` - `Format BetaJSONOutputFormatParam Optional` A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=go) - `Type JSONSchema` - `Schema map[string, any]` The JSON schema of the format - `TaskBudget BetaTokenTaskBudgetParam Optional` Configuration for token budget tracking across contexts. - `Type Tokens` The budget type. Currently only 'tokens' is supported. - `Total int64` Total token budget across all contexts in the session. minimum: 1024 - `Remaining int64 Optional` Remaining tokens in the budget. Use this to track usage across contexts when implementing compaction client-side. Defaults to total if not provided. minimum: 0 - `Speed BetaFallbackParamSpeed Optional` Inference speed mode. `fast` provides significantly faster output token generation at premium pricing. Not all models support `fast`; invalid combinations are rejected at create time. - `const BetaFallbackParamSpeedStandard BetaFallbackParamSpeed = "standard"` - `const BetaFallbackParamSpeedFast BetaFallbackParamSpeed = "fast"` - `Thinking BetaFallbackParamThinkingUnion Optional` - `type BetaThinkingConfigEnabledParam` - `Type Enabled` - `BudgetTokens int64` 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](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. minimum: 1024 - `BlockBinding BetaThinkingBlockBindingParam Optional` 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`. - `const BetaThinkingPrefixMismatchBehaviorError BetaThinkingPrefixMismatchBehavior = "error"` - `const BetaThinkingPrefixMismatchBehaviorDropBlock BetaThinkingPrefixMismatchBehavior = "drop_block"` - `Display BetaThinkingConfigEnabledDisplay Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#controlling-thinking-display). - `const BetaThinkingConfigEnabledDisplaySummarized BetaThinkingConfigEnabledDisplay = "summarized"` - `const BetaThinkingConfigEnabledDisplayOmitted BetaThinkingConfigEnabledDisplay = "omitted"` - `const BetaThinkingConfigEnabledDisplayUpdates BetaThinkingConfigEnabledDisplay = "updates"` - `type BetaThinkingConfigDisabledParam` - `Type Disabled` - `type BetaThinkingConfigBetweenToolsParam` - `Type BetweenTools` - `type BetaThinkingConfigAdaptiveParam` - `Type Adaptive` - `BlockBinding BetaThinkingBlockBindingParam Optional` 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. - `Display BetaThinkingConfigAdaptiveDisplay Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#controlling-thinking-display). - `const BetaThinkingConfigAdaptiveDisplaySummarized BetaThinkingConfigAdaptiveDisplay = "summarized"` - `const BetaThinkingConfigAdaptiveDisplayOmitted BetaThinkingConfigAdaptiveDisplay = "omitted"` - `const BetaThinkingConfigAdaptiveDisplayUpdates BetaThinkingConfigAdaptiveDisplay = "updates"` - `Default` - `InferenceGeo string Optional` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `MCPServers []BetaRequestMCPServerURLDefinitionParam Optional` MCP servers to be utilized in this request maxItems: 20 - `Type URL` - `Name string` - `URL string` - `AuthorizationToken string Optional` - `ToolConfiguration BetaRequestMCPServerToolConfigurationParam Optional` - `AllowedTools []string Optional` - `Enabled bool Optional` - `Metadata BetaMetadataParam Optional` An object describing metadata about the request. - `UserID string Optional` 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. maxLength: 512 - `OutputConfig BetaOutputConfigParam Optional` Configuration options for the model's output, such as the output format. - `ServiceTier string Optional` Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers?sdk_languages=go) for details. - `const BetaMessageBatchNewParamsRequestParamsServiceTierAuto BetaMessageBatchNewParamsRequestParamsServiceTier = "auto"` - `const BetaMessageBatchNewParamsRequestParamsServiceTierStandardOnly BetaMessageBatchNewParamsRequestParamsServiceTier = "standard_only"` - `Speed string Optional` The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. Some models require the `fast-mode-2026-02-01` beta header for any `speed` value. See [fast mode](https://platform.claude.com/docs/en/build-with-claude/fast-mode?sdk_languages=go) for which models. - `const BetaMessageBatchNewParamsRequestParamsSpeedStandard BetaMessageBatchNewParamsRequestParamsSpeed = "standard"` - `const BetaMessageBatchNewParamsRequestParamsSpeedFast BetaMessageBatchNewParamsRequestParamsSpeed = "fast"` - `StopSequences []string Optional` Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. - `Stream bool Optional` Whether to incrementally stream the response using server-sent events. When `true`, SDKs return a raw event stream. In the TypeScript, Python and Ruby SDKs, the recommended way to stream is `messages.stream()`. It sets `stream` for you and accumulates the events into the final message. See [Streaming with SDKs](https://platform.claude.com/docs/en/build-with-claude/streaming?sdk_languages=go#streaming-with-sdks) for an example in each language. - `System []BetaTextBlockParam Optional` System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices?sdk_languages=go#give-claude-a-role). - `[]BetaTextBlockParam` - `Type Text` - `Text string` minLength: 1 - `CacheControl BetaCacheControlEphemeralParam Optional` Create a cache control breakpoint at this content block. - `Citations []BetaTextCitationParamUnion Optional` - `Thinking BetaThinkingConfigParamUnion Optional` 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](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=go#configuring-thinking) for each model's behavior. - `type BetaThinkingConfigEnabledParam` - `type BetaThinkingConfigDisabledParam` - `type BetaThinkingConfigBetweenToolsParam` - `type BetaThinkingConfigAdaptiveParam` - `ToolChoice BetaToolChoiceUnionParam Optional` 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 BetaToolChoiceAutoParam` The model will automatically decide whether to use tools. - `Type Auto` - `DisableParallelToolUse bool Optional` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `type BetaToolChoiceAnyParam` The model will use any available tools. - `Type Any` - `DisableParallelToolUse bool Optional` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `type BetaToolChoiceToolParam` The model will use the specified tool with `tool_choice.name`. - `Type Tool` - `Name string` The name of the tool to use. - `DisableParallelToolUse bool Optional` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `type BetaToolChoiceNoneParam` The model will not be allowed to use tools. - `Type None` - `Tools []BetaToolUnionParam Optional` Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools?sdk_languages=go), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool?sdk_languages=go)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview?sdk_languages=go) for more details. - `type BetaToolParam` - `type BetaToolBash20241022` - `type BetaToolBash20250124` - `type BetaCodeExecutionTool20250522` - `type BetaCodeExecutionTool20250825` - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `type BetaToolComputerUse20241022` - `type BetaMemoryTool20250818` - `type BetaToolComputerUse20250124` - `type BetaToolTextEditor20241022` - `type BetaToolComputerUse20251124` - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `type BetaToolTextEditor20250124` - `type BetaToolTextEditor20250429` - `type BetaToolTextEditor20250728` - `type BetaWebSearchTool20250305` - `type BetaWebFetchTool20250910` - `type BetaWebSearchTool20260209` - `type BetaWebFetchTool20260209` - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `type BetaWebSearchTool20260318` - `type BetaWebFetchTool20260318` - `type BetaAdvisorTool20260301` - `type BetaToolSearchToolBm25_20251119` - `type BetaToolSearchToolRegex20251119` - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `OutputFormat BetaJSONOutputFormatParam Optional` **Deprecated** Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=go) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `Temperature float64 Optional` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Amount of randomness injected into the response. Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic. minimum: 0, maximum: 1 - `TopK int64 Optional` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error. Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. minimum: 0 - `TopP float64 Optional` **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. minimum: 0, maximum: 1 - `Betas []AnthropicBeta Optional` (header parameter) Optional header to specify the beta version(s) you want to use. - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` - `const AnthropicBetaUserProfiles2026_09_04 AnthropicBeta = "user-profiles-2026-09-04"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` - `const AnthropicBetaMidConversationOutputConfig2026_07_01 AnthropicBeta = "mid-conversation-output-config-2026-07-01"` - `const AnthropicBetaThinkingBindingControls2026_08_01 AnthropicBeta = "thinking-binding-controls-2026-08-01"` - `const AnthropicBetaMidConversationSystemClearAt2026_08_21 AnthropicBeta = "mid-conversation-system-clear-at-2026-08-21"` - `const AnthropicBetaCompact2026_09_04 AnthropicBeta = "compact-2026-09-04"` - `const AnthropicBetaInlineTools2026_09_15 AnthropicBeta = "inline-tools-2026-09-15"` - `const AnthropicBetaMCPClient2026_09_15 AnthropicBeta = "mcp-client-2026-09-15"` - `const AnthropicBetaCEPlugins2026_09_01 AnthropicBeta = "ce-plugins-2026-09-01"` - `const AnthropicBetaSpendLimitReads2026_09_26 AnthropicBeta = "spend-limit-reads-2026-09-26"` - `const AnthropicBetaTelemetryDestinations2026_08_11 AnthropicBeta = "telemetry-destinations-2026-08-11"` - `UserProfileID param.Opt[string] Optional` (header parameter) The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. - `WorkspaceID param.Opt[string] Optional` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `type BetaMessageBatch` - `Type MessageBatch` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `ID string` Unique object identifier. The format and length of IDs may change over time. - `ArchivedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `CancelInitiatedAt Time` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `CreatedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `EndedAt Time` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `ExpiresAt Time` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `ProcessingStatus BetaMessageBatchProcessingStatus` Processing status of the Message Batch. - `const BetaMessageBatchProcessingStatusInProgress BetaMessageBatchProcessingStatus = "in_progress"` - `const BetaMessageBatchProcessingStatusCanceling BetaMessageBatchProcessingStatus = "canceling"` - `const BetaMessageBatchProcessingStatusEnded BetaMessageBatchProcessingStatus = "ended"` - `RequestCounts BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `Canceled int64` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `Errored int64` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `Expired int64` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `Processing int64` Number of requests in the Message Batch that are processing. default: 0 - `Succeeded int64` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `ResultsURL string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaMessageBatch, err := client.Beta.Messages.Batches.New(context.TODO(), anthropic.BetaMessageBatchNewParams{ Requests: []anthropic.BetaMessageBatchNewParamsRequest{anthropic.BetaMessageBatchNewParamsRequest{ CustomID: "my-custom-id-1", Params: anthropic.BetaMessageBatchNewParamsRequestParams{ MaxTokens: 1024, Messages: []anthropic.BetaMessageParam{anthropic.BetaMessageParam{ Content: []anthropic.BetaContentBlockParamUnion{anthropic.BetaContentBlockParamUnion{ OfText: &anthropic.BetaTextBlockParam{ Text: "x", }, }}, Role: anthropic.BetaMessageParamRoleUser, }}, Model: anthropic.ModelClaudeOpus5_5, }, }}, }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaMessageBatch.ID) } ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ### Retrieve a Message Batch `client.Beta.Messages.Batches.Get(ctx, messageBatchID, query) (*BetaMessageBatch, error)` **GET** `/v1/messages/batches/{message_batch_id}` This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the `results_url` field in the response. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=go) #### Parameters - `messageBatchID string` (path parameter) ID of the Message Batch. - `query BetaMessageBatchGetParams` - `Betas []AnthropicBeta Optional` (header parameter) Optional header to specify the beta version(s) you want to use. - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` - `const AnthropicBetaUserProfiles2026_09_04 AnthropicBeta = "user-profiles-2026-09-04"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` - `const AnthropicBetaMidConversationOutputConfig2026_07_01 AnthropicBeta = "mid-conversation-output-config-2026-07-01"` - `const AnthropicBetaThinkingBindingControls2026_08_01 AnthropicBeta = "thinking-binding-controls-2026-08-01"` - `const AnthropicBetaMidConversationSystemClearAt2026_08_21 AnthropicBeta = "mid-conversation-system-clear-at-2026-08-21"` - `const AnthropicBetaCompact2026_09_04 AnthropicBeta = "compact-2026-09-04"` - `const AnthropicBetaInlineTools2026_09_15 AnthropicBeta = "inline-tools-2026-09-15"` - `const AnthropicBetaMCPClient2026_09_15 AnthropicBeta = "mcp-client-2026-09-15"` - `const AnthropicBetaCEPlugins2026_09_01 AnthropicBeta = "ce-plugins-2026-09-01"` - `const AnthropicBetaSpendLimitReads2026_09_26 AnthropicBeta = "spend-limit-reads-2026-09-26"` - `const AnthropicBetaTelemetryDestinations2026_08_11 AnthropicBeta = "telemetry-destinations-2026-08-11"` - `WorkspaceID param.Opt[string] Optional` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `type BetaMessageBatch` - `Type MessageBatch` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `ID string` Unique object identifier. The format and length of IDs may change over time. - `ArchivedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `CancelInitiatedAt Time` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `CreatedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `EndedAt Time` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `ExpiresAt Time` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `ProcessingStatus BetaMessageBatchProcessingStatus` Processing status of the Message Batch. - `const BetaMessageBatchProcessingStatusInProgress BetaMessageBatchProcessingStatus = "in_progress"` - `const BetaMessageBatchProcessingStatusCanceling BetaMessageBatchProcessingStatus = "canceling"` - `const BetaMessageBatchProcessingStatusEnded BetaMessageBatchProcessingStatus = "ended"` - `RequestCounts BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `Canceled int64` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `Errored int64` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `Expired int64` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `Processing int64` Number of requests in the Message Batch that are processing. default: 0 - `Succeeded int64` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `ResultsURL string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaMessageBatch, err := client.Beta.Messages.Batches.Get( context.TODO(), "message_batch_id", anthropic.BetaMessageBatchGetParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaMessageBatch.ID) } ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ### List Message Batches `client.Beta.Messages.Batches.List(ctx, params) (*Page[BetaMessageBatch], error)` **GET** `/v1/messages/batches` List all Message Batches within a Workspace. Most recently created batches are returned first. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=go) #### Parameters - `params BetaMessageBatchListParams` - `AfterID param.Opt[string] Optional` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `BeforeID param.Opt[string] Optional` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `Limit param.Opt[int64] Optional` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. minimum: 1, maximum: 1000 - `Betas []AnthropicBeta Optional` (header parameter) Optional header to specify the beta version(s) you want to use. - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` - `const AnthropicBetaUserProfiles2026_09_04 AnthropicBeta = "user-profiles-2026-09-04"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` - `const AnthropicBetaMidConversationOutputConfig2026_07_01 AnthropicBeta = "mid-conversation-output-config-2026-07-01"` - `const AnthropicBetaThinkingBindingControls2026_08_01 AnthropicBeta = "thinking-binding-controls-2026-08-01"` - `const AnthropicBetaMidConversationSystemClearAt2026_08_21 AnthropicBeta = "mid-conversation-system-clear-at-2026-08-21"` - `const AnthropicBetaCompact2026_09_04 AnthropicBeta = "compact-2026-09-04"` - `const AnthropicBetaInlineTools2026_09_15 AnthropicBeta = "inline-tools-2026-09-15"` - `const AnthropicBetaMCPClient2026_09_15 AnthropicBeta = "mcp-client-2026-09-15"` - `const AnthropicBetaCEPlugins2026_09_01 AnthropicBeta = "ce-plugins-2026-09-01"` - `const AnthropicBetaSpendLimitReads2026_09_26 AnthropicBeta = "spend-limit-reads-2026-09-26"` - `const AnthropicBetaTelemetryDestinations2026_08_11 AnthropicBeta = "telemetry-destinations-2026-08-11"` - `WorkspaceID param.Opt[string] Optional` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `type BetaMessageBatch` - `Type MessageBatch` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `ID string` Unique object identifier. The format and length of IDs may change over time. - `ArchivedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `CancelInitiatedAt Time` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `CreatedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `EndedAt Time` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `ExpiresAt Time` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `ProcessingStatus BetaMessageBatchProcessingStatus` Processing status of the Message Batch. - `const BetaMessageBatchProcessingStatusInProgress BetaMessageBatchProcessingStatus = "in_progress"` - `const BetaMessageBatchProcessingStatusCanceling BetaMessageBatchProcessingStatus = "canceling"` - `const BetaMessageBatchProcessingStatusEnded BetaMessageBatchProcessingStatus = "ended"` - `RequestCounts BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `Canceled int64` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `Errored int64` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `Expired int64` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `Processing int64` Number of requests in the Message Batch that are processing. default: 0 - `Succeeded int64` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `ResultsURL string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) page, err := client.Beta.Messages.Batches.List(context.TODO(), anthropic.BetaMessageBatchListParams{}) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` ##### Response (200) ```json { "data": [ { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ], "first_id": "first_id", "has_more": true, "last_id": "last_id" } ``` ### Cancel a Message Batch `client.Beta.Messages.Batches.Cancel(ctx, messageBatchID, body) (*BetaMessageBatch, error)` **POST** `/v1/messages/batches/{message_batch_id}/cancel` Batches may be canceled any time before processing ends. Once cancellation is initiated, the batch enters a `canceling` state, at which time the system may complete any in-progress, non-interruptible requests before finalizing cancellation. The number of canceled requests is specified in `request_counts`. To determine which requests were canceled, check the individual results within the batch. Note that cancellation may not result in any canceled requests if they were non-interruptible. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=go) #### Parameters - `messageBatchID string` (path parameter) ID of the Message Batch. - `body BetaMessageBatchCancelParams` - `Betas []AnthropicBeta Optional` (header parameter) Optional header to specify the beta version(s) you want to use. - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` - `const AnthropicBetaUserProfiles2026_09_04 AnthropicBeta = "user-profiles-2026-09-04"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` - `const AnthropicBetaMidConversationOutputConfig2026_07_01 AnthropicBeta = "mid-conversation-output-config-2026-07-01"` - `const AnthropicBetaThinkingBindingControls2026_08_01 AnthropicBeta = "thinking-binding-controls-2026-08-01"` - `const AnthropicBetaMidConversationSystemClearAt2026_08_21 AnthropicBeta = "mid-conversation-system-clear-at-2026-08-21"` - `const AnthropicBetaCompact2026_09_04 AnthropicBeta = "compact-2026-09-04"` - `const AnthropicBetaInlineTools2026_09_15 AnthropicBeta = "inline-tools-2026-09-15"` - `const AnthropicBetaMCPClient2026_09_15 AnthropicBeta = "mcp-client-2026-09-15"` - `const AnthropicBetaCEPlugins2026_09_01 AnthropicBeta = "ce-plugins-2026-09-01"` - `const AnthropicBetaSpendLimitReads2026_09_26 AnthropicBeta = "spend-limit-reads-2026-09-26"` - `const AnthropicBetaTelemetryDestinations2026_08_11 AnthropicBeta = "telemetry-destinations-2026-08-11"` - `WorkspaceID param.Opt[string] Optional` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `type BetaMessageBatch` - `Type MessageBatch` Object type. For Message Batches, this is always `"message_batch"`. default: message_batch - `ID string` Unique object identifier. The format and length of IDs may change over time. - `ArchivedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `CancelInitiatedAt Time` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. format: date-time - `CreatedAt Time` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `EndedAt Time` RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. format: date-time - `ExpiresAt Time` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. format: date-time - `ProcessingStatus BetaMessageBatchProcessingStatus` Processing status of the Message Batch. - `const BetaMessageBatchProcessingStatusInProgress BetaMessageBatchProcessingStatus = "in_progress"` - `const BetaMessageBatchProcessingStatusCanceling BetaMessageBatchProcessingStatus = "canceling"` - `const BetaMessageBatchProcessingStatusEnded BetaMessageBatchProcessingStatus = "ended"` - `RequestCounts BetaMessageBatchRequestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `Canceled int64` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. default: 0 - `Errored int64` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. default: 0 - `Expired int64` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. default: 0 - `Processing int64` Number of requests in the Message Batch that are processing. default: 0 - `Succeeded int64` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. default: 0 - `ResultsURL string` URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. #### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaMessageBatch, err := client.Beta.Messages.Batches.Cancel( context.TODO(), "message_batch_id", anthropic.BetaMessageBatchCancelParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaMessageBatch.ID) } ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ``` ### Delete a Message Batch `client.Beta.Messages.Batches.Delete(ctx, messageBatchID, body) (*BetaDeletedMessageBatch, error)` **DELETE** `/v1/messages/batches/{message_batch_id}` Delete a Message Batch. Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=go) #### Parameters - `messageBatchID string` (path parameter) ID of the Message Batch. - `body BetaMessageBatchDeleteParams` - `Betas []AnthropicBeta Optional` (header parameter) Optional header to specify the beta version(s) you want to use. - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` - `const AnthropicBetaUserProfiles2026_09_04 AnthropicBeta = "user-profiles-2026-09-04"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` - `const AnthropicBetaMidConversationOutputConfig2026_07_01 AnthropicBeta = "mid-conversation-output-config-2026-07-01"` - `const AnthropicBetaThinkingBindingControls2026_08_01 AnthropicBeta = "thinking-binding-controls-2026-08-01"` - `const AnthropicBetaMidConversationSystemClearAt2026_08_21 AnthropicBeta = "mid-conversation-system-clear-at-2026-08-21"` - `const AnthropicBetaCompact2026_09_04 AnthropicBeta = "compact-2026-09-04"` - `const AnthropicBetaInlineTools2026_09_15 AnthropicBeta = "inline-tools-2026-09-15"` - `const AnthropicBetaMCPClient2026_09_15 AnthropicBeta = "mcp-client-2026-09-15"` - `const AnthropicBetaCEPlugins2026_09_01 AnthropicBeta = "ce-plugins-2026-09-01"` - `const AnthropicBetaSpendLimitReads2026_09_26 AnthropicBeta = "spend-limit-reads-2026-09-26"` - `const AnthropicBetaTelemetryDestinations2026_08_11 AnthropicBeta = "telemetry-destinations-2026-08-11"` - `WorkspaceID param.Opt[string] Optional` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `type BetaDeletedMessageBatch` - `Type MessageBatchDeleted` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`. default: message_batch_deleted - `ID string` ID of the Message Batch. #### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) betaDeletedMessageBatch, err := client.Beta.Messages.Batches.Delete( context.TODO(), "message_batch_id", anthropic.BetaMessageBatchDeleteParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", betaDeletedMessageBatch.ID) } ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "type": "message_batch_deleted" } ``` ### Retrieve Message Batch results `client.Beta.Messages.Batches.ResultsStreaming(ctx, messageBatchID, query) *jsonl.Stream[BetaMessageBatchIndividualResponse]` **GET** `/v1/messages/batches/{message_batch_id}/results` Streams the results of a Message Batch as a `.jsonl` file. Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing?sdk_languages=go) #### Parameters - `messageBatchID string` (path parameter) ID of the Message Batch. - `query BetaMessageBatchResultsParams` - `Betas []AnthropicBeta Optional` (header parameter) Optional header to specify the beta version(s) you want to use. - `const AnthropicBetaMessageBatches2024_09_24 AnthropicBeta = "message-batches-2024-09-24"` - `const AnthropicBetaPromptCaching2024_07_31 AnthropicBeta = "prompt-caching-2024-07-31"` - `const AnthropicBetaComputerUse2024_10_22 AnthropicBeta = "computer-use-2024-10-22"` - `const AnthropicBetaComputerUse2025_01_24 AnthropicBeta = "computer-use-2025-01-24"` - `const AnthropicBetaPDFs2024_09_25 AnthropicBeta = "pdfs-2024-09-25"` - `const AnthropicBetaTokenCounting2024_11_01 AnthropicBeta = "token-counting-2024-11-01"` - `const AnthropicBetaTokenEfficientTools2025_02_19 AnthropicBeta = "token-efficient-tools-2025-02-19"` - `const AnthropicBetaOutput128k2025_02_19 AnthropicBeta = "output-128k-2025-02-19"` - `const AnthropicBetaFilesAPI2025_04_14 AnthropicBeta = "files-api-2025-04-14"` - `const AnthropicBetaMCPClient2025_04_04 AnthropicBeta = "mcp-client-2025-04-04"` - `const AnthropicBetaMCPClient2025_11_20 AnthropicBeta = "mcp-client-2025-11-20"` - `const AnthropicBetaDevFullThinking2025_05_14 AnthropicBeta = "dev-full-thinking-2025-05-14"` - `const AnthropicBetaInterleavedThinking2025_05_14 AnthropicBeta = "interleaved-thinking-2025-05-14"` - `const AnthropicBetaCodeExecution2025_05_22 AnthropicBeta = "code-execution-2025-05-22"` - `const AnthropicBetaExtendedCacheTTL2025_04_11 AnthropicBeta = "extended-cache-ttl-2025-04-11"` - `const AnthropicBetaContext1m2025_08_07 AnthropicBeta = "context-1m-2025-08-07"` - `const AnthropicBetaContextManagement2025_06_27 AnthropicBeta = "context-management-2025-06-27"` - `const AnthropicBetaModelContextWindowExceeded2025_08_26 AnthropicBeta = "model-context-window-exceeded-2025-08-26"` - `const AnthropicBetaSkills2025_10_02 AnthropicBeta = "skills-2025-10-02"` - `const AnthropicBetaFastMode2026_02_01 AnthropicBeta = "fast-mode-2026-02-01"` - `const AnthropicBetaOutput300k2026_03_24 AnthropicBeta = "output-300k-2026-03-24"` - `const AnthropicBetaUserProfiles2026_03_24 AnthropicBeta = "user-profiles-2026-03-24"` - `const AnthropicBetaUserProfiles2026_08_18 AnthropicBeta = "user-profiles-2026-08-18"` - `const AnthropicBetaUserProfiles2026_09_04 AnthropicBeta = "user-profiles-2026-09-04"` - `const AnthropicBetaAdvisorTool2026_03_01 AnthropicBeta = "advisor-tool-2026-03-01"` - `const AnthropicBetaManagedAgents2026_04_01 AnthropicBeta = "managed-agents-2026-04-01"` - `const AnthropicBetaCacheDiagnosis2026_04_07 AnthropicBeta = "cache-diagnosis-2026-04-07"` - `const AnthropicBetaDreaming2026_04_21 AnthropicBeta = "dreaming-2026-04-21"` - `const AnthropicBetaThinkingTokenCount2026_05_13 AnthropicBeta = "thinking-token-count-2026-05-13"` - `const AnthropicBetaServerSideFallback2026_06_01 AnthropicBeta = "server-side-fallback-2026-06-01"` - `const AnthropicBetaServerSideFallback2026_07_01 AnthropicBeta = "server-side-fallback-2026-07-01"` - `const AnthropicBetaFallbackCredit2026_06_01 AnthropicBeta = "fallback-credit-2026-06-01"` - `const AnthropicBetaFallbackCredit2026_07_01 AnthropicBeta = "fallback-credit-2026-07-01"` - `const AnthropicBetaAgentMemory2026_07_22 AnthropicBeta = "agent-memory-2026-07-22"` - `const AnthropicBetaMidConversationToolChanges2026_07_01 AnthropicBeta = "mid-conversation-tool-changes-2026-07-01"` - `const AnthropicBetaCompact2026_01_12 AnthropicBeta = "compact-2026-01-12"` - `const AnthropicBetaComputerUse2025_11_24 AnthropicBeta = "computer-use-2025-11-24"` - `const AnthropicBetaMCPTunnels2026_06_22 AnthropicBeta = "mcp-tunnels-2026-06-22"` - `const AnthropicBetaStructuredOutputs2025_11_13 AnthropicBeta = "structured-outputs-2025-11-13"` - `const AnthropicBetaTaskBudgets2026_03_13 AnthropicBeta = "task-budgets-2026-03-13"` - `const AnthropicBetaThinkingDisplayUpdates2026_08_18 AnthropicBeta = "thinking-display-updates-2026-08-18"` - `const AnthropicBetaCEUserManagement2026_07_13 AnthropicBeta = "ce-user-management-2026-07-13"` - `const AnthropicBetaMidConversationOutputConfig2026_07_01 AnthropicBeta = "mid-conversation-output-config-2026-07-01"` - `const AnthropicBetaThinkingBindingControls2026_08_01 AnthropicBeta = "thinking-binding-controls-2026-08-01"` - `const AnthropicBetaMidConversationSystemClearAt2026_08_21 AnthropicBeta = "mid-conversation-system-clear-at-2026-08-21"` - `const AnthropicBetaCompact2026_09_04 AnthropicBeta = "compact-2026-09-04"` - `const AnthropicBetaInlineTools2026_09_15 AnthropicBeta = "inline-tools-2026-09-15"` - `const AnthropicBetaMCPClient2026_09_15 AnthropicBeta = "mcp-client-2026-09-15"` - `const AnthropicBetaCEPlugins2026_09_01 AnthropicBeta = "ce-plugins-2026-09-01"` - `const AnthropicBetaSpendLimitReads2026_09_26 AnthropicBeta = "spend-limit-reads-2026-09-26"` - `const AnthropicBetaTelemetryDestinations2026_08_11 AnthropicBeta = "telemetry-destinations-2026-08-11"` - `WorkspaceID param.Opt[string] Optional` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `type BetaMessageBatchIndividualResponse` This is a single line in the response `.jsonl` file and does not represent the response as a whole. - `CustomID string` Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. - `Result BetaMessageBatchResultUnion` Processing result for this request. Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration. - `type BetaMessageBatchSucceededResult` - `Type Succeeded` default: succeeded - `Message BetaMessage` - `Type Message` Object type. For Messages, this is always `"message"`. default: message - `ID string` Unique object identifier. The format and length of IDs may change over time. - `Container BetaContainer` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `ID string` Identifier for the container used in this request - `ExpiresAt Time` The time at which the container will expire. format: date-time - `Skills []BetaContainerSkill` Skills loaded in the container - `Type BetaContainerSkillType` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `const BetaContainerSkillTypeAnthropic BetaContainerSkillType = "anthropic"` - `const BetaContainerSkillTypeCustom BetaContainerSkillType = "custom"` - `SkillID string` Skill ID minLength: 1, maxLength: 64 - `Version string` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `Content []BetaContentBlockUnion` Content generated by the model. This is an array of content blocks, each of which has a `type` that determines its shape. Example: ```json [{"type": "text", "text": "Hi, I'm Claude."}] ``` If the request input `messages` ended with an `assistant` turn, then the response `content` will continue directly from that last turn. You can use this to constrain the model's output. For example, if the input `messages` were: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("} ] ``` Then the response `content` might be: ```json [{"type": "text", "text": "B)"}] ``` - `type BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `type BetaCitationCharLocation` - `Type CharLocation` default: char_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndCharIndex int64` - `FileID string` - `StartCharIndex int64` minimum: 0 - `type BetaCitationPageLocation` - `Type PageLocation` default: page_location - `CitedText string` - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndPageNumber int64` - `FileID string` - `StartPageNumber int64` minimum: 1 - `type BetaCitationContentBlockLocation` - `Type ContentBlockLocation` default: content_block_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `DocumentIndex int64` minimum: 0 - `DocumentTitle string` - `EndBlockIndex int64` 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`. - `FileID string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `type BetaCitationsWebSearchResultLocation` - `Type WebSearchResultLocation` default: web_search_result_location - `CitedText string` - `EncryptedIndex string` - `Title string` maxLength: 512 - `URL string` - `type BetaCitationSearchResultLocation` - `Type SearchResultLocation` default: search_result_location - `CitedText string` The full text of the cited block range, concatenated. Always equals the contents of `content[start_block_index:end_block_index]` joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns. - `EndBlockIndex int64` 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 int64` 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. minimum: 0 - `Source string` - `StartBlockIndex int64` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `Title string` - `Text string` - `type BetaThinkingBlock` - `Type Thinking` default: thinking - `Signature string` A value used to verify that this thinking block was generated by Claude when it is passed back to the API. This is an opaque field and should not be interpreted or parsed. When passing thinking blocks back to the API (required when using tools with extended thinking), pass them back exactly as received, with this field intact. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go) for details. - `Thinking string` The text of Claude's thinking process for this block. - `type BetaRedactedThinkingBlock` - `Type RedactedThinking` default: redacted_thinking - `Data string` The contents of this redacted thinking block, returned when portions of the model's thinking were safety-redacted. This field is opaque and encrypted, with no readable content. Pass `redacted_thinking` blocks back to the API unchanged when continuing a multi-turn conversation. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking?sdk_languages=go#redacted-thinking-blocks) for details. - `type BetaToolUseBlock` - `Type ToolUse` default: tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` minLength: 1 - `Caller BetaToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `Type Direct` - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `Type CodeExecution20250825` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaServerToolCaller20260120` - `Type CodeExecution20260120` - `ToolID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `ToolsetName string Optional` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `type BetaServerToolUseBlock` - `Type ServerToolUse` default: server_tool_use - `ID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Input map[string, any]` - `Name BetaServerToolUseBlockName` - `const BetaServerToolUseBlockNameAdvisor BetaServerToolUseBlockName = "advisor"` - `const BetaServerToolUseBlockNameWebSearch BetaServerToolUseBlockName = "web_search"` - `const BetaServerToolUseBlockNameWebFetch BetaServerToolUseBlockName = "web_fetch"` - `const BetaServerToolUseBlockNameCodeExecution BetaServerToolUseBlockName = "code_execution"` - `const BetaServerToolUseBlockNameBashCodeExecution BetaServerToolUseBlockName = "bash_code_execution"` - `const BetaServerToolUseBlockNameTextEditorCodeExecution BetaServerToolUseBlockName = "text_editor_code_execution"` - `const BetaServerToolUseBlockNameToolSearchToolRegex BetaServerToolUseBlockName = "tool_search_tool_regex"` - `const BetaServerToolUseBlockNameToolSearchToolBm25 BetaServerToolUseBlockName = "tool_search_tool_bm25"` - `Caller BetaServerToolUseBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebSearchToolResultBlock` - `Type WebSearchToolResult` default: web_search_tool_result - `Content BetaWebSearchToolResultBlockContentUnion` - `type BetaWebSearchToolResultError` - `Type WebSearchToolResultError` default: web_search_tool_result_error - `ErrorCode BetaWebSearchToolResultErrorCode` - `const BetaWebSearchToolResultErrorCodeInvalidToolInput BetaWebSearchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebSearchToolResultErrorCodeUnavailable BetaWebSearchToolResultErrorCode = "unavailable"` - `const BetaWebSearchToolResultErrorCodeMaxUsesExceeded BetaWebSearchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebSearchToolResultErrorCodeTooManyRequests BetaWebSearchToolResultErrorCode = "too_many_requests"` - `const BetaWebSearchToolResultErrorCodeQueryTooLong BetaWebSearchToolResultErrorCode = "query_too_long"` - `const BetaWebSearchToolResultErrorCodeRequestTooLarge BetaWebSearchToolResultErrorCode = "request_too_large"` - `[]BetaWebSearchResultBlock` - `Type WebSearchResult` default: web_search_result - `EncryptedContent string` - `PageAge string` - `Title string` - `URL string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebSearchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaWebFetchToolResultBlock` - `Type WebFetchToolResult` default: web_fetch_tool_result - `Content BetaWebFetchToolResultBlockContentUnion` - `type BetaWebFetchToolResultErrorBlock` - `Type WebFetchToolResultError` default: web_fetch_tool_result_error - `ErrorCode BetaWebFetchToolResultErrorCode` - `const BetaWebFetchToolResultErrorCodeInvalidToolInput BetaWebFetchToolResultErrorCode = "invalid_tool_input"` - `const BetaWebFetchToolResultErrorCodeURLTooLong BetaWebFetchToolResultErrorCode = "url_too_long"` - `const BetaWebFetchToolResultErrorCodeURLNotAllowed BetaWebFetchToolResultErrorCode = "url_not_allowed"` - `const BetaWebFetchToolResultErrorCodeURLNotInPriorContext BetaWebFetchToolResultErrorCode = "url_not_in_prior_context"` - `const BetaWebFetchToolResultErrorCodeURLNotAccessible BetaWebFetchToolResultErrorCode = "url_not_accessible"` - `const BetaWebFetchToolResultErrorCodeUnsupportedContentType BetaWebFetchToolResultErrorCode = "unsupported_content_type"` - `const BetaWebFetchToolResultErrorCodeTooManyRequests BetaWebFetchToolResultErrorCode = "too_many_requests"` - `const BetaWebFetchToolResultErrorCodeMaxUsesExceeded BetaWebFetchToolResultErrorCode = "max_uses_exceeded"` - `const BetaWebFetchToolResultErrorCodeUnavailable BetaWebFetchToolResultErrorCode = "unavailable"` - `const BetaWebFetchToolResultErrorCodeContentTooLarge BetaWebFetchToolResultErrorCode = "content_too_large"` - `type BetaWebFetchBlock` - `Type WebFetchResult` default: web_fetch_result - `Content BetaDocumentBlock` - `Type Document` default: document - `Citations BetaCitationConfig` Citation configuration for the document - `Enabled bool` default: false - `Source BetaDocumentBlockSourceUnion` - `type BetaBase64PDFSource` - `Type Base64` - `Data string` format: byte - `MediaType ApplicationPDF` - `type BetaPlainTextSource` - `Type Text` - `Data string` - `MediaType TextPlain` - `Title string` The title of the document - `RetrievedAt string` ISO 8601 timestamp when the content was retrieved - `URL string` Fetched content URL - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller BetaWebFetchToolResultBlockCallerUnion Optional` - `type BetaDirectCaller` Tool invocation directly from the model. - `type BetaServerToolCaller` Tool invocation generated by a server-side tool. - `type BetaServerToolCaller20260120` - `type BetaAdvisorToolResultBlock` - `Type AdvisorToolResult` default: advisor_tool_result - `Content BetaAdvisorToolResultBlockContentUnion` - `type BetaAdvisorToolResultError` - `Type AdvisorToolResultError` default: advisor_tool_result_error - `ErrorCode BetaAdvisorToolResultErrorErrorCode` - `const BetaAdvisorToolResultErrorErrorCodeMaxUsesExceeded BetaAdvisorToolResultErrorErrorCode = "max_uses_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodePromptTooLong BetaAdvisorToolResultErrorErrorCode = "prompt_too_long"` - `const BetaAdvisorToolResultErrorErrorCodeTooManyRequests BetaAdvisorToolResultErrorErrorCode = "too_many_requests"` - `const BetaAdvisorToolResultErrorErrorCodeOverloaded BetaAdvisorToolResultErrorErrorCode = "overloaded"` - `const BetaAdvisorToolResultErrorErrorCodeUnavailable BetaAdvisorToolResultErrorErrorCode = "unavailable"` - `const BetaAdvisorToolResultErrorErrorCodeExecutionTimeExceeded BetaAdvisorToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaAdvisorToolResultErrorErrorCodeModelNotFound BetaAdvisorToolResultErrorErrorCode = "model_not_found"` - `type BetaAdvisorResultBlock` - `Type AdvisorResult` default: advisor_result - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). `max_tokens` indicates the advisor's output was truncated at the tool's `max_tokens` value or the advisor model's policy cap. - `Text string` - `type BetaAdvisorRedactedResultBlock` - `Type AdvisorRedactedResult` default: advisor_redacted_result - `EncryptedContent string` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `StopReason string` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaCodeExecutionToolResultBlock` - `Type CodeExecutionToolResult` default: code_execution_tool_result - `Content BetaCodeExecutionToolResultBlockContentUnion` - `type BetaCodeExecutionToolResultError` - `Type CodeExecutionToolResultError` default: code_execution_tool_result_error - `ErrorCode BetaCodeExecutionToolResultErrorCode` - `const BetaCodeExecutionToolResultErrorCodeInvalidToolInput BetaCodeExecutionToolResultErrorCode = "invalid_tool_input"` - `const BetaCodeExecutionToolResultErrorCodeUnavailable BetaCodeExecutionToolResultErrorCode = "unavailable"` - `const BetaCodeExecutionToolResultErrorCodeTooManyRequests BetaCodeExecutionToolResultErrorCode = "too_many_requests"` - `const BetaCodeExecutionToolResultErrorCodeExecutionTimeExceeded BetaCodeExecutionToolResultErrorCode = "execution_time_exceeded"` - `type BetaCodeExecutionResultBlock` - `Type CodeExecutionResult` default: code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `type BetaEncryptedCodeExecutionResultBlock` Code execution result with encrypted stdout for PFC + web_search results. - `Type EncryptedCodeExecutionResult` default: encrypted_code_execution_result - `Content []BetaCodeExecutionOutputBlock` - `Type CodeExecutionOutput` default: code_execution_output - `FileID string` - `EncryptedStdout string` - `ReturnCode int64` - `Stderr string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaBashCodeExecutionToolResultBlock` - `Type BashCodeExecutionToolResult` default: bash_code_execution_tool_result - `Content BetaBashCodeExecutionToolResultBlockContentUnion` - `type BetaBashCodeExecutionToolResultError` - `Type BashCodeExecutionToolResultError` default: bash_code_execution_tool_result_error - `ErrorCode BetaBashCodeExecutionToolResultErrorErrorCode` - `const BetaBashCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaBashCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeUnavailable BetaBashCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaBashCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaBashCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaBashCodeExecutionToolResultErrorErrorCodeOutputFileTooLarge BetaBashCodeExecutionToolResultErrorErrorCode = "output_file_too_large"` - `type BetaBashCodeExecutionResultBlock` - `Type BashCodeExecutionResult` default: bash_code_execution_result - `Content []BetaBashCodeExecutionOutputBlock` - `Type BashCodeExecutionOutput` default: bash_code_execution_output - `FileID string` - `ReturnCode int64` - `Stderr string` - `Stdout string` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaTextEditorCodeExecutionToolResultBlock` - `Type TextEditorCodeExecutionToolResult` default: text_editor_code_execution_tool_result - `Content BetaTextEditorCodeExecutionToolResultBlockContentUnion` - `type BetaTextEditorCodeExecutionToolResultError` - `Type TextEditorCodeExecutionToolResultError` default: text_editor_code_execution_tool_result_error - `ErrorCode BetaTextEditorCodeExecutionToolResultErrorErrorCode` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeInvalidToolInput BetaTextEditorCodeExecutionToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeUnavailable BetaTextEditorCodeExecutionToolResultErrorErrorCode = "unavailable"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeTooManyRequests BetaTextEditorCodeExecutionToolResultErrorErrorCode = "too_many_requests"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeExecutionTimeExceeded BetaTextEditorCodeExecutionToolResultErrorErrorCode = "execution_time_exceeded"` - `const BetaTextEditorCodeExecutionToolResultErrorErrorCodeFileNotFound BetaTextEditorCodeExecutionToolResultErrorErrorCode = "file_not_found"` - `ErrorMessage string` - `type BetaTextEditorCodeExecutionViewResultBlock` - `Type TextEditorCodeExecutionViewResult` default: text_editor_code_execution_view_result - `Content string` - `FileType BetaTextEditorCodeExecutionViewResultBlockFileType` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeText BetaTextEditorCodeExecutionViewResultBlockFileType = "text"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypeImage BetaTextEditorCodeExecutionViewResultBlockFileType = "image"` - `const BetaTextEditorCodeExecutionViewResultBlockFileTypePDF BetaTextEditorCodeExecutionViewResultBlockFileType = "pdf"` - `NumLines int64` - `StartLine int64` - `TotalLines int64` - `type BetaTextEditorCodeExecutionCreateResultBlock` - `Type TextEditorCodeExecutionCreateResult` default: text_editor_code_execution_create_result - `IsFileUpdate bool` - `type BetaTextEditorCodeExecutionStrReplaceResultBlock` - `Type TextEditorCodeExecutionStrReplaceResult` default: text_editor_code_execution_str_replace_result - `Lines []string` - `NewLines int64` - `NewStart int64` - `OldLines int64` - `OldStart int64` - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaToolSearchToolResultBlock` - `Type ToolSearchToolResult` default: tool_search_tool_result - `Content BetaToolSearchToolResultBlockContentUnion` - `type BetaToolSearchToolResultError` - `Type ToolSearchToolResultError` default: tool_search_tool_result_error - `ErrorCode BetaToolSearchToolResultErrorErrorCode` - `const BetaToolSearchToolResultErrorErrorCodeInvalidToolInput BetaToolSearchToolResultErrorErrorCode = "invalid_tool_input"` - `const BetaToolSearchToolResultErrorErrorCodeUnavailable BetaToolSearchToolResultErrorErrorCode = "unavailable"` - `const BetaToolSearchToolResultErrorErrorCodeTooManyRequests BetaToolSearchToolResultErrorErrorCode = "too_many_requests"` - `const BetaToolSearchToolResultErrorErrorCodeExecutionTimeExceeded BetaToolSearchToolResultErrorErrorCode = "execution_time_exceeded"` - `ErrorMessage string` - `type BetaToolSearchToolSearchResultBlock` - `Type ToolSearchToolSearchResult` default: tool_search_tool_search_result - `ToolReferences []BetaToolReferenceBlock` - `Type ToolReference` default: tool_reference - `ToolName string` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `ToolUseID string` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `type BetaMCPToolUseBlock` - `Type MCPToolUse` default: mcp_tool_use - `ID string` pattern: ^[a-zA-Z0-9_-]+$ - `Input map[string, any]` - `Name string` The name of the MCP tool - `ServerName string` The name of the MCP server - `type BetaMCPToolResultBlock` - `Type MCPToolResult` default: mcp_tool_result - `Content BetaMCPToolResultBlockContentUnion` - `string` - `[]BetaTextBlock` - `Type Text` default: text - `Citations []BetaTextCitationUnion` 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`. - `Text string` - `IsError bool` default: false - `ToolUseID string` pattern: ^[a-zA-Z0-9_-]+$ - `type BetaContainerUploadBlock` Response model for a file uploaded to the container. - `Type ContainerUpload` default: container_upload - `FileID string` - `type BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `Type Compaction` default: compaction - `Content string` Summary of compacted content, or null if compaction failed - `EncryptedContent string` Opaque metadata from prior compaction, to be round-tripped verbatim - `Signature string Optional` Signature over the summary, to be sent back with the block verbatim - `ToolChanges []BetaCompactionBlockToolChangeUnion Optional` 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` 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 ToolAddition` default: tool_addition - `Tool BetaResponseToolAdditionBlockToolUnion` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `type BetaResponseToolChangeToolReference` 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` default: tool_reference - `Name string` - `type BetaResponseToolChangeMCPToolReference` 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` default: mcp_tool_reference - `Name string` - `ServerName string` - `type BetaResponseToolChangeMCPToolsetReference` 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` default: mcp_toolset_reference - `ServerName string` - `type BetaToolChangeToolDefinition` 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` default: tool_definition - `Definition BetaResponseToolUnion` - `type BetaResponseTool` A custom tool definition, as sent. - `Type BetaResponseToolType Optional` - `InputSchema BetaResponseToolInputSchema` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. This defines the shape of the `input` that your tool accepts and that the model will produce. - `Type Object` - `Properties map[string, any] Optional` - `Required []string Optional` - `Name string` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. minLength: 1, maxLength: 128, pattern: ^[a-zA-Z0-9_-]{1,128}$ - `AllowedCallers []string Optional` - `const BetaResponseToolAllowedCallerDirect BetaResponseToolAllowedCaller = "direct"` - `const BetaResponseToolAllowedCallerCodeExecution20250825 BetaResponseToolAllowedCaller = "code_execution_20250825"` - `const BetaResponseToolAllowedCallerCodeExecution20260120 BetaResponseToolAllowedCaller = "code_execution_20260120"` - `const BetaResponseToolAllowedCallerCodeExecution20260521 BetaResponseToolAllowedCaller = "code_execution_20260521"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Description string Optional` 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. - `EagerInputStreaming bool Optional` 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. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20241022` - `Type Bash20241022` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20241022AllowedCallerDirect BetaToolBash20241022AllowedCaller = "direct"` - `const BetaToolBash20241022AllowedCallerCodeExecution20250825 BetaToolBash20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260120 BetaToolBash20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20241022AllowedCallerCodeExecution20260521 BetaToolBash20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Type Ephemeral` - `TTL BetaCacheControlEphemeralTTL Optional` The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching?sdk_languages=go) for details. - `const BetaCacheControlEphemeralTTLTTL5m BetaCacheControlEphemeralTTL = "5m"` - `const BetaCacheControlEphemeralTTLTTL1h BetaCacheControlEphemeralTTL = "1h"` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolBash20250124` - `Type Bash20250124` - `Name Bash` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolBash20250124AllowedCallerDirect BetaToolBash20250124AllowedCaller = "direct"` - `const BetaToolBash20250124AllowedCallerCodeExecution20250825 BetaToolBash20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260120 BetaToolBash20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolBash20250124AllowedCallerCodeExecution20260521 BetaToolBash20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250522` - `Type CodeExecution20250522` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250522AllowedCallerDirect BetaCodeExecutionTool20250522AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250522AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250522AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20250825` - `Type CodeExecution20250825` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20250825AllowedCallerDirect BetaCodeExecutionTool20250825AllowedCaller = "direct"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20250825AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20250825AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260120` Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `Type CodeExecution20260120` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260120AllowedCallerDirect BetaCodeExecutionTool20260120AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260120AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260120AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `Type CodeExecution20260521` - `Name CodeExecution` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaCodeExecutionTool20260521AllowedCallerDirect BetaCodeExecutionTool20260521AllowedCaller = "direct"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20250825 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20250825"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260120 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260120"` - `const BetaCodeExecutionTool20260521AllowedCallerCodeExecution20260521 BetaCodeExecutionTool20260521AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `Type BrowserToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaBrowserToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaBrowserTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CloseTab BetaBrowserCloseTabConfig Optional` `close_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaBrowserDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FileUpload BetaBrowserFileUploadConfig Optional` `file_upload`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Find BetaBrowserFindConfig Optional` `find`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `FormInput BetaBrowserFormInputConfig Optional` `form_input`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `GetPageText BetaBrowserGetPageTextConfig Optional` `get_page_text`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaBrowserHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Hover BetaBrowserHoverConfig Optional` `hover`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `JavascriptExec BetaBrowserJavascriptExecConfig Optional` `javascript_exec`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaBrowserKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaBrowserLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaBrowserLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaBrowserLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaBrowserLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ListTabs BetaBrowserListTabsConfig Optional` `list_tabs`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaBrowserMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaBrowserMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Navigate BetaBrowserNavigateConfig Optional` `navigate`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `NewTab BetaBrowserNewTabConfig Optional` `new_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadConsole BetaBrowserReadConsoleConfig Optional` `read_console`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadNetwork BetaBrowserReadNetworkConfig Optional` `read_network`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ReadPage BetaBrowserReadPageConfig Optional` `read_page`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaBrowserRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaBrowserScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaBrowserScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `ScrollTo BetaBrowserScrollToConfig Optional` `scroll_to`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `SwitchTab BetaBrowserSwitchTabConfig Optional` `switch_tab`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaBrowserTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaBrowserWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaBrowserZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolComputerUse20241022` - `Type Computer20241022` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20241022AllowedCallerDirect BetaToolComputerUse20241022AllowedCaller = "direct"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20250825 BetaToolComputerUse20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260120 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20241022AllowedCallerCodeExecution20260521 BetaToolComputerUse20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMemoryTool20250818` - `Type Memory20250818` - `Name Memory` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaMemoryTool20250818AllowedCallerDirect BetaMemoryTool20250818AllowedCaller = "direct"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20250825 BetaMemoryTool20250818AllowedCaller = "code_execution_20250825"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260120 BetaMemoryTool20250818AllowedCaller = "code_execution_20260120"` - `const BetaMemoryTool20250818AllowedCallerCodeExecution20260521 BetaMemoryTool20250818AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20250124` - `Type Computer20250124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20250124AllowedCallerDirect BetaToolComputerUse20250124AllowedCaller = "direct"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20250825 BetaToolComputerUse20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260120 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20250124AllowedCallerCodeExecution20260521 BetaToolComputerUse20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20241022` - `Type TextEditor20241022` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20241022AllowedCallerDirect BetaToolTextEditor20241022AllowedCaller = "direct"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20250825 BetaToolTextEditor20241022AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260120 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20241022AllowedCallerCodeExecution20260521 BetaToolTextEditor20241022AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolComputerUse20251124` - `Type Computer20251124` - `DisplayHeightPx int64` The height of the display in pixels. minimum: 1 - `DisplayWidthPx int64` The width of the display in pixels. minimum: 1 - `Name Computer` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolComputerUse20251124AllowedCallerDirect BetaToolComputerUse20251124AllowedCaller = "direct"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20250825 BetaToolComputerUse20251124AllowedCaller = "code_execution_20250825"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260120 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260120"` - `const BetaToolComputerUse20251124AllowedCallerCodeExecution20260521 BetaToolComputerUse20251124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `DisplayNumber int64 Optional` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `EnableZoom bool Optional` Whether to enable an action to take a zoomed-in screenshot of the screen. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `Type ComputerToolset20260801` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs BetaComputerToolsetConfigs Optional` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `Type BetaComputerTypeConfig Optional` `type`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `CursorPosition BetaComputerCursorPositionConfig Optional` `cursor_position`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `DoubleClick BetaComputerDoubleClickConfig Optional` `double_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `HoldKey BetaComputerHoldKeyConfig Optional` `hold_key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Key BetaComputerKeyConfig Optional` `key`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClick BetaComputerLeftClickConfig Optional` `left_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftClickDrag BetaComputerLeftClickDragConfig Optional` `left_click_drag`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseDown BetaComputerLeftMouseDownConfig Optional` `left_mouse_down`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `LeftMouseUp BetaComputerLeftMouseUpConfig Optional` `left_mouse_up`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MiddleClick BetaComputerMiddleClickConfig Optional` `middle_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `MouseMove BetaComputerMouseMoveConfig Optional` `mouse_move`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `RightClick BetaComputerRightClickConfig Optional` `right_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Screenshot BetaComputerScreenshotConfig Optional` `screenshot`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Scroll BetaComputerScrollConfig Optional` `scroll`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `TripleClick BetaComputerTripleClickConfig Optional` `triple_click`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Wait BetaComputerWaitConfig Optional` `wait`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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. - `Zoom BetaComputerZoomConfig Optional` `zoom`'s config overrides. - `DeferLoading bool Optional` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `Enabled bool Optional` 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 BetaToolTextEditor20250124` - `Type TextEditor20250124` - `Name StrReplaceEditor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250124AllowedCallerDirect BetaToolTextEditor20250124AllowedCaller = "direct"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20250825 BetaToolTextEditor20250124AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260120 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250124AllowedCallerCodeExecution20260521 BetaToolTextEditor20250124AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250429` - `Type TextEditor20250429` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250429AllowedCallerDirect BetaToolTextEditor20250429AllowedCaller = "direct"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20250825 BetaToolTextEditor20250429AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260120 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250429AllowedCallerCodeExecution20260521 BetaToolTextEditor20250429AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolTextEditor20250728` - `Type TextEditor20250728` - `Name StrReplaceBasedEditTool` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolTextEditor20250728AllowedCallerDirect BetaToolTextEditor20250728AllowedCaller = "direct"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20250825 BetaToolTextEditor20250728AllowedCaller = "code_execution_20250825"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260120 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260120"` - `const BetaToolTextEditor20250728AllowedCallerCodeExecution20260521 BetaToolTextEditor20250728AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `InputExamples []map[string, any] Optional` - `MaxCharacters int64 Optional` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaWebSearchTool20250305` - `Type WebSearch20250305` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20250305AllowedCallerDirect BetaWebSearchTool20250305AllowedCaller = "direct"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20250825 BetaWebSearchTool20250305AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260120 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20250305AllowedCallerCodeExecution20260521 BetaWebSearchTool20250305AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `Type Approximate` - `City string Optional` The city of the user. minLength: 1, maxLength: 255 - `Country string Optional` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `Region string Optional` The region of the user. minLength: 1, maxLength: 255 - `Timezone string Optional` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `type BetaWebFetchTool20250910` - `Type WebFetch20250910` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20250910AllowedCallerDirect BetaWebFetchTool20250910AllowedCaller = "direct"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20250825 BetaWebFetchTool20250910AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260120 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20250910AllowedCallerCodeExecution20260521 BetaWebFetchTool20250910AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `Enabled bool Optional` - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults BetaWebFetchURLSourcesClientToolResultsUnion Optional` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `Type All` - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `Type None` - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `Type Only` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `Type Except` - `Tools []BetaWebFetchURLSourceToolReference` - `Type ToolReference` - `Name string` - `ServerToolResults BetaWebFetchURLSourcesServerToolResultsUnion Optional` 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. - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebFetchURLSourceOnly` The tool filter variant under which only the named tools' results contribute. - `type BetaWebFetchURLSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput BetaWebFetchURLSourcesUserInputUnion Optional` Whether URLs in user messages are fetchable: "all" or "none". - `type BetaWebFetchURLSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `type BetaWebFetchURLSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `type BetaWebSearchTool20260209` - `Type WebSearch20260209` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260209AllowedCallerDirect BetaWebSearchTool20260209AllowedCaller = "direct"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20250825 BetaWebSearchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260120 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260209AllowedCallerCodeExecution20260521 BetaWebSearchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260209` - `Type WebFetch20260209` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260209AllowedCallerDirect BetaWebFetchTool20260209AllowedCaller = "direct"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20250825 BetaWebFetchTool20260209AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260120 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260209AllowedCallerCodeExecution20260521 BetaWebFetchTool20260209AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `type BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `Type WebFetch20260309` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260309AllowedCallerDirect BetaWebFetchTool20260309AllowedCaller = "direct"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20250825 BetaWebFetchTool20260309AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260120 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260309AllowedCallerCodeExecution20260521 BetaWebFetchTool20260309AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaWebSearchTool20260318` - `Type WebSearch20260318` - `Name WebSearch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebSearchTool20260318AllowedCallerDirect BetaWebSearchTool20260318AllowedCaller = "direct"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20250825 BetaWebSearchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260120 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebSearchTool20260318AllowedCallerCodeExecution20260521 BetaWebSearchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `BlockedDomains []string Optional` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebSearchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebSearchTool20260318ResponseInclusionFull BetaWebSearchTool20260318ResponseInclusion = "full"` - `const BetaWebSearchTool20260318ResponseInclusionExcluded BetaWebSearchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `UserLocation BetaUserLocation Optional` Parameters for the user's location. Used to provide more relevant search results. - `type BetaWebFetchTool20260318` - `Type WebFetch20260318` - `Name WebFetch` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaWebFetchTool20260318AllowedCallerDirect BetaWebFetchTool20260318AllowedCaller = "direct"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20250825 BetaWebFetchTool20260318AllowedCaller = "code_execution_20250825"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260120 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260120"` - `const BetaWebFetchTool20260318AllowedCallerCodeExecution20260521 BetaWebFetchTool20260318AllowedCaller = "code_execution_20260521"` - `AllowedDomains []string Optional` List of domains to allow fetching from - `BlockedDomains []string Optional` List of domains to block fetching from - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Citations BetaCitationsConfigParamResp Optional` Citations configuration for fetched documents. Citations are disabled by default. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxContentTokens int64 Optional` Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. minimum: 1 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion BetaWebFetchTool20260318ResponseInclusion Optional` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn. - `const BetaWebFetchTool20260318ResponseInclusionFull BetaWebFetchTool20260318ResponseInclusion = "full"` - `const BetaWebFetchTool20260318ResponseInclusionExcluded BetaWebFetchTool20260318ResponseInclusion = "excluded"` - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `URLSources BetaWebFetchURLSources Optional` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `UseCache bool Optional` Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - `type BetaAdvisorTool20260301` - `Type Advisor20260301` - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `const ModelClaudeHaiku5_5 Model = "claude-haiku-5-5"` Fastest model for high-volume, real-time tasks - `const ModelClaudeSonnet5_5 Model = "claude-sonnet-5-5"` Efficient model for coding and agents - `const ModelClaudeFable5_1 Model = "claude-fable-5-1"` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `const ModelClaudeOpus5_5 Model = "claude-opus-5-5"` Powerful intelligence for coding, knowledge work, and long-running agents - `const ModelClaudeMythos5_1 Model = "claude-mythos-5-1"` Our most capable model for cybersecurity and biology research, available through trusted access programs - `const ModelClaudeSonnet5 Model = "claude-sonnet-5"` Efficient model for coding and agents - `const ModelClaudeFable5 Model = "claude-fable-5"` Next generation of intelligence for the hardest knowledge work and coding problems - `const ModelClaudeMythos5 Model = "claude-mythos-5"` Most capable model for cybersecurity and biology research - `const ModelClaudeOpus5 Model = "claude-opus-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_8 Model = "claude-opus-4-8"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_7 Model = "claude-opus-4-7"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_6 Model = "claude-opus-4-6"` Powerful intelligence for long-running agents and coding - `const ModelClaudeSonnet4_6 Model = "claude-sonnet-4-6"` Best combination of speed and intelligence - `const ModelClaudeHaiku4_5 Model = "claude-haiku-4-5"` - `const ModelClaudeHaiku4_5_20251001 Model = "claude-haiku-4-5-20251001"` - `const ModelClaudeOpus4_5 Model = "claude-opus-4-5"` Powerful intelligence for long-running agents and coding - `const ModelClaudeOpus4_5_20251101 Model = "claude-opus-4-5-20251101"` Powerful intelligence for long-running agents and coding - `const ModelClaudeMythosPreview Model = "claude-mythos-preview"` **Deprecated**: Will reach end-of-life on June 30, 2026. Please migrate to claude-mythos-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. New class of intelligence, strongest in coding and cybersecurity - `const ModelClaudeSonnet4_5 Model = "claude-sonnet-4-5"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `const ModelClaudeSonnet4_5_20250929 Model = "claude-sonnet-4-5-20250929"` **Deprecated**: Will reach end-of-life on November 30, 2026. Please migrate to claude-sonnet-5-5. Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more information. High-performance model for agents and coding - `Name Advisor` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaAdvisorTool20260301AllowedCallerDirect BetaAdvisorTool20260301AllowedCaller = "direct"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20250825 BetaAdvisorTool20260301AllowedCaller = "code_execution_20250825"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260120 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260120"` - `const BetaAdvisorTool20260301AllowedCallerCodeExecution20260521 BetaAdvisorTool20260301AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Caching BetaCacheControlEphemeral Optional` Caching for the advisor's own prompt. When set, each advisor call writes a cache entry at the given TTL so subsequent calls in the same conversation read the stable prefix. When omitted, the advisor prompt is not cached. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `MaxTokens int64 Optional` Bounds the advisor's total output (thinking + text) per call. When the advisor hits this cap, the returned advisor_result or advisor_redacted_result block carries stop_reason='max_tokens', and a truncation note is appended to the advice text the worker model sees (inside the encrypted blob in redacted mode). When set, the server also emits a remaining-tokens budget block in the advisor's prompt so the advisor self-shapes toward the cap. When omitted, the advisor model's default output cap applies and no budget block is emitted. minimum: 1024 - `MaxUses int64 Optional` Maximum number of times the tool can be used in the API request. minimum: 1 - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolBm25_20251119` - `Type BetaToolSearchToolBm25_20251119Type` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25_20251119 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25_20251119"` - `const BetaToolSearchToolBm25_20251119TypeToolSearchToolBm25 BetaToolSearchToolBm25_20251119Type = "tool_search_tool_bm25"` - `Name ToolSearchToolBm25` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolBm25_20251119AllowedCallerDirect BetaToolSearchToolBm25_20251119AllowedCaller = "direct"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolBm25_20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolBm25_20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaToolSearchToolRegex20251119` - `Type BetaToolSearchToolRegex20251119Type` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex20251119 BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex_20251119"` - `const BetaToolSearchToolRegex20251119TypeToolSearchToolRegex BetaToolSearchToolRegex20251119Type = "tool_search_tool_regex"` - `Name ToolSearchToolRegex` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `AllowedCallers []string Optional` - `const BetaToolSearchToolRegex20251119AllowedCallerDirect BetaToolSearchToolRegex20251119AllowedCaller = "direct"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20250825 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20250825"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260120 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260120"` - `const BetaToolSearchToolRegex20251119AllowedCallerCodeExecution20260521 BetaToolSearchToolRegex20251119AllowedCaller = "code_execution_20260521"` - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `DeferLoading bool Optional` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `Strict bool Optional` When true, guarantees schema validation on tool names and inputs - `type BetaMCPToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `Type MCPToolset` - `MCPServerName string` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `CacheControl BetaCacheControlEphemeral Optional` Create a cache control breakpoint at this content block. - `Configs map[string, BetaMCPToolConfig] Optional` Configuration overrides for specific tools, keyed by tool name - `DeferLoading bool Optional` - `Enabled bool Optional` - `DefaultConfig BetaMCPToolDefaultConfig Optional` Default configuration applied to all tools from this server - `DeferLoading bool Optional` - `Enabled bool Optional` - `Tools []BetaMCPToolParamResp Optional` The server's tool listing, pinned: when present, the server is not asked for its tools before sampling and exactly these entries, with `default_config` and `configs` applied, are the toolset's tools. Copy it from the `mcp_tool_listing` block of an earlier response. - `InputSchema map[string, any]` The tool's input schema as the MCP server lists it, verbatim. - `Name string` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `Description string Optional` The tool's description as the MCP server lists it. - `type BetaResponseToolRemovalBlock` 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 ToolRemoval` default: tool_removal - `Tool BetaResponseToolRemovalBlockToolUnion` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `type BetaResponseToolChangeToolReference` 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 BetaResponseToolChangeMCPToolReference` 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 BetaResponseToolChangeMCPToolsetReference` 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 BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `Type Fallback` default: fallback - `From BetaFallbackInfo` The model whose output ends at this point — the model that declined at this hop. When the declining hop is the requested model, its `model` echoes the top-level `model` string the caller sent (alias or canonical); when the declining hop is a fallback model, its `model` is that model's canonical id. - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `To BetaFallbackInfo` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `Trigger BetaFallbackRefusalTrigger` What caused the `from` model to hand over at this hop. - `Type Refusal` default: refusal - `Category BetaFallbackRefusalTriggerCategory` 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`. - `const BetaFallbackRefusalTriggerCategoryCyber BetaFallbackRefusalTriggerCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryBio BetaFallbackRefusalTriggerCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryFrontierLLM BetaFallbackRefusalTriggerCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaFallbackRefusalTriggerCategoryReasoningExtraction BetaFallbackRefusalTriggerCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaFallbackRefusalTriggerCategoryGeneralHarms BetaFallbackRefusalTriggerCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `type BetaMCPToolListingBlock` 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` default: mcp_tool_listing - `MCPServerName string` - `Tools []BetaMCPTool` - `InputSchema map[string, any]` - `Name string` - `Description string Optional` - `ContextManagement BetaContextManagementResponse` Context management response. Information about context management strategies applied during the request. - `AppliedEdits []BetaContextManagementResponseAppliedEditUnion` List of context management edits that were applied. - `type BetaClearToolUses20250919EditResponse` - `Type ClearToolUses20250919` The type of context management edit applied. default: clear_tool_uses_20250919 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedToolUses int64` Number of tool uses that were cleared. minimum: 0 - `type BetaClearThinking20251015EditResponse` - `Type ClearThinking20251015` The type of context management edit applied. default: clear_thinking_20251015 - `ClearedInputTokens int64` Number of input tokens cleared by this edit. minimum: 0 - `ClearedThinkingTurns int64` Number of thinking turns that were cleared. minimum: 0 - `Diagnostics BetaDiagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `CacheMissReason BetaCacheMissReasonUnion` 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 BetaCacheMissModelChanged` - `Type ModelChanged` default: model_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissSystemChanged` - `Type SystemChanged` default: system_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissToolsChanged` - `Type ToolsChanged` default: tools_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissMessagesChanged` - `Type MessagesChanged` default: messages_changed - `CacheMissedInputTokens int64` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `type BetaCacheMissPreviousMessageNotFound` - `Type PreviousMessageNotFound` default: previous_message_not_found - `type BetaCacheMissUnavailable` - `Type Unavailable` default: unavailable - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `Role Assistant` Conversational role of the generated message. This will always be `"assistant"`. default: assistant - `StopDetails BetaRefusalStopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `Type Refusal` default: refusal - `Category BetaRefusalStopDetailsCategory` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `const BetaRefusalStopDetailsCategoryCyber BetaRefusalStopDetailsCategory = "cyber"` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `const BetaRefusalStopDetailsCategoryBio BetaRefusalStopDetailsCategory = "bio"` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `const BetaRefusalStopDetailsCategoryFrontierLLM BetaRefusalStopDetailsCategory = "frontier_llm"` The request could assist the development of competing AI models, which is restricted under [Anthropic's commercial terms](https://www.anthropic.com/legal/commercial-terms). Benign machine learning work can also trigger this category. - `const BetaRefusalStopDetailsCategoryReasoningExtraction BetaRefusalStopDetailsCategory = "reasoning_extraction"` The request asks the model to reproduce its internal reasoning in the response text. To get reasoning in a structured form instead, use [adaptive thinking](https://platform.claude.com/docs/en/build-with-claude/adaptive-thinking?sdk_languages=go). - `const BetaRefusalStopDetailsCategoryGeneralHarms BetaRefusalStopDetailsCategory = "general_harms"` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `Explanation string` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `FallbackCreditToken string` Opaque code that refunds the cache-miss cost when retrying this refused request on the fallback model. Pass it as `fallback_credit_token` on the retry request. Expires 5 minutes after the refusal. The retry is sent either with the same request body (`system`, `messages`, `tools`, and other render-shaping fields), or with the same body plus one appended `assistant` message whose content is the partial text (with any trailing whitespace stripped from the final text block) and paired server-tool blocks from this refusal — which also authorizes that appended turn as an assistant-prefill continuation on models that otherwise disallow prefill. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed the second way — if a same-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry the second way instead. Either way: same workspace, same platform; a mismatch is a 400. Resending a token for an already-warm prefix is permitted but yields no additional credit. `null` when the refused model isn't eligible for a fallback credit. - `FallbackHasPrefillClaim bool` Whether the accompanying `fallback_credit_token` may be redeemed with the appended-assistant retry form. Only set when `fallback_credit_token` is present. `true`: retry by resending the same request body plus one appended `assistant` message whose content is this response's `content` with any trailing whitespace stripped from the final text block and unpaired `tool_use` blocks omitted (the same appended-turn shape described on `fallback_credit_token`), with the token attached. `false`: retry by resending the original request body unchanged, with the token attached — the appended-assistant form is not available for this refusal (no continuable partial content, or the request uses `output_format` or a `tool_choice` that forces tool use). One exception: when the request used `output_format` or a forced `tool_choice` and the refusal arrived after server tools (including MCP connector tools) had already executed, the token may not be redeemable by either retry form; if the exact-body retry is then rejected with a 400 saying the token must be redeemed by continuing the partial response, discard the token and retry without it. Advisory: if an appended-assistant retry is rejected with a 400 despite `true`, fall back to resending the original request body with the token. - `RecommendedModel string` The server's suggested retry target for this refusal. Populated when a fallback attempt could not be made (the fallback model's rate limit was exhausted, or it was overloaded); names the fallback model the caller can retry directly. Null otherwise. - `StopReason BetaStopReason` The reason that we stopped. This may be one the following values: * `"end_turn"`: the model reached a natural stopping point * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated * `"tool_use"`: the model invoked one or more tools * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. * `"refusal"`: when streaming classifiers intervene to handle potential policy violations * `"model_context_window_exceeded"`: we exceeded the model's context window In non-streaming mode this value is always non-null. In streaming mode, it is null in the `message_start` event and non-null otherwise. - `const BetaStopReasonEndTurn BetaStopReason = "end_turn"` - `const BetaStopReasonMaxTokens BetaStopReason = "max_tokens"` - `const BetaStopReasonStopSequence BetaStopReason = "stop_sequence"` - `const BetaStopReasonToolUse BetaStopReason = "tool_use"` - `const BetaStopReasonPauseTurn BetaStopReason = "pause_turn"` - `const BetaStopReasonCompaction BetaStopReason = "compaction"` - `const BetaStopReasonRefusal BetaStopReason = "refusal"` - `const BetaStopReasonModelContextWindowExceeded BetaStopReason = "model_context_window_exceeded"` - `StopSequence string` Which custom stop sequence was generated, if any. This value will be a non-null string if one of your custom stop sequences was generated. - `Usage BetaUsage` 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`. - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `Ephemeral1hInputTokens int64` The number of input tokens used to create the 1 hour cache entry. default: 0, minimum: 0 - `Ephemeral5mInputTokens int64` The number of input tokens used to create the 5 minute cache entry. default: 0, minimum: 0 - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. minimum: 0 - `FallbackCredit BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. Present on every response to a non-batch request that carried a `fallback_credit_token`, in either redemption mode; absent otherwise (batch items accept and ignore the token and carry no outcome object). - `Status BetaFallbackCreditUsageStatusUnion` 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` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `Type Redeemed` default: redeemed - `type BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `Type NotApplied` default: not_applied - `Reason BetaFallbackCreditNotAppliedReason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `const BetaFallbackCreditNotAppliedReasonBodyMismatch BetaFallbackCreditNotAppliedReason = "body_mismatch"` - `const BetaFallbackCreditNotAppliedReasonContinuationExcluded BetaFallbackCreditNotAppliedReason = "continuation_excluded"` - `const BetaFallbackCreditNotAppliedReasonContinuationOnly BetaFallbackCreditNotAppliedReason = "continuation_only"` - `const BetaFallbackCreditNotAppliedReasonExpired BetaFallbackCreditNotAppliedReason = "expired"` - `const BetaFallbackCreditNotAppliedReasonInvalidTargetModel BetaFallbackCreditNotAppliedReason = "invalid_target_model"` - `const BetaFallbackCreditNotAppliedReasonNotEnabled BetaFallbackCreditNotAppliedReason = "not_enabled"` - `const BetaFallbackCreditNotAppliedReasonRepriceUnavailable BetaFallbackCreditNotAppliedReason = "reprice_unavailable"` - `const BetaFallbackCreditNotAppliedReasonTemporarilyUnavailable BetaFallbackCreditNotAppliedReason = "temporarily_unavailable"` - `const BetaFallbackCreditNotAppliedReasonVariantFieldsPresent BetaFallbackCreditNotAppliedReason = "variant_fields_present"` - `const BetaFallbackCreditNotAppliedReasonWrongOrganization BetaFallbackCreditNotAppliedReason = "wrong_organization"` - `const BetaFallbackCreditNotAppliedReasonWrongPlatform BetaFallbackCreditNotAppliedReason = "wrong_platform"` - `const BetaFallbackCreditNotAppliedReasonWrongWorkspace BetaFallbackCreditNotAppliedReason = "wrong_workspace"` - `RemoveToRedeem []string Optional` Request fields to remove before retrying, so the retry can redeem this token. Present exactly when `reason` is `variant_fields_present` — never null, never an empty array; absent otherwise. Fields are named only from your own request, and only after the sealed variant hash matched. A served best-effort retry has already been billed at normal price; nothing redeems retroactively, but a corrected re-send inside the token's five-minute window can still redeem. - `InferenceGeo string` The geographic region where inference was performed for this request. - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Iterations BetaIterationsUsage` 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 `message` entry - Understand token accumulation across server-side tool use loops A `compaction` entry reports the token usage of the compaction operation itself — the server-side request that summarizes the context being closed — NOT the size of the context that was compacted away, and its token counts can be much smaller than that closed context (for example, a compaction that closes a ~200k-token context can report only a few thousand tokens). Do not derive the context window size from a `compaction` entry, even when it is the last entry. A `compaction` entry's tokens are not included in the top-level `usage` fields. When an input-token trigger is in effect (the default — 150,000 tokens unless configured otherwise), each `compaction` entry closes a context that had reached at least that threshold, though the context can exceed it by the final iteration's output and tool results. - `type BetaMessageIterationUsage` Token usage for a sampling iteration. - `Type Message` Usage for a sampling iteration default: message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaCompactionIterationUsage` Token usage for a compaction iteration. - `Type Compaction` Usage for a compaction iteration default: compaction - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `Type AdvisorMessage` Usage for an advisor sub-inference iteration default: advisor_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `type BetaFallbackMessageIterationUsage` 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 FallbackMessage` Usage for the fallback-model attempt that served the response default: fallback_message - `CacheCreation BetaCacheCreation` Breakdown of cached tokens by TTL - `CacheCreationInputTokens int64` The number of input tokens used to create the cache entry. default: 0, minimum: 0 - `CacheReadInputTokens int64` The number of input tokens read from the cache. default: 0, minimum: 0 - `InputTokens int64` The number of input tokens which were used. minimum: 0 - `Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokens int64` The number of output tokens which were used. minimum: 0 - `OutputTokensDetails BetaOutputTokensDetails` 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. - `ThinkingTokens int64` 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. default: 0, minimum: 0 - `ServerToolUse BetaServerToolUsage` The number of server tool requests. - `WebFetchRequests int64` The number of web fetch tool requests. default: 0, minimum: 0 - `WebSearchRequests int64` The number of web search tool requests. default: 0, minimum: 0 - `ServiceTier BetaUsageServiceTier` If the request used the priority, standard, or batch tier. - `const BetaUsageServiceTierStandard BetaUsageServiceTier = "standard"` - `const BetaUsageServiceTierPriority BetaUsageServiceTier = "priority"` - `const BetaUsageServiceTierBatch BetaUsageServiceTier = "batch"` - `Speed BetaUsageSpeed` The inference speed mode used for this request. - `const BetaUsageSpeedStandard BetaUsageSpeed = "standard"` - `const BetaUsageSpeedFast BetaUsageSpeed = "fast"` - `InputTransformations []BetaInputTransformationUnion Optional` Changes the API made to the request's input before showing it to the model, and blocks that failed a binding check but were left unchanged: one entry per block, in request order. Two entry types today. `thinking_dropped` — a `thinking`, `redacted_thinking` or `connector_text` block from the request's `messages` that was removed from the prompt instead of being shown to the model because it failed a binding check. `thinking_mismatch_allowed` — a `thinking` or `redacted_thinking` block that failed the conversation check (the conversation before it differs from the one it was created in, or it carries no record of one on a model that requires it) and was shown to the model all the same, because that check is not enforced for this request. More entry types may be added over time; ignore types you do not recognize. Requires `anthropic-beta: thinking-binding-controls-2026-08-01`. Present on every such response from a model that supports extended thinking, as `[]` when there is no entry to report; without the beta, blocks are removed or left in place all the same but nothing is reported. Removed blocks contribute nothing to `usage.input_tokens`; blocks left in place count as sent. When streaming, the array is final in `message_start`; the final `message_delta` event carries it only when a server-side model fallback happened mid-stream, in which case it holds the serving model's entries and replaces the one in `message_start`. - `type BetaThinkingDroppedInputTransformation` - `Type ThinkingDropped` Always `thinking_dropped` for this entry type. default: thinking_dropped - `Path string` 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 BetaThinkingDroppedInputTransformationReason` 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`. - `const BetaThinkingDroppedInputTransformationReasonModelBindingMismatch BetaThinkingDroppedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonPrefixBindingMismatch BetaThinkingDroppedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonOrganizationBindingMismatch BetaThinkingDroppedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingDroppedInputTransformationReasonEndUserBindingMismatch BetaThinkingDroppedInputTransformationReason = "end_user_binding_mismatch"` - `type BetaThinkingMismatchAllowedInputTransformation` - `Type ThinkingMismatchAllowed` Always `thinking_mismatch_allowed` for this entry type. default: thinking_mismatch_allowed - `Path string` 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 BetaThinkingMismatchAllowedInputTransformationReason` 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. - `const BetaThinkingMismatchAllowedInputTransformationReasonModelBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "model_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonPrefixBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "prefix_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonOrganizationBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "organization_binding_mismatch"` - `const BetaThinkingMismatchAllowedInputTransformationReasonEndUserBindingMismatch BetaThinkingMismatchAllowedInputTransformationReason = "end_user_binding_mismatch"` - `type BetaMessageBatchErroredResult` - `Type Errored` default: errored - `Error BetaErrorResponse` - `Type Error` default: error - `Error BetaErrorUnion` - `type BetaInvalidRequestError` - `Type InvalidRequestError` default: invalid_request_error - `Message string` default: Invalid request - `type BetaAuthenticationError` - `Type AuthenticationError` default: authentication_error - `Message string` default: Authentication error - `type BetaBillingError` - `Type BillingError` default: billing_error - `Message string` default: Billing error - `type BetaPermissionError` - `Type PermissionError` default: permission_error - `Message string` default: Permission denied - `type BetaNotFoundError` - `Type NotFoundError` default: not_found_error - `Message string` default: Not found - `type BetaRateLimitError` - `Type RateLimitError` default: rate_limit_error - `Message string` default: Rate limited - `type BetaGatewayTimeoutError` - `Type TimeoutError` default: timeout_error - `Message string` default: Request timeout - `type BetaAPIError` - `Type APIError` default: api_error - `Message string` default: Internal server error - `type BetaOverloadedError` - `Type OverloadedError` default: overloaded_error - `Message string` default: Overloaded - `RequestID string` - `type BetaMessageBatchCanceledResult` - `Type Canceled` default: canceled - `type BetaMessageBatchExpiredResult` - `Type Expired` default: expired #### Example ```go package main import ( "context" "fmt" "github.com/anthropics/anthropic-sdk-go" "github.com/anthropics/anthropic-sdk-go/option" ) func main() { client := anthropic.NewClient( option.WithAPIKey("my-anthropic-api-key"), ) stream := client.Beta.Messages.Batches.ResultsStreaming( context.TODO(), "message_batch_id", anthropic.BetaMessageBatchResultsParams{}, ) for stream.Next() { fmt.Printf("%+v\n", stream.Current()) } err := stream.Err() if err != nil { panic(err.Error()) } } ```