--- title: Messages url: https://platform.claude.com/docs/en/api/csharp/beta/messages --- # Messages ## Create a Message `BetaMessage Beta.Messages.Create(parameters, cancellationToken = default)` **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=csharp) ### Parameters - `MessageCreateParams parameters` - `required long maxTokens` 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=csharp#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=csharp) for details. minimum: 0 - `required IReadOnlyList messages` 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=csharp#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=csharp). 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=csharp#give-claude-a-role), you can use the top-level `system` parameter. There is a limit of 100,000 messages in a single request. - `class BetaUserMessageParam` - `required BetaMessageContentParam Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaRequestDocumentBlock` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `bool Enabled` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 - `class BetaSearchResultBlockParam` - `JsonElement Type = "search_result"` - `required IReadOnlyList Content` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `required string Source` - `required string Title` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam Citations` - `class BetaThinkingBlockParam` - `JsonElement Type = "thinking"` - `required string Signature` 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`. - `required string Thinking` The `thinking` text of this block as returned by the API. - `class BetaRedactedThinkingBlockParam` - `JsonElement Type = "redacted_thinking"` - `required string Data` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `class BetaToolUseBlockParam` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1, maxLength: 200 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaToolResultBlockParam` - `JsonElement Type = "tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaSearchResultBlockParam` - `class BetaRequestDocumentBlock` - `class BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonElement Type = "browser_state"` - `required IReadOnlyList Tabs` 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 - `required string TabID` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool Active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? StateChanges` 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 - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool IsError` - `string? ToolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlockParam` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlockParam` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockParamContent Content` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string Title` - `required string Url` - `string? PageAge` - `class BetaWebSearchToolRequestError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlockParam` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlockParam` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlockParam` - `JsonElement Type = "web_fetch_result"` - `required BetaRequestDocumentBlock Content` - `required string Url` Fetched content URL - `string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlockParam` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultErrorParam` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlockParam` - `JsonElement Type = "advisor_result"` - `required string Text` - `string? StopReason` - `class BetaAdvisorRedactedResultBlockParam` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob produced by a prior response; must be round-tripped verbatim. - `string? StopReason` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCodeExecutionToolResultBlockParam` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockParamContent Content` - `class BetaCodeExecutionToolResultErrorParam` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlockParam` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlockParam` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form, sent back in a later request. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBashCodeExecutionToolResultBlockParam` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultErrorParam` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlockParam` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaTextEditorCodeExecutionToolResultBlockParam` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultErrorParam` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlockParam` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `long? NumLines` - `long? StartLine` - `long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlockParam` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `IReadOnlyList? Lines` - `long? NewLines` - `long? NewStart` - `long? OldLines` - `long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaToolSearchToolResultBlockParam` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultErrorParam` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlockParam` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaMcpToolUseBlockParam` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` - `required string ServerName` The name of the MCP server - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestMcpToolResultBlockParam` - `JsonElement Type = "mcp_tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `bool IsError` - `class BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonElement Type = "container_upload"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `JsonElement Type = "compaction"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `string? Content` Summary of previously compacted content, or null if compaction failed - `string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` The block's signature as returned, to be sent back verbatim - `IReadOnlyList? ToolChanges` 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. - `class BetaRequestToolAdditionBlock` 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolRemovalBlock` 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `required IReadOnlyList Tools` The server's tools, exactly as the response listed them. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `JsonElement Type = "fallback"` - `required BetaFallbackInfoParam From` Identifies one hop of a fallback transition. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfoParam To` Identifies one hop of a fallback transition. - `JsonElement Trigger` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `JsonElement Role = "user"` - `class BetaAssistantMessageParam` - `required BetaMessageContentParam Content` - `JsonElement Role = "assistant"` - `class BetaSystemMessageParam` - `JsonElement Role = "system"` - `ClearAt? ClearAt` 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. - `NextUserMessage("next_user_message")` - `Never("never")` - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `BetaSystemMessageOutputConfig? OutputConfig` 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? Effort` 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`. - `Low("low")` - `Medium("medium")` - `High("high")` - `Xhigh("xhigh")` - `Max("max")` - `required Model model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `BetaCacheControlEphemeral? cacheControl` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `BetaCompactionConfig? compaction` 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? container` Container identifier for reuse across requests. - `class BetaContainerParams` Container parameters with skills to be loaded. - `string? ID` Container id - `IReadOnlyList? Skills` List of skills to load in the container maxItems: 20 - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `string Version` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 - `string` - `BetaContextManagementConfig? contextManagement` Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `BetaDiagnosticsParam? diagnostics` 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? fallbackCreditToken` 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` - `class BetaFallbackCreditTokenParam` Object form of `fallback_credit_token`: the token plus a redemption mode. Requires `anthropic-beta: fallback-credit-2026-07-01`; without that header the field accepts the bare string only. The bare string and the mode-less object are equivalent (both select `strict`), so wrapping an existing token changes nothing by itself. - `required string Token` 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 Mode` 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`. - `Strict("strict")` - `BestEffort("best_effort")` - `BetaFallbacksParam? fallbacks` 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=csharp#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. - `string? inferenceGeo` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `IReadOnlyList mcpServers` MCP servers to be utilized in this request maxItems: 20 - `JsonElement Type = "url"` - `required string Name` - `required string Url` - `string? AuthorizationToken` - `BetaRequestMcpServerToolConfiguration? ToolConfiguration` - `IReadOnlyList? AllowedTools` - `bool? Enabled` - `BetaMetadata metadata` An object describing metadata about the request. - `BetaOutputConfig outputConfig` Configuration options for the model's output, such as the output format. - `ServiceTier serviceTier` 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=csharp) for details. - `Auto("auto")` - `StandardOnly("standard_only")` - `Speed? speed` 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=csharp) for which models. - `Standard("standard")` - `Fast("fast")` - `IReadOnlyList stopSequences` 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 system` 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=csharp#give-claude-a-role). - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `BetaThinkingConfigParam thinking` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#configuring-thinking) for each model's behavior. - `BetaMessageThreadParam? thread` Server-held conversation state (a Thread). `{"type": "create"}` asks the server to hold this conversation's state under the response's `id`; `{"type": "continue", "previous_message_id": ...}` resumes from a previous response so only the new turn's messages are sent. The response shape is unchanged. - `BetaToolChoice toolChoice` 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. - `IReadOnlyList tools` 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=csharp), 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=csharp)). 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=csharp) for more details. - `class BetaTool` - `class BetaToolBash20241022` - `class BetaToolBash20250124` - `class BetaCodeExecutionTool20250522` - `class BetaCodeExecutionTool20250825` - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `class BetaToolComputerUse20241022` - `class BetaMemoryTool20250818` - `class BetaToolComputerUse20250124` - `class BetaToolTextEditor20241022` - `class BetaToolComputerUse20251124` - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `class BetaToolTextEditor20250124` - `class BetaToolTextEditor20250429` - `class BetaToolTextEditor20250728` - `class BetaWebSearchTool20250305` - `class BetaWebFetchTool20250910` - `class BetaWebSearchTool20260209` - `class BetaWebFetchTool20260209` - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `class BetaWebSearchTool20260318` - `class BetaWebFetchTool20260318` - `class BetaAdvisorTool20260301` - `class BetaToolSearchToolBm25_20251119` - `class BetaToolSearchToolRegex20251119` - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string userProfileID` (header parameter) The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. - `string workspaceID` (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. - `BetaJsonOutputFormat? outputFormat` **Deprecated** Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=csharp) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. ### Returns - `class BetaMessage` - `JsonElement Type = "message"` Object type. For Messages, this is always `"message"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required BetaContainer? Container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `required string ID` Identifier for the container used in this request - `required DateTimeOffset ExpiresAt` The time at which the container will expire. format: date-time - `required IReadOnlyList? Skills` Skills loaded in the container - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `required string Version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `required IReadOnlyList Content` 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)"}] ``` - `class BetaTextBlock` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `required string Text` - `class BetaThinkingBlock` - `JsonElement Type = "thinking"` - `required string Signature` 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=csharp) for details. - `required string Thinking` The text of Claude's thinking process for this block. - `class BetaRedactedThinkingBlock` - `JsonElement Type = "redacted_thinking"` - `required string Data` 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=csharp#redacted-thinking-blocks) for details. - `class BetaToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1 - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlock` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlock` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockContent Content` - `class BetaWebSearchToolResultError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string? PageAge` - `required string Title` - `required string Url` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlock` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlock` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlock` - `JsonElement Type = "web_fetch_result"` - `required BetaDocumentBlock Content` - `JsonElement Type = "document"` - `required BetaCitationConfig? Citations` Citation configuration for the document - `required bool Enabled` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `required string? Title` The title of the document - `required string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string Url` Fetched content URL - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlock` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultError` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlock` - `JsonElement Type = "advisor_result"` - `required string? StopReason` 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. - `required string Text` - `class BetaAdvisorRedactedResultBlock` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `required string? StopReason` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaCodeExecutionToolResultBlock` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockContent Content` - `class BetaCodeExecutionToolResultError` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlock` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlock` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form. The API returns this block in place of `code_execution_result` when the code called the web search tool. See the [programmatic tool calling guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling?sdk_languages=csharp) to learn more about programmatic tool calling. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaBashCodeExecutionToolResultBlock` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultError` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlock` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaTextEditorCodeExecutionToolResultBlock` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultError` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `required string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlock` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `required long? NumLines` - `required long? StartLine` - `required long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlock` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlock` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `required IReadOnlyList? Lines` - `required long? NewLines` - `required long? NewStart` - `required long? OldLines` - `required long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaToolSearchToolResultBlock` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultError` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `required string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlock` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaMcpToolUseBlock` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` The name of the MCP tool - `required string ServerName` The name of the MCP server - `class BetaMcpToolResultBlock` - `JsonElement Type = "mcp_tool_result"` - `required Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` 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`. - `required string Text` - `required bool IsError` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `class BetaContainerUploadBlock` Response model for a file uploaded to the container. - `JsonElement Type = "container_upload"` - `required string FileID` - `class BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `JsonElement Type = "compaction"` - `required string? Content` Summary of compacted content, or null if compaction failed - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` Signature over the summary, to be sent back with the block verbatim - `IReadOnlyList? ToolChanges` 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. - `class 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `class 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. - `JsonElement Type = "tool_reference"` - `required string Name` - `class 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. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class 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. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaResponseToolUnion Definition` - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `class 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. - `class 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. - `class 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. - `class BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `JsonElement Type = "fallback"` - `required BetaFallbackInfo From` 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. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfo To` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `required BetaFallbackRefusalTrigger Trigger` What caused the `from` model to hand over at this hop. - `JsonElement Type = "refusal"` - `required BetaFallbackRefusalTriggerCategory? Category` The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` - `required IReadOnlyList Tools` - `required IReadOnlyDictionary InputSchema` - `required string Name` - `string Description` - `required BetaContextManagementResponse? ContextManagement` Context management response. Information about context management strategies applied during the request. - `required IReadOnlyList AppliedEdits` List of context management edits that were applied. - `class BetaClearToolUses20250919EditResponse` - `JsonElement Type = "clear_tool_uses_20250919"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedToolUses` Number of tool uses that were cleared. minimum: 0 - `class BetaClearThinking20251015EditResponse` - `JsonElement Type = "clear_thinking_20251015"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedThinkingTurns` Number of thinking turns that were cleared. minimum: 0 - `required BetaDiagnostics? Diagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `required BetaCacheMissReason? CacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class BetaCacheMissModelChanged` A `cache_miss_reason` for a request whose `model` or `speed` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "model_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissSystemChanged` A `cache_miss_reason` for a request whose `system` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "system_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissToolsChanged` A `cache_miss_reason` for a request whose `tools` differ from the previous request's, for example because tools were added, removed, or reordered. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "tools_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissMessagesChanged` A `cache_miss_reason` for a request whose `messages` differ from the previous request's in an earlier entry, instead of only having entries appended. The `model`, `system`, and `tools` match. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "messages_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissPreviousMessageNotFound` A `cache_miss_reason` for when the API doesn't have a stored record of the request that `diagnostics.previous_message_id` references. This doesn't mean that this request changed. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "previous_message_not_found"` - `class BetaCacheMissUnavailable` A `cache_miss_reason` for when the API can't give a diagnosis. The request itself was processed normally. This includes a request whose `model`, `system`, and `tools` match the previous request's but whose other prompt-affecting parameters, such as `thinking` or `tool_choice`, differ. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "unavailable"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `JsonElement Role = "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `required BetaRefusalStopDetails? StopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonElement Type = "refusal"` - `required Category? Category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `required string? Explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `required string? FallbackCreditToken` 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. - `required bool? FallbackHasPrefillClaim` 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. - `required string? RecommendedModel` 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. - `required BetaStopReason? StopReason` 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. - `EndTurn("end_turn")` - `MaxTokens("max_tokens")` - `StopSequence("stop_sequence")` - `ToolUse("tool_use")` - `PauseTurn("pause_turn")` - `Compaction("compaction")` - `Refusal("refusal")` - `ModelContextWindowExceeded("model_context_window_exceeded")` - `required string? StopSequence` 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. - `required BetaUsage Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long? CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long? CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required BetaFallbackCreditUsage? FallbackCredit` 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). - `required Status Status` Whether the fallback-credit reprice was applied to this response's billing. A union discriminated on `type`. `redeemed`: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - `class BetaFallbackCreditRedeemed` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `JsonElement Type = "redeemed"` - `class BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `JsonElement Type = "not_applied"` - `required Reason Reason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `BodyMismatch("body_mismatch")` - `ContinuationExcluded("continuation_excluded")` - `ContinuationOnly("continuation_only")` - `Expired("expired")` - `InvalidTargetModel("invalid_target_model")` - `NotEnabled("not_enabled")` - `RepriceUnavailable("reprice_unavailable")` - `TemporarilyUnavailable("temporarily_unavailable")` - `VariantFieldsPresent("variant_fields_present")` - `WrongOrganization("wrong_organization")` - `WrongPlatform("wrong_platform")` - `WrongWorkspace("wrong_workspace")` - `IReadOnlyList? RemoveToRedeem` 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. - `required string? InferenceGeo` The geographic region where inference was performed for this request. - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required IReadOnlyList? Iterations` 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. - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `JsonElement Type = "message"` Usage for a sampling iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model? Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `JsonElement Type = "compaction"` Usage for a compaction iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `JsonElement Type = "advisor_message"` Usage for an advisor sub-inference iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class 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`. - `JsonElement Type = "fallback_message"` Usage for the fallback-model attempt that served the response - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required BetaOutputTokensDetails? OutputTokensDetails` 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. - `required long ThinkingTokens` 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. minimum: 0 - `required BetaServerToolUsage? ServerToolUse` The number of server tool requests. - `required long WebFetchRequests` The number of web fetch tool requests. minimum: 0 - `required long WebSearchRequests` The number of web search tool requests. minimum: 0 - `required ServiceTier? ServiceTier` If the request used the priority, standard, or batch tier. - `Standard("standard")` - `Priority("priority")` - `Batch("batch")` - `required Speed? Speed` The inference speed mode used for this request. - `Standard("standard")` - `Fast("fast")` - `IReadOnlyList? InputTransformations` 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`. - `class BetaThinkingDroppedInputTransformation` - `JsonElement Type = "thinking_dropped"` Always `thinking_dropped` for this entry type. - `required string Path` 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. - `required Reason Reason` 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`. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` - `class BetaThinkingMismatchAllowedInputTransformation` - `JsonElement Type = "thinking_mismatch_allowed"` Always `thinking_mismatch_allowed` for this entry type. - `required string Path` 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. - `required Reason Reason` 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. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` - `class BetaRawMessageStreamEvent: union` - `class BetaRawMessageStartEvent` - `JsonElement Type = "message_start"` - `required BetaMessage Message` - `class BetaRawMessageDeltaEvent` - `JsonElement Type = "message_delta"` - `required BetaContextManagementResponse? ContextManagement` Information about context management strategies applied during the request - `required Delta Delta` - `required BetaContainer? Container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `required BetaRefusalStopDetails? StopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `required BetaStopReason? StopReason` - `required string? StopSequence` - `required BetaMessageDeltaUsage Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `required long? CacheCreationInputTokens` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `required long? CacheReadInputTokens` The cumulative number of input tokens read from the cache. minimum: 0 - `required BetaFallbackCreditUsage? FallbackCredit` 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). - `required long? InputTokens` The cumulative number of input tokens which were used. minimum: 0 - `required IReadOnlyList? Iterations` 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. - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `class 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`. - `required long OutputTokens` The cumulative number of output tokens which were used. - `required BetaOutputTokensDetails? OutputTokensDetails` 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. - `required BetaServerToolUsage? ServerToolUse` The number of server tool requests. - `IReadOnlyList? InputTransformations` 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`. - `class BetaThinkingDroppedInputTransformation` - `class BetaThinkingMismatchAllowedInputTransformation` - `class BetaRawMessageStopEvent` - `JsonElement Type = "message_stop"` - `class BetaRawContentBlockStartEvent` - `JsonElement Type = "content_block_start"` - `required ContentBlock ContentBlock` - `class BetaTextBlock` - `class BetaThinkingBlock` - `class BetaRedactedThinkingBlock` - `class BetaToolUseBlock` - `class BetaServerToolUseBlock` - `class BetaWebSearchToolResultBlock` - `class BetaWebFetchToolResultBlock` - `class BetaAdvisorToolResultBlock` - `class BetaCodeExecutionToolResultBlock` - `class BetaBashCodeExecutionToolResultBlock` - `class BetaTextEditorCodeExecutionToolResultBlock` - `class BetaToolSearchToolResultBlock` - `class BetaMcpToolUseBlock` - `class BetaMcpToolResultBlock` - `class BetaContainerUploadBlock` Response model for a file uploaded to the container. - `class BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `class BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `class 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. - `required long Index` - `class BetaRawContentBlockDeltaEvent` - `JsonElement Type = "content_block_delta"` - `required BetaRawContentBlockDelta Delta` - `class BetaTextDelta` - `JsonElement Type = "text_delta"` - `required string Text` - `class BetaInputJsonDelta` - `JsonElement Type = "input_json_delta"` - `required string PartialJson` - `class BetaCitationsDelta` - `JsonElement Type = "citations_delta"` - `required Citation Citation` - `class BetaCitationCharLocation` - `class BetaCitationPageLocation` - `class BetaCitationContentBlockLocation` - `class BetaCitationsWebSearchResultLocation` - `class BetaCitationSearchResultLocation` - `class BetaThinkingDelta` - `JsonElement Type = "thinking_delta"` - `required long? EstimatedTokens` 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. - `required string Thinking` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `class BetaSignatureDelta` - `JsonElement Type = "signature_delta"` - `required string Signature` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `class BetaCompactionContentBlockDelta` - `JsonElement Type = "compaction_delta"` - `required string? Content` - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `required long Index` - `class BetaRawContentBlockStopEvent` - `JsonElement Type = "content_block_stop"` - `required long Index` ### Example ```csharp using System; using Anthropic.Models.Beta.Messages; using Messages = Anthropic.Models.Messages; MessageCreateParams parameters = new() { MaxTokens = 1024, Messages = [ new BetaUserMessageParam("Hello, world") ], Model = Messages::Model.ClaudeOpus5_5, }; var betaMessage = await client.Beta.Messages.Create(parameters); Console.WriteLine(betaMessage); ``` #### 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 `BetaMessageTokensCount Beta.Messages.CountTokens(parameters, cancellationToken = default)` **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=csharp) ### Parameters - `MessageCountTokensParams parameters` - `required IReadOnlyList messages` 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=csharp#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=csharp). 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=csharp#give-claude-a-role), you can use the top-level `system` parameter. There is a limit of 100,000 messages in a single request. - `class BetaUserMessageParam` - `required BetaMessageContentParam Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaRequestDocumentBlock` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `bool Enabled` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 - `class BetaSearchResultBlockParam` - `JsonElement Type = "search_result"` - `required IReadOnlyList Content` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `required string Source` - `required string Title` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam Citations` - `class BetaThinkingBlockParam` - `JsonElement Type = "thinking"` - `required string Signature` 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`. - `required string Thinking` The `thinking` text of this block as returned by the API. - `class BetaRedactedThinkingBlockParam` - `JsonElement Type = "redacted_thinking"` - `required string Data` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `class BetaToolUseBlockParam` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1, maxLength: 200 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaToolResultBlockParam` - `JsonElement Type = "tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaSearchResultBlockParam` - `class BetaRequestDocumentBlock` - `class BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonElement Type = "browser_state"` - `required IReadOnlyList Tabs` 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 - `required string TabID` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool Active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? StateChanges` 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 - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool IsError` - `string? ToolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlockParam` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlockParam` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockParamContent Content` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string Title` - `required string Url` - `string? PageAge` - `class BetaWebSearchToolRequestError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlockParam` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlockParam` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlockParam` - `JsonElement Type = "web_fetch_result"` - `required BetaRequestDocumentBlock Content` - `required string Url` Fetched content URL - `string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlockParam` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultErrorParam` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlockParam` - `JsonElement Type = "advisor_result"` - `required string Text` - `string? StopReason` - `class BetaAdvisorRedactedResultBlockParam` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob produced by a prior response; must be round-tripped verbatim. - `string? StopReason` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCodeExecutionToolResultBlockParam` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockParamContent Content` - `class BetaCodeExecutionToolResultErrorParam` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlockParam` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlockParam` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form, sent back in a later request. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBashCodeExecutionToolResultBlockParam` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultErrorParam` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlockParam` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaTextEditorCodeExecutionToolResultBlockParam` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultErrorParam` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlockParam` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `long? NumLines` - `long? StartLine` - `long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlockParam` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `IReadOnlyList? Lines` - `long? NewLines` - `long? NewStart` - `long? OldLines` - `long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaToolSearchToolResultBlockParam` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultErrorParam` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlockParam` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaMcpToolUseBlockParam` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` - `required string ServerName` The name of the MCP server - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestMcpToolResultBlockParam` - `JsonElement Type = "mcp_tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `bool IsError` - `class BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonElement Type = "container_upload"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `JsonElement Type = "compaction"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `string? Content` Summary of previously compacted content, or null if compaction failed - `string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` The block's signature as returned, to be sent back verbatim - `IReadOnlyList? ToolChanges` 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. - `class BetaRequestToolAdditionBlock` 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolRemovalBlock` 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `required IReadOnlyList Tools` The server's tools, exactly as the response listed them. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `JsonElement Type = "fallback"` - `required BetaFallbackInfoParam From` Identifies one hop of a fallback transition. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfoParam To` Identifies one hop of a fallback transition. - `JsonElement Trigger` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `JsonElement Role = "user"` - `class BetaAssistantMessageParam` - `required BetaMessageContentParam Content` - `JsonElement Role = "assistant"` - `class BetaSystemMessageParam` - `JsonElement Role = "system"` - `ClearAt? ClearAt` 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. - `NextUserMessage("next_user_message")` - `Never("never")` - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `BetaSystemMessageOutputConfig? OutputConfig` 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? Effort` 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`. - `Low("low")` - `Medium("medium")` - `High("high")` - `Xhigh("xhigh")` - `Max("max")` - `required Model model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `BetaCacheControlEphemeral? cacheControl` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `BetaCompactionConfig? compaction` 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`. - `BetaContextManagementConfig? contextManagement` Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `IReadOnlyList mcpServers` MCP servers to be utilized in this request maxItems: 20 - `JsonElement Type = "url"` - `required string Name` - `required string Url` - `string? AuthorizationToken` - `BetaRequestMcpServerToolConfiguration? ToolConfiguration` - `IReadOnlyList? AllowedTools` - `bool? Enabled` - `BetaOutputConfig outputConfig` Configuration options for the model's output, such as the output format. - `Speed? speed` 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=csharp) for which models. - `Standard("standard")` - `Fast("fast")` - `System system` 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=csharp#give-claude-a-role). - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `BetaThinkingConfigParam thinking` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#configuring-thinking) for each model's behavior. - `BetaToolChoice toolChoice` 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. - `IReadOnlyList tools` 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=csharp), 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=csharp)). 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=csharp) for more details. - `class BetaTool` - `class BetaToolBash20241022` - `class BetaToolBash20250124` - `class BetaCodeExecutionTool20250522` - `class BetaCodeExecutionTool20250825` - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `class BetaToolComputerUse20241022` - `class BetaMemoryTool20250818` - `class BetaToolComputerUse20250124` - `class BetaToolTextEditor20241022` - `class BetaToolComputerUse20251124` - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `class BetaToolTextEditor20250124` - `class BetaToolTextEditor20250429` - `class BetaToolTextEditor20250728` - `class BetaWebSearchTool20250305` - `class BetaWebFetchTool20250910` - `class BetaWebSearchTool20260209` - `class BetaWebFetchTool20260209` - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `class BetaWebSearchTool20260318` - `class BetaWebFetchTool20260318` - `class BetaAdvisorTool20260301` - `class BetaToolSearchToolBm25_20251119` - `class BetaToolSearchToolRegex20251119` - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string userProfileID` (header parameter) The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. - `string workspaceID` (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. - `BetaJsonOutputFormat? outputFormat` **Deprecated** Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=csharp) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. ### Returns - `class BetaMessageTokensCount` - `required BetaCountTokensContextManagementResponse? ContextManagement` Information about context management applied to the message. - `required long OriginalInputTokens` The original token count before context management was applied - `required long InputTokens` The total number of tokens across the provided list of messages, system prompt, and tools. ### Example ```csharp using System; using Anthropic.Models.Beta.Messages; using Messages = Anthropic.Models.Messages; MessageCountTokensParams parameters = new() { Messages = [ new BetaUserMessageParam("Hello, world") ], Model = Messages::Model.ClaudeOpus5_5, }; var betaMessageTokensCount = await client.Beta.Messages.CountTokens(parameters); Console.WriteLine(betaMessageTokensCount); ``` #### Response (200) ```json { "context_management": { "original_input_tokens": 0 }, "input_tokens": 2095 } ``` ## Domain types ### Beta Advisor Message Iteration Usage - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `JsonElement Type = "advisor_message"` Usage for an advisor sub-inference iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 ### Beta Advisor Redacted Result Block - `class BetaAdvisorRedactedResultBlock` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `required string? StopReason` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). ### Beta Advisor Redacted Result Block Param - `class BetaAdvisorRedactedResultBlockParam` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob produced by a prior response; must be round-tripped verbatim. - `string? StopReason` ### Beta Advisor Result Block - `class BetaAdvisorResultBlock` - `JsonElement Type = "advisor_result"` - `required string? StopReason` 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. - `required string Text` ### Beta Advisor Result Block Param - `class BetaAdvisorResultBlockParam` - `JsonElement Type = "advisor_result"` - `required string Text` - `string? StopReason` ### Beta Advisor Tool 20260301 - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Advisor Tool Result Block - `class BetaAdvisorToolResultBlock` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultError` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlock` - `JsonElement Type = "advisor_result"` - `required string? StopReason` 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. - `required string Text` - `class BetaAdvisorRedactedResultBlock` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `required string? StopReason` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Advisor Tool Result Block Param - `class BetaAdvisorToolResultBlockParam` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultErrorParam` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlockParam` - `JsonElement Type = "advisor_result"` - `required string Text` - `string? StopReason` - `class BetaAdvisorRedactedResultBlockParam` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob produced by a prior response; must be round-tripped verbatim. - `string? StopReason` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` ### Beta Advisor Tool Result Error - `class BetaAdvisorToolResultError` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` ### Beta Advisor Tool Result Error Param - `class BetaAdvisorToolResultErrorParam` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` ### Beta All Thinking Turns - `class BetaAllThinkingTurns` - `JsonElement Type = "all"` ### Beta Assistant Message Param - `class BetaAssistantMessageParam` - `required BetaMessageContentParam Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaRequestDocumentBlock` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `bool Enabled` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 - `class BetaSearchResultBlockParam` - `JsonElement Type = "search_result"` - `required IReadOnlyList Content` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `required string Source` - `required string Title` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam Citations` - `class BetaThinkingBlockParam` - `JsonElement Type = "thinking"` - `required string Signature` 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`. - `required string Thinking` The `thinking` text of this block as returned by the API. - `class BetaRedactedThinkingBlockParam` - `JsonElement Type = "redacted_thinking"` - `required string Data` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `class BetaToolUseBlockParam` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1, maxLength: 200 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaToolResultBlockParam` - `JsonElement Type = "tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaSearchResultBlockParam` - `class BetaRequestDocumentBlock` - `class BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonElement Type = "browser_state"` - `required IReadOnlyList Tabs` 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 - `required string TabID` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool Active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? StateChanges` 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 - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool IsError` - `string? ToolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlockParam` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlockParam` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockParamContent Content` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string Title` - `required string Url` - `string? PageAge` - `class BetaWebSearchToolRequestError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlockParam` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlockParam` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlockParam` - `JsonElement Type = "web_fetch_result"` - `required BetaRequestDocumentBlock Content` - `required string Url` Fetched content URL - `string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlockParam` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultErrorParam` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlockParam` - `JsonElement Type = "advisor_result"` - `required string Text` - `string? StopReason` - `class BetaAdvisorRedactedResultBlockParam` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob produced by a prior response; must be round-tripped verbatim. - `string? StopReason` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCodeExecutionToolResultBlockParam` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockParamContent Content` - `class BetaCodeExecutionToolResultErrorParam` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlockParam` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlockParam` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form, sent back in a later request. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBashCodeExecutionToolResultBlockParam` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultErrorParam` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlockParam` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaTextEditorCodeExecutionToolResultBlockParam` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultErrorParam` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlockParam` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `long? NumLines` - `long? StartLine` - `long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlockParam` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `IReadOnlyList? Lines` - `long? NewLines` - `long? NewStart` - `long? OldLines` - `long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaToolSearchToolResultBlockParam` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultErrorParam` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlockParam` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaMcpToolUseBlockParam` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` - `required string ServerName` The name of the MCP server - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestMcpToolResultBlockParam` - `JsonElement Type = "mcp_tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `bool IsError` - `class BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonElement Type = "container_upload"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `JsonElement Type = "compaction"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `string? Content` Summary of previously compacted content, or null if compaction failed - `string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` The block's signature as returned, to be sent back verbatim - `IReadOnlyList? ToolChanges` 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. - `class BetaRequestToolAdditionBlock` 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolRemovalBlock` 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `required IReadOnlyList Tools` The server's tools, exactly as the response listed them. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `JsonElement Type = "fallback"` - `required BetaFallbackInfoParam From` Identifies one hop of a fallback transition. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfoParam To` Identifies one hop of a fallback transition. - `JsonElement Trigger` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `JsonElement Role = "assistant"` ### Beta Base64 Image Source - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` ### Beta Base64 PDF Source - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` ### Beta Bash Code Execution Output Block - `class BetaBashCodeExecutionOutputBlock` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` ### Beta Bash Code Execution Output Block Param - `class BetaBashCodeExecutionOutputBlockParam` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` ### Beta Bash Code Execution Result Block - `class BetaBashCodeExecutionResultBlock` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` ### Beta Bash Code Execution Result Block Param - `class BetaBashCodeExecutionResultBlockParam` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` ### Beta Bash Code Execution Tool Result Block - `class BetaBashCodeExecutionToolResultBlock` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultError` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlock` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Bash Code Execution Tool Result Block Param - `class BetaBashCodeExecutionToolResultBlockParam` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultErrorParam` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlockParam` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` ### Beta Bash Code Execution Tool Result Error - `class BetaBashCodeExecutionToolResultError` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` ### Beta Bash Code Execution Tool Result Error Param - `class BetaBashCodeExecutionToolResultErrorParam` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` ### Beta Browser Click Target - `class BetaBrowserClickTarget: union` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. ### Beta Browser Close Tab Config - `class BetaBrowserCloseTabConfig` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserCloseTabInput` Close the tab with the given tab_id. - `required string TabID` The tab to close. ### Beta Browser Close Tab Tool Use Block - `class BetaBrowserCloseTabToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserCloseTabInput Input` Close the tab with the given tab_id. - `required string TabID` The tab to close. - `JsonElement Name = "close_tab"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Coordinate Target - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 ### Beta Browser Double Click Config - `class BetaBrowserDoubleClickConfig` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserDoubleClickInput` Double left-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Double Click Tool Use Block - `class BetaBrowserDoubleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserDoubleClickInput Input` Double left-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "double_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser File Upload Config - `class BetaBrowserFileUploadConfig` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class 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. - `required BetaBrowserRefTarget Target` 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `IReadOnlyList? DocumentIds` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `IReadOnlyList? Paths` File paths on the browser executor's filesystem. minItems: 1 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser File Upload Tool Use Block - `class BetaBrowserFileUploadToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserFileUploadInput Input` 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. - `required BetaBrowserRefTarget Target` 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `IReadOnlyList? DocumentIds` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `IReadOnlyList? Paths` File paths on the browser executor's filesystem. minItems: 1 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "file_upload"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Find Config - `class BetaBrowserFindConfig` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class 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. - `required string Query` Natural-language description of the element(s) to find. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Find Tool Use Block - `class BetaBrowserFindToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserFindInput Input` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `required string Query` Natural-language description of the element(s) to find. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "find"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Form Input Config - `class BetaBrowserFormInputConfig` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserFormInputInput` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `required BetaBrowserRefTarget Target` 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `required BetaBrowserFormInputValue Value` The value to set. - `string` - `double` - `bool` - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Form Input Tool Use Block - `class BetaBrowserFormInputToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserFormInputInput Input` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `required BetaBrowserRefTarget Target` 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `required BetaBrowserFormInputValue Value` The value to set. - `string` - `double` - `bool` - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "form_input"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Form Input Value - `class BetaBrowserFormInputValue: union` - `string` - `double` - `bool` ### Beta Browser Get Page Text Config - `class BetaBrowserGetPageTextConfig` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserGetPageTextInput` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Get Page Text Tool Use Block - `class BetaBrowserGetPageTextToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserGetPageTextInput Input` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "get_page_text"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Hold Key Config - `class BetaBrowserHoldKeyConfig` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class 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. - `required double Duration` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `required string Text` The key or chord to hold. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Hold Key Tool Use Block - `class BetaBrowserHoldKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserHoldKeyInput Input` 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. - `required double Duration` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `required string Text` The key or chord to hold. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "hold_key"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Hover Config - `class BetaBrowserHoverConfig` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserHoverInput` Move the cursor to a coordinate or element without clicking. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Hover Tool Use Block - `class BetaBrowserHoverToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserHoverInput Input` Move the cursor to a coordinate or element without clicking. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "hover"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Javascript Exec Config - `class BetaBrowserJavascriptExecConfig` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class 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`. - `required string Text` JavaScript to execute in the page context. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Javascript Exec Tool Use Block - `class BetaBrowserJavascriptExecToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserJavascriptExecInput Input` 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`. - `required string Text` JavaScript to execute in the page context. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "javascript_exec"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Key Config - `class BetaBrowserKeyConfig` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class 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. - `required string Text` The key, chord, or space-separated sequence to press. - `long? Repeat` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Key Tool Use Block - `class BetaBrowserKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserKeyInput Input` 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. - `required string Text` The key, chord, or space-separated sequence to press. - `long? Repeat` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "key"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Left Click Config - `class BetaBrowserLeftClickConfig` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserLeftClickDragConfig` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserLeftClickDragInput` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `required BetaBrowserCoordinateTarget From` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Left Click Drag Tool Use Block - `class BetaBrowserLeftClickDragToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftClickDragInput Input` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `required BetaBrowserCoordinateTarget From` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_click_drag"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Left Click Input - `class BetaBrowserLeftClickInput` Left-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Left Click Tool Use Block - `class BetaBrowserLeftClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftClickInput Input` Left-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Left Mouse Down Config - `class BetaBrowserLeftMouseDownConfig` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserLeftMouseDownInput` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Left Mouse Down Tool Use Block - `class BetaBrowserLeftMouseDownToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftMouseDownInput Input` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_mouse_down"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Left Mouse Up Config - `class BetaBrowserLeftMouseUpConfig` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserLeftMouseUpInput` Release the left mouse button at a viewport coordinate. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Left Mouse Up Tool Use Block - `class BetaBrowserLeftMouseUpToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftMouseUpInput Input` Release the left mouse button at a viewport coordinate. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_mouse_up"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser List Tabs Config - `class BetaBrowserListTabsConfig` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserListTabsInput:` List all open tabs with each tab's tab_id, title, and URL. ### Beta Browser List Tabs Tool Use Block - `class BetaBrowserListTabsToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserListTabsInput Input` List all open tabs with each tab's tab_id, title, and URL. - `JsonElement Name = "list_tabs"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Middle Click Config - `class BetaBrowserMiddleClickConfig` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserMiddleClickInput` Middle-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Middle Click Tool Use Block - `class BetaBrowserMiddleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserMiddleClickInput Input` Middle-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "middle_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Mouse Move Config - `class BetaBrowserMouseMoveConfig` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserMouseMoveInput` Move the pointer to a viewport coordinate without clicking. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Mouse Move Tool Use Block - `class BetaBrowserMouseMoveToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserMouseMoveInput Input` Move the pointer to a viewport coordinate without clicking. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "mouse_move"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Navigate Config - `class BetaBrowserNavigateConfig` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserNavigateInput` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `required string Url` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Navigate Tool Use Block - `class BetaBrowserNavigateToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserNavigateInput Input` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `required string Url` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "navigate"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser New Tab Config - `class BetaBrowserNewTabConfig` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserNewTabInput:` Open a new empty tab and return its tab_id. ### Beta Browser New Tab Tool Use Block - `class BetaBrowserNewTabToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserNewTabInput Input` Open a new empty tab and return its tab_id. - `JsonElement Name = "new_tab"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Read Console Config - `class BetaBrowserReadConsoleConfig` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class 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. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Read Console Tool Use Block - `class BetaBrowserReadConsoleToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserReadConsoleInput Input` 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. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "read_console"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Read Network Config - `class BetaBrowserReadNetworkConfig` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class 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. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Read Network Tool Use Block - `class BetaBrowserReadNetworkToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserReadNetworkInput Input` 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. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "read_network"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Read Page Config - `class BetaBrowserReadPageConfig` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `enum BetaBrowserReadPageFilter` - `All("all")` - `Interactive("interactive")` ### Beta Browser Read Page Input - `class 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. - `long? Depth` Maximum tree depth. Default 15. minimum: 1 - `BetaBrowserReadPageFilter? Filter` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `All("all")` - `Interactive("interactive")` - `string? Ref` Element reference to read a subtree from. Omit to read from the page root. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Read Page Tool Use Block - `class BetaBrowserReadPageToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserReadPageInput Input` 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. - `long? Depth` Maximum tree depth. Default 15. minimum: 1 - `BetaBrowserReadPageFilter? Filter` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `All("all")` - `Interactive("interactive")` - `string? Ref` Element reference to read a subtree from. Omit to read from the page root. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "read_page"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Ref Target - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. ### Beta Browser Right Click Config - `class BetaBrowserRightClickConfig` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserRightClickInput` Right-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Right Click Tool Use Block - `class BetaBrowserRightClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserRightClickInput Input` Right-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "right_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Screenshot Config - `class BetaBrowserScreenshotConfig` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserScreenshotInput` Capture the current browser viewport. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Screenshot Tool Use Block - `class BetaBrowserScreenshotToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserScreenshotInput Input` Capture the current browser viewport. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "screenshot"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Scroll Config - `class BetaBrowserScrollConfig` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `enum BetaBrowserScrollDirection` - `Up("up")` - `Down("down")` - `Left("left")` - `Right("right")` ### Beta Browser Scroll Input - `class BetaBrowserScrollInput` Scroll at a viewport position. `target` must be a coordinate target. - `required BetaBrowserScrollDirection ScrollDirection` - `Up("up")` - `Down("down")` - `Left("left")` - `Right("right")` - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `long? ScrollAmount` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Scroll To Config - `class BetaBrowserScrollToConfig` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserScrollToInput` Scroll an element into view. - `required BetaBrowserRefTarget Target` 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Scroll To Tool Use Block - `class BetaBrowserScrollToToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserScrollToInput Input` Scroll an element into view. - `required BetaBrowserRefTarget Target` 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "scroll_to"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Scroll Tool Use Block - `class BetaBrowserScrollToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserScrollInput Input` Scroll at a viewport position. `target` must be a coordinate target. - `required BetaBrowserScrollDirection ScrollDirection` - `Up("up")` - `Down("down")` - `Left("left")` - `Right("right")` - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `long? ScrollAmount` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "scroll"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser State Block Param - `class BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonElement Type = "browser_state"` - `required IReadOnlyList Tabs` 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 - `required string TabID` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool Active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? StateChanges` 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 - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Beta Browser State Change - `class BetaBrowserStateChange: union` - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Beta Browser State Change Download Completed - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 ### Beta Browser State Change Download Failed - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ ### Beta Browser State Change Download Started - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` 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 - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` 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 - `class BetaBrowserStateTabEntry` One open browser tab reported in a `browser_state` block's `tabs` inventory. `tab_id` is the caller-assigned identifier for the tab; `title` and `url` describe the page the tab is currently showing and may be empty strings (a blank tab legitimately has both empty). `active` marks the tab that is active after this call; whenever `tabs` is non-empty, exactly one entry is marked. - `required string TabID` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool Active` 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 - `class BetaBrowserSwitchTabConfig` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserSwitchTabInput` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `required string TabID` The tab to switch to. ### Beta Browser Switch Tab Tool Use Block - `class BetaBrowserSwitchTabToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserSwitchTabInput Input` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `required string TabID` The tab to switch to. - `JsonElement Name = "switch_tab"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Tool Use Block - `class BetaBrowserToolUseBlock: union` - `class BetaBrowserNavigateToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserNavigateInput Input` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `required string Url` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "navigate"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaBrowserListTabsToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserListTabsInput Input` List all open tabs with each tab's tab_id, title, and URL. - `JsonElement Name = "list_tabs"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserNewTabToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserNewTabInput Input` Open a new empty tab and return its tab_id. - `JsonElement Name = "new_tab"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserSwitchTabToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserSwitchTabInput Input` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `required string TabID` The tab to switch to. - `JsonElement Name = "switch_tab"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserCloseTabToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserCloseTabInput Input` Close the tab with the given tab_id. - `required string TabID` The tab to close. - `JsonElement Name = "close_tab"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserReadPageToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserReadPageInput Input` 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. - `long? Depth` Maximum tree depth. Default 15. minimum: 1 - `BetaBrowserReadPageFilter? Filter` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `All("all")` - `Interactive("interactive")` - `string? Ref` Element reference to read a subtree from. Omit to read from the page root. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "read_page"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserGetPageTextToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserGetPageTextInput Input` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "get_page_text"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserReadConsoleToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserReadConsoleInput Input` 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. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "read_console"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserReadNetworkToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserReadNetworkInput Input` 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. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "read_network"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserFindToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserFindInput Input` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `required string Query` Natural-language description of the element(s) to find. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "find"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserFormInputToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserFormInputInput Input` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `required BetaBrowserRefTarget Target` 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `required BetaBrowserFormInputValue Value` The value to set. - `string` - `double` - `bool` - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "form_input"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserFileUploadToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserFileUploadInput Input` 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. - `required BetaBrowserRefTarget Target` 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. - `IReadOnlyList? DocumentIds` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `IReadOnlyList? Paths` File paths on the browser executor's filesystem. minItems: 1 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "file_upload"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserScrollToToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserScrollToInput Input` Scroll an element into view. - `required BetaBrowserRefTarget Target` 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. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "scroll_to"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserScreenshotToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserScreenshotInput Input` Capture the current browser viewport. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "screenshot"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserZoomToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserZoomInput Input` 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. - `required IReadOnlyList Region` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "zoom"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserLeftClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftClickInput Input` Left-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserRightClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserRightClickInput Input` Right-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "right_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserMiddleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserMiddleClickInput Input` Middle-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "middle_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserDoubleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserDoubleClickInput Input` Double left-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "double_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserTripleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserTripleClickInput Input` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "triple_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserHoverToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserHoverInput Input` Move the cursor to a coordinate or element without clicking. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "hover"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserLeftClickDragToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftClickDragInput Input` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `required BetaBrowserCoordinateTarget From` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_click_drag"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserLeftMouseDownToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftMouseDownInput Input` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_mouse_down"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserLeftMouseUpToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftMouseUpInput Input` Release the left mouse button at a viewport coordinate. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_mouse_up"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserMouseMoveToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserMouseMoveInput Input` Move the pointer to a viewport coordinate without clicking. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "mouse_move"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserScrollToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserScrollInput Input` Scroll at a viewport position. `target` must be a coordinate target. - `required BetaBrowserScrollDirection ScrollDirection` - `Up("up")` - `Down("down")` - `Left("left")` - `Right("right")` - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `long? ScrollAmount` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "scroll"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserTypeToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserTypeInput Input` Type a literal string at the current focus. - `required string Text` The text to type. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "type"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserKeyInput Input` 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. - `required string Text` The key, chord, or space-separated sequence to press. - `long? Repeat` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "key"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserHoldKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserHoldKeyInput Input` 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. - `required double Duration` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `required string Text` The key or chord to hold. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "hold_key"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserWaitToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserWaitInput Input` Pause for the given duration. - `required double Duration` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "wait"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserJavascriptExecToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserJavascriptExecInput Input` 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`. - `required string Text` JavaScript to execute in the page context. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "javascript_exec"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. ### Beta Browser Toolset 20260801 - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserToolsetConfigs` Per-member configuration for `browser_toolset_20260801`: one optional field per member tool, keyed by the member name — the same name the member's `tool_use` blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserTripleClickConfig` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserTripleClickInput` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Triple Click Tool Use Block - `class BetaBrowserTripleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserTripleClickInput Input` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "triple_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Type Config - `class BetaBrowserTypeConfig` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserTypeInput` Type a literal string at the current focus. - `required string Text` The text to type. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Type Tool Use Block - `class BetaBrowserTypeToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserTypeInput Input` Type a literal string at the current focus. - `required string Text` The text to type. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "type"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Wait Config - `class BetaBrowserWaitConfig` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaBrowserWaitInput` Pause for the given duration. - `required double Duration` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Wait Tool Use Block - `class BetaBrowserWaitToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserWaitInput Input` Pause for the given duration. - `required double Duration` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "wait"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Browser Zoom Config - `class BetaBrowserZoomConfig` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class 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. - `required IReadOnlyList Region` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. ### Beta Browser Zoom Tool Use Block - `class BetaBrowserZoomToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserZoomInput Input` 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. - `required IReadOnlyList Region` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "zoom"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Cache Control Ephemeral - `class BetaCacheControlEphemeral` - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` ### Beta Cache Creation - `class BetaCacheCreation` - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 ### Beta Cache Miss Messages Changed - `class BetaCacheMissMessagesChanged` A `cache_miss_reason` for a request whose `messages` differ from the previous request's in an earlier entry, instead of only having entries appended. The `model`, `system`, and `tools` match. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "messages_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Beta Cache Miss Model Changed - `class BetaCacheMissModelChanged` A `cache_miss_reason` for a request whose `model` or `speed` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "model_changed"` - `required long CacheMissedInputTokens` 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 - `class BetaCacheMissPreviousMessageNotFound` A `cache_miss_reason` for when the API doesn't have a stored record of the request that `diagnostics.previous_message_id` references. This doesn't mean that this request changed. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "previous_message_not_found"` ### Beta Cache Miss Reason - `class BetaCacheMissReason: union` - `class BetaCacheMissModelChanged` A `cache_miss_reason` for a request whose `model` or `speed` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "model_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissSystemChanged` A `cache_miss_reason` for a request whose `system` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "system_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissToolsChanged` A `cache_miss_reason` for a request whose `tools` differ from the previous request's, for example because tools were added, removed, or reordered. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "tools_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissMessagesChanged` A `cache_miss_reason` for a request whose `messages` differ from the previous request's in an earlier entry, instead of only having entries appended. The `model`, `system`, and `tools` match. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "messages_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissPreviousMessageNotFound` A `cache_miss_reason` for when the API doesn't have a stored record of the request that `diagnostics.previous_message_id` references. This doesn't mean that this request changed. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "previous_message_not_found"` - `class BetaCacheMissUnavailable` A `cache_miss_reason` for when the API can't give a diagnosis. The request itself was processed normally. This includes a request whose `model`, `system`, and `tools` match the previous request's but whose other prompt-affecting parameters, such as `thinking` or `tool_choice`, differ. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "unavailable"` ### Beta Cache Miss System Changed - `class BetaCacheMissSystemChanged` A `cache_miss_reason` for a request whose `system` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "system_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Beta Cache Miss Tools Changed - `class BetaCacheMissToolsChanged` A `cache_miss_reason` for a request whose `tools` differ from the previous request's, for example because tools were added, removed, or reordered. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "tools_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. ### Beta Cache Miss Unavailable - `class BetaCacheMissUnavailable` A `cache_miss_reason` for when the API can't give a diagnosis. The request itself was processed normally. This includes a request whose `model`, `system`, and `tools` match the previous request's but whose other prompt-affecting parameters, such as `thinking` or `tool_choice`, differ. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "unavailable"` ### Beta Citation Char Location - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 ### Beta Citation Char Location Param - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 ### Beta Citation Config - `class BetaCitationConfig` - `required bool Enabled` ### Beta Citation Content Block Location - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 ### Beta Citation Content Block Location Param - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 ### Beta Citation Page Location - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 ### Beta Citation Page Location Param - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 ### Beta Citation Search Result Location - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` ### Beta Citation Search Result Location Param - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` ### Beta Citation Web Search Result Location Param - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 ### Beta Citations Config Param - `class BetaCitationsConfigParam` - `bool Enabled` ### Beta Citations Delta - `class BetaCitationsDelta` - `JsonElement Type = "citations_delta"` - `required Citation Citation` - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` ### Beta Citations Web Search Result Location - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` ### Beta Clear Thinking 20251015 Edit - `class BetaClearThinking20251015Edit` - `JsonElement Type = "clear_thinking_20251015"` - `Keep Keep` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `class BetaThinkingTurns` - `JsonElement Type = "thinking_turns"` - `required long Value` minimum: 1 - `class BetaAllThinkingTurns` - `JsonElement Type = "all"` - `class All:` ### Beta Clear Thinking 20251015 Edit Response - `class BetaClearThinking20251015EditResponse` - `JsonElement Type = "clear_thinking_20251015"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedThinkingTurns` Number of thinking turns that were cleared. minimum: 0 ### Beta Clear Tool Uses 20250919 Edit - `class BetaClearToolUses20250919Edit` - `JsonElement Type = "clear_tool_uses_20250919"` - `BetaInputTokensClearAtLeast? ClearAtLeast` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `JsonElement Type = "input_tokens"` - `required long Value` minimum: 0 - `ClearToolInputs? ClearToolInputs` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `bool` - `IReadOnlyList` - `IReadOnlyList? ExcludeTools` Tool names whose uses are preserved from clearing - `BetaToolUsesKeep Keep` Number of tool uses to retain in the conversation - `JsonElement Type = "tool_uses"` - `required long Value` minimum: 0 - `Trigger Trigger` Condition that triggers the context management strategy - `class BetaInputTokensTrigger` - `JsonElement Type = "input_tokens"` - `required long Value` minimum: 1 - `class BetaToolUsesTrigger` - `JsonElement Type = "tool_uses"` - `required long Value` minimum: 1 ### Beta Clear Tool Uses 20250919 Edit Response - `class BetaClearToolUses20250919EditResponse` - `JsonElement Type = "clear_tool_uses_20250919"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedToolUses` Number of tool uses that were cleared. minimum: 0 ### Beta Code Execution Output Block - `class BetaCodeExecutionOutputBlock` - `JsonElement Type = "code_execution_output"` - `required string FileID` ### Beta Code Execution Output Block Param - `class BetaCodeExecutionOutputBlockParam` - `JsonElement Type = "code_execution_output"` - `required string FileID` ### Beta Code Execution Result Block - `class BetaCodeExecutionResultBlock` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` ### Beta Code Execution Result Block Param - `class BetaCodeExecutionResultBlockParam` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` ### Beta Code Execution Tool 20250522 - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20250825 - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20260120 - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool 20260521 - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Code Execution Tool Result Block - `class BetaCodeExecutionToolResultBlock` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockContent Content` - `class BetaCodeExecutionToolResultError` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlock` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlock` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form. The API returns this block in place of `code_execution_result` when the code called the web search tool. See the [programmatic tool calling guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling?sdk_languages=csharp) to learn more about programmatic tool calling. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Code Execution Tool Result Block Content - `class BetaCodeExecutionToolResultBlockContent: union` - `class BetaCodeExecutionToolResultError` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlock` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlock` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form. The API returns this block in place of `code_execution_result` when the code called the web search tool. See the [programmatic tool calling guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling?sdk_languages=csharp) to learn more about programmatic tool calling. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` ### Beta Code Execution Tool Result Block Param - `class BetaCodeExecutionToolResultBlockParam` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockParamContent Content` - `class BetaCodeExecutionToolResultErrorParam` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlockParam` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlockParam` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form, sent back in a later request. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` ### Beta Code Execution Tool Result Block Param Content - `class BetaCodeExecutionToolResultBlockParamContent: union` - `class BetaCodeExecutionToolResultErrorParam` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlockParam` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlockParam` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form, sent back in a later request. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` ### Beta Code Execution Tool Result Error - `class BetaCodeExecutionToolResultError` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` ### Beta Code Execution Tool Result Error Code - `enum BetaCodeExecutionToolResultErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` ### Beta Code Execution Tool Result Error Param - `class BetaCodeExecutionToolResultErrorParam` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` ### Beta Compact 20260112 Edit - `class BetaCompact20260112Edit` Automatically compact older context when reaching the configured trigger threshold. - `JsonElement Type = "compact_20260112"` - `string? Instructions` Additional instructions for summarization. - `bool PauseAfterCompaction` Whether to pause after compaction and return the compaction block to the user. - `BetaInputTokensTrigger? Trigger` When to trigger compaction. Defaults to 150000 input tokens. - `JsonElement Type = "input_tokens"` - `required long Value` minimum: 1 ### Beta Compaction Block - `class BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `JsonElement Type = "compaction"` - `required string? Content` Summary of compacted content, or null if compaction failed - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` Signature over the summary, to be sent back with the block verbatim - `IReadOnlyList? ToolChanges` 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. - `class 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `class 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. - `JsonElement Type = "tool_reference"` - `required string Name` - `class 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. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class 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. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaResponseToolUnion Definition` - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `class 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. - `class 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. - `class 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 - `class BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `JsonElement Type = "compaction"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `string? Content` Summary of previously compacted content, or null if compaction failed - `string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` The block's signature as returned, to be sent back verbatim - `IReadOnlyList? ToolChanges` 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. - `class BetaRequestToolAdditionBlock` 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolRemovalBlock` 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. ### Beta Compaction Config - `class BetaCompactionConfig` 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. - `JsonElement Type = "summarize"` - `string? Instructions` 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 - `class BetaCompactionContentBlockDelta` - `JsonElement Type = "compaction_delta"` - `required string? Content` - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim ### Beta Compaction Iteration Usage - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `JsonElement Type = "compaction"` Usage for a compaction iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 ### Beta Computer Cursor Position Config - `class BetaComputerCursorPositionConfig` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerCursorPositionInput:` Get the current (x, y) pixel coordinate of the cursor. ### Beta Computer Cursor Position Tool Use Block - `class BetaComputerCursorPositionToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerCursorPositionInput Input` Get the current (x, y) pixel coordinate of the cursor. - `JsonElement Name = "cursor_position"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Double Click Config - `class BetaComputerDoubleClickConfig` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerDoubleClickInput` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Double Click Tool Use Block - `class BetaComputerDoubleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerDoubleClickInput Input` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "double_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Hold Key Config - `class BetaComputerHoldKeyConfig` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerHoldKeyInput` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `required long Duration` Duration to hold the key, in seconds. maximum: 300 - `required string Text` The key or key-combination to hold. ### Beta Computer Hold Key Tool Use Block - `class BetaComputerHoldKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerHoldKeyInput Input` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `required long Duration` Duration to hold the key, in seconds. maximum: 300 - `required string Text` The key or key-combination to hold. - `JsonElement Name = "hold_key"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Key Config - `class BetaComputerKeyConfig` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class 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. - `required string Text` The key or key-combination to press. - `long? Repeat` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 ### Beta Computer Key Tool Use Block - `class BetaComputerKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerKeyInput Input` 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. - `required string Text` The key or key-combination to press. - `long? Repeat` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `JsonElement Name = "key"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Left Click Config - `class BetaComputerLeftClickConfig` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerLeftClickDragConfig` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerLeftClickDragInput` Click and drag the cursor from `start_coordinate` to `coordinate`. - `required IReadOnlyList Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `required IReadOnlyList StartCoordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Left Click Drag Tool Use Block - `class BetaComputerLeftClickDragToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftClickDragInput Input` Click and drag the cursor from `start_coordinate` to `coordinate`. - `required IReadOnlyList Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `required IReadOnlyList StartCoordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "left_click_drag"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Left Click Input - `class BetaComputerLeftClickInput` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Left Click Tool Use Block - `class BetaComputerLeftClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftClickInput Input` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "left_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Left Mouse Down Config - `class BetaComputerLeftMouseDownConfig` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerLeftMouseDownInput:` Press and hold the left mouse button at the current cursor position. ### Beta Computer Left Mouse Down Tool Use Block - `class BetaComputerLeftMouseDownToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftMouseDownInput Input` Press and hold the left mouse button at the current cursor position. - `JsonElement Name = "left_mouse_down"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Left Mouse Up Config - `class BetaComputerLeftMouseUpConfig` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerLeftMouseUpInput:` Release the left mouse button. ### Beta Computer Left Mouse Up Tool Use Block - `class BetaComputerLeftMouseUpToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftMouseUpInput Input` Release the left mouse button. - `JsonElement Name = "left_mouse_up"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Middle Click Config - `class BetaComputerMiddleClickConfig` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerMiddleClickInput` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Middle Click Tool Use Block - `class BetaComputerMiddleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerMiddleClickInput Input` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "middle_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Mouse Move Config - `class BetaComputerMouseMoveConfig` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerMouseMoveInput` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `required IReadOnlyList Coordinate` (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 - `class BetaComputerMouseMoveToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerMouseMoveInput Input` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `required IReadOnlyList Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `JsonElement Name = "mouse_move"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Right Click Config - `class BetaComputerRightClickConfig` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerRightClickInput` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Right Click Tool Use Block - `class BetaComputerRightClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerRightClickInput Input` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "right_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Screenshot Config - `class BetaComputerScreenshotConfig` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerScreenshotInput:` Take a screenshot of the screen. ### Beta Computer Screenshot Tool Use Block - `class BetaComputerScreenshotToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerScreenshotInput Input` Take a screenshot of the screen. - `JsonElement Name = "screenshot"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Scroll Config - `class BetaComputerScrollConfig` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `enum BetaComputerScrollDirection` - `Up("up")` - `Down("down")` - `Left("left")` - `Right("right")` ### Beta Computer Scroll Input - `class 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. - `required long ScrollAmount` Number of 'clicks' of the scroll wheel. - `required BetaComputerScrollDirection ScrollDirection` - `Up("up")` - `Down("down")` - `Left("left")` - `Right("right")` - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Scroll Tool Use Block - `class BetaComputerScrollToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerScrollInput Input` 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. - `required long ScrollAmount` Number of 'clicks' of the scroll wheel. - `required BetaComputerScrollDirection ScrollDirection` - `Up("up")` - `Down("down")` - `Left("left")` - `Right("right")` - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "scroll"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Tool Use Block - `class BetaComputerToolUseBlock: union` - `class BetaComputerKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerKeyInput Input` 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. - `required string Text` The key or key-combination to press. - `long? Repeat` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `JsonElement Name = "key"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaComputerHoldKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerHoldKeyInput Input` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `required long Duration` Duration to hold the key, in seconds. maximum: 300 - `required string Text` The key or key-combination to hold. - `JsonElement Name = "hold_key"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerTypeToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerTypeInput Input` Type a string of text on the keyboard. - `required string Text` The text to type. - `JsonElement Name = "type"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerCursorPositionToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerCursorPositionInput Input` Get the current (x, y) pixel coordinate of the cursor. - `JsonElement Name = "cursor_position"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerMouseMoveToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerMouseMoveInput Input` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `required IReadOnlyList Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `JsonElement Name = "mouse_move"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerLeftMouseDownToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftMouseDownInput Input` Press and hold the left mouse button at the current cursor position. - `JsonElement Name = "left_mouse_down"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerLeftMouseUpToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftMouseUpInput Input` Release the left mouse button. - `JsonElement Name = "left_mouse_up"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerLeftClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftClickInput Input` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "left_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerLeftClickDragToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftClickDragInput Input` Click and drag the cursor from `start_coordinate` to `coordinate`. - `required IReadOnlyList Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `required IReadOnlyList StartCoordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "left_click_drag"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerRightClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerRightClickInput Input` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "right_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerMiddleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerMiddleClickInput Input` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "middle_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerDoubleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerDoubleClickInput Input` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "double_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerTripleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerTripleClickInput Input` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "triple_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerScrollToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerScrollInput Input` 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. - `required long ScrollAmount` Number of 'clicks' of the scroll wheel. - `required BetaComputerScrollDirection ScrollDirection` - `Up("up")` - `Down("down")` - `Left("left")` - `Right("right")` - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "scroll"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerWaitToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerWaitInput Input` Wait for a specified duration. - `required long Duration` Duration to wait, in seconds. maximum: 300 - `JsonElement Name = "wait"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerScreenshotToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerScreenshotInput Input` Take a screenshot of the screen. - `JsonElement Name = "screenshot"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerZoomToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerZoomInput Input` 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. - `required IReadOnlyList Region` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 - `JsonElement Name = "zoom"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. ### Beta Computer Toolset 20260801 - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerToolsetConfigs` Per-member configuration for `computer_toolset_20260801`: one optional field per member tool, keyed by the member name — the same name the member's `tool_use` blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerTripleClickConfig` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerTripleClickInput` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). ### Beta Computer Triple Click Tool Use Block - `class BetaComputerTripleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerTripleClickInput Input` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "triple_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Type Config - `class BetaComputerTypeConfig` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerTypeInput` Type a string of text on the keyboard. - `required string Text` The text to type. ### Beta Computer Type Tool Use Block - `class BetaComputerTypeToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerTypeInput Input` Type a string of text on the keyboard. - `required string Text` The text to type. - `JsonElement Name = "type"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Wait Config - `class BetaComputerWaitConfig` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class BetaComputerWaitInput` Wait for a specified duration. - `required long Duration` Duration to wait, in seconds. maximum: 300 ### Beta Computer Wait Tool Use Block - `class BetaComputerWaitToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerWaitInput Input` Wait for a specified duration. - `required long Duration` Duration to wait, in seconds. maximum: 300 - `JsonElement Name = "wait"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Computer Zoom Config - `class BetaComputerZoomConfig` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered 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 - `class 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. - `required IReadOnlyList Region` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 ### Beta Computer Zoom Tool Use Block - `class BetaComputerZoomToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerZoomInput Input` 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. - `required IReadOnlyList Region` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 - `JsonElement Name = "zoom"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Container - `class BetaContainer` Information about the container used in the request (for the code execution tool) - `required string ID` Identifier for the container used in this request - `required DateTimeOffset ExpiresAt` The time at which the container will expire. format: date-time - `required IReadOnlyList? Skills` Skills loaded in the container - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `required string Version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 ### Beta Container Params - `class BetaContainerParams` Container parameters with skills to be loaded. - `string? ID` Container id - `IReadOnlyList? Skills` List of skills to load in the container maxItems: 20 - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `string Version` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 ### Beta Container Skill - `class BetaContainerSkill` A skill that was loaded in a container (response model). - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `required string Version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 ### Beta Container Upload Block - `class BetaContainerUploadBlock` Response model for a file uploaded to the container. - `JsonElement Type = "container_upload"` - `required string FileID` ### Beta Container Upload Block Param - `class BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonElement Type = "container_upload"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` ### Beta Content Block - `class BetaContentBlock: union` - `class BetaTextBlock` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `required string Text` - `class BetaThinkingBlock` - `JsonElement Type = "thinking"` - `required string Signature` 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=csharp) for details. - `required string Thinking` The text of Claude's thinking process for this block. - `class BetaRedactedThinkingBlock` - `JsonElement Type = "redacted_thinking"` - `required string Data` 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=csharp#redacted-thinking-blocks) for details. - `class BetaToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1 - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlock` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlock` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockContent Content` - `class BetaWebSearchToolResultError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string? PageAge` - `required string Title` - `required string Url` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlock` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlock` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlock` - `JsonElement Type = "web_fetch_result"` - `required BetaDocumentBlock Content` - `JsonElement Type = "document"` - `required BetaCitationConfig? Citations` Citation configuration for the document - `required bool Enabled` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `required string? Title` The title of the document - `required string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string Url` Fetched content URL - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlock` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultError` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlock` - `JsonElement Type = "advisor_result"` - `required string? StopReason` 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. - `required string Text` - `class BetaAdvisorRedactedResultBlock` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `required string? StopReason` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaCodeExecutionToolResultBlock` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockContent Content` - `class BetaCodeExecutionToolResultError` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlock` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlock` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form. The API returns this block in place of `code_execution_result` when the code called the web search tool. See the [programmatic tool calling guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling?sdk_languages=csharp) to learn more about programmatic tool calling. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaBashCodeExecutionToolResultBlock` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultError` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlock` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaTextEditorCodeExecutionToolResultBlock` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultError` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `required string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlock` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `required long? NumLines` - `required long? StartLine` - `required long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlock` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlock` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `required IReadOnlyList? Lines` - `required long? NewLines` - `required long? NewStart` - `required long? OldLines` - `required long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaToolSearchToolResultBlock` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultError` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `required string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlock` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaMcpToolUseBlock` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` The name of the MCP tool - `required string ServerName` The name of the MCP server - `class BetaMcpToolResultBlock` - `JsonElement Type = "mcp_tool_result"` - `required Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` 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`. - `required string Text` - `required bool IsError` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `class BetaContainerUploadBlock` Response model for a file uploaded to the container. - `JsonElement Type = "container_upload"` - `required string FileID` - `class BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `JsonElement Type = "compaction"` - `required string? Content` Summary of compacted content, or null if compaction failed - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` Signature over the summary, to be sent back with the block verbatim - `IReadOnlyList? ToolChanges` 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. - `class 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `class 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. - `JsonElement Type = "tool_reference"` - `required string Name` - `class 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. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class 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. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaResponseToolUnion Definition` - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `class 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. - `class 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. - `class 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. - `class BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `JsonElement Type = "fallback"` - `required BetaFallbackInfo From` 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. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfo To` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `required BetaFallbackRefusalTrigger Trigger` What caused the `from` model to hand over at this hop. - `JsonElement Type = "refusal"` - `required BetaFallbackRefusalTriggerCategory? Category` The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` - `required IReadOnlyList Tools` - `required IReadOnlyDictionary InputSchema` - `required string Name` - `string Description` ### Beta Content Block Param - `class BetaContentBlockParam: union` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaRequestDocumentBlock` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `bool Enabled` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 - `class BetaSearchResultBlockParam` - `JsonElement Type = "search_result"` - `required IReadOnlyList Content` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `required string Source` - `required string Title` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam Citations` - `class BetaThinkingBlockParam` - `JsonElement Type = "thinking"` - `required string Signature` 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`. - `required string Thinking` The `thinking` text of this block as returned by the API. - `class BetaRedactedThinkingBlockParam` - `JsonElement Type = "redacted_thinking"` - `required string Data` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `class BetaToolUseBlockParam` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1, maxLength: 200 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaToolResultBlockParam` - `JsonElement Type = "tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaSearchResultBlockParam` - `class BetaRequestDocumentBlock` - `class BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonElement Type = "browser_state"` - `required IReadOnlyList Tabs` 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 - `required string TabID` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool Active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? StateChanges` 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 - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool IsError` - `string? ToolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlockParam` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlockParam` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockParamContent Content` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string Title` - `required string Url` - `string? PageAge` - `class BetaWebSearchToolRequestError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlockParam` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlockParam` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlockParam` - `JsonElement Type = "web_fetch_result"` - `required BetaRequestDocumentBlock Content` - `required string Url` Fetched content URL - `string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlockParam` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultErrorParam` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlockParam` - `JsonElement Type = "advisor_result"` - `required string Text` - `string? StopReason` - `class BetaAdvisorRedactedResultBlockParam` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob produced by a prior response; must be round-tripped verbatim. - `string? StopReason` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCodeExecutionToolResultBlockParam` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockParamContent Content` - `class BetaCodeExecutionToolResultErrorParam` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlockParam` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlockParam` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form, sent back in a later request. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBashCodeExecutionToolResultBlockParam` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultErrorParam` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlockParam` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaTextEditorCodeExecutionToolResultBlockParam` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultErrorParam` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlockParam` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `long? NumLines` - `long? StartLine` - `long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlockParam` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `IReadOnlyList? Lines` - `long? NewLines` - `long? NewStart` - `long? OldLines` - `long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaToolSearchToolResultBlockParam` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultErrorParam` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlockParam` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaMcpToolUseBlockParam` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` - `required string ServerName` The name of the MCP server - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestMcpToolResultBlockParam` - `JsonElement Type = "mcp_tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `bool IsError` - `class BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonElement Type = "container_upload"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `JsonElement Type = "compaction"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `string? Content` Summary of previously compacted content, or null if compaction failed - `string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` The block's signature as returned, to be sent back verbatim - `IReadOnlyList? ToolChanges` 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. - `class BetaRequestToolAdditionBlock` 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolRemovalBlock` 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `required IReadOnlyList Tools` The server's tools, exactly as the response listed them. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `JsonElement Type = "fallback"` - `required BetaFallbackInfoParam From` Identifies one hop of a fallback transition. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfoParam To` Identifies one hop of a fallback transition. - `JsonElement Trigger` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. ### Beta Content Block Source - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` ### Beta Content Block Source Content - `class BetaContentBlockSourceContent: union` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` ### Beta Context Management Config - `class BetaContextManagementConfig` - `IReadOnlyList Edits` List of context management edits to apply - `class BetaClearToolUses20250919Edit` - `JsonElement Type = "clear_tool_uses_20250919"` - `BetaInputTokensClearAtLeast? ClearAtLeast` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `JsonElement Type = "input_tokens"` - `required long Value` minimum: 0 - `ClearToolInputs? ClearToolInputs` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `bool` - `IReadOnlyList` - `IReadOnlyList? ExcludeTools` Tool names whose uses are preserved from clearing - `BetaToolUsesKeep Keep` Number of tool uses to retain in the conversation - `JsonElement Type = "tool_uses"` - `required long Value` minimum: 0 - `Trigger Trigger` Condition that triggers the context management strategy - `class BetaInputTokensTrigger` - `JsonElement Type = "input_tokens"` - `required long Value` minimum: 1 - `class BetaToolUsesTrigger` - `JsonElement Type = "tool_uses"` - `required long Value` minimum: 1 - `class BetaClearThinking20251015Edit` - `JsonElement Type = "clear_thinking_20251015"` - `Keep Keep` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `class BetaThinkingTurns` - `JsonElement Type = "thinking_turns"` - `required long Value` minimum: 1 - `class BetaAllThinkingTurns` - `JsonElement Type = "all"` - `class All:` - `class BetaCompact20260112Edit` Automatically compact older context when reaching the configured trigger threshold. - `JsonElement Type = "compact_20260112"` - `string? Instructions` Additional instructions for summarization. - `bool PauseAfterCompaction` Whether to pause after compaction and return the compaction block to the user. - `BetaInputTokensTrigger? Trigger` When to trigger compaction. Defaults to 150000 input tokens. ### Beta Context Management Response - `class BetaContextManagementResponse` - `required IReadOnlyList AppliedEdits` List of context management edits that were applied. - `class BetaClearToolUses20250919EditResponse` - `JsonElement Type = "clear_tool_uses_20250919"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedToolUses` Number of tool uses that were cleared. minimum: 0 - `class BetaClearThinking20251015EditResponse` - `JsonElement Type = "clear_thinking_20251015"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedThinkingTurns` Number of thinking turns that were cleared. minimum: 0 ### Beta Count Tokens Context Management Response - `class BetaCountTokensContextManagementResponse` - `required long OriginalInputTokens` The original token count before context management was applied ### Beta Diagnostics - `class BetaDiagnostics` Request-level diagnostics: why the prompt cache could not fully reuse the prefix of the request named by `diagnostics.previous_message_id`. - `required BetaCacheMissReason? CacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class BetaCacheMissModelChanged` A `cache_miss_reason` for a request whose `model` or `speed` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "model_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissSystemChanged` A `cache_miss_reason` for a request whose `system` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "system_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissToolsChanged` A `cache_miss_reason` for a request whose `tools` differ from the previous request's, for example because tools were added, removed, or reordered. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "tools_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissMessagesChanged` A `cache_miss_reason` for a request whose `messages` differ from the previous request's in an earlier entry, instead of only having entries appended. The `model`, `system`, and `tools` match. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "messages_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissPreviousMessageNotFound` A `cache_miss_reason` for when the API doesn't have a stored record of the request that `diagnostics.previous_message_id` references. This doesn't mean that this request changed. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "previous_message_not_found"` - `class BetaCacheMissUnavailable` A `cache_miss_reason` for when the API can't give a diagnosis. The request itself was processed normally. This includes a request whose `model`, `system`, and `tools` match the previous request's but whose other prompt-affecting parameters, such as `thinking` or `tool_choice`, differ. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "unavailable"` ### Beta Diagnostics Param - `class BetaDiagnosticsParam` Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting. - `string? PreviousMessageID` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. maxLength: 256 ### Beta Direct Caller - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` ### Beta Document Block - `class BetaDocumentBlock` - `JsonElement Type = "document"` - `required BetaCitationConfig? Citations` Citation configuration for the document - `required bool Enabled` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `required string? Title` The title of the document ### Beta Encrypted Code Execution Result Block - `class BetaEncryptedCodeExecutionResultBlock` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form. The API returns this block in place of `code_execution_result` when the code called the web search tool. See the [programmatic tool calling guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling?sdk_languages=csharp) to learn more about programmatic tool calling. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` ### Beta Encrypted Code Execution Result Block Param - `class BetaEncryptedCodeExecutionResultBlockParam` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form, sent back in a later request. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` ### Beta Fallback Block - `class BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `JsonElement Type = "fallback"` - `required BetaFallbackInfo From` 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. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `required BetaFallbackInfo To` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `required BetaFallbackRefusalTrigger Trigger` What caused the `from` model to hand over at this hop. - `JsonElement Type = "refusal"` - `required BetaFallbackRefusalTriggerCategory? Category` The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("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 - `class BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `JsonElement Type = "fallback"` - `required BetaFallbackInfoParam From` Identifies one hop of a fallback transition. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `required BetaFallbackInfoParam To` Identifies one hop of a fallback transition. - `JsonElement Trigger` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. ### Beta Fallback Credit Not Applied - `class BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `JsonElement Type = "not_applied"` - `required Reason Reason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `BodyMismatch("body_mismatch")` - `ContinuationExcluded("continuation_excluded")` - `ContinuationOnly("continuation_only")` - `Expired("expired")` - `InvalidTargetModel("invalid_target_model")` - `NotEnabled("not_enabled")` - `RepriceUnavailable("reprice_unavailable")` - `TemporarilyUnavailable("temporarily_unavailable")` - `VariantFieldsPresent("variant_fields_present")` - `WrongOrganization("wrong_organization")` - `WrongPlatform("wrong_platform")` - `WrongWorkspace("wrong_workspace")` - `IReadOnlyList? RemoveToRedeem` 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 - `class BetaFallbackCreditRedeemed` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `JsonElement Type = "redeemed"` ### Beta Fallback Credit Token Param - `class BetaFallbackCreditTokenParam` Object form of `fallback_credit_token`: the token plus a redemption mode. Requires `anthropic-beta: fallback-credit-2026-07-01`; without that header the field accepts the bare string only. The bare string and the mode-less object are equivalent (both select `strict`), so wrapping an existing token changes nothing by itself. - `required string Token` 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 Mode` 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`. - `Strict("strict")` - `BestEffort("best_effort")` ### Beta Fallback Credit Usage - `class BetaFallbackCreditUsage` Outcome of the `fallback_credit_token` presented on this request. - `required Status Status` Whether the fallback-credit reprice was applied to this response's billing. A union discriminated on `type`. `redeemed`: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - `class BetaFallbackCreditRedeemed` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `JsonElement Type = "redeemed"` - `class BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `JsonElement Type = "not_applied"` - `required Reason Reason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `BodyMismatch("body_mismatch")` - `ContinuationExcluded("continuation_excluded")` - `ContinuationOnly("continuation_only")` - `Expired("expired")` - `InvalidTargetModel("invalid_target_model")` - `NotEnabled("not_enabled")` - `RepriceUnavailable("reprice_unavailable")` - `TemporarilyUnavailable("temporarily_unavailable")` - `VariantFieldsPresent("variant_fields_present")` - `WrongOrganization("wrong_organization")` - `WrongPlatform("wrong_platform")` - `WrongWorkspace("wrong_workspace")` - `IReadOnlyList? RemoveToRedeem` 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 - `class BetaFallbackInfo` Identifies one hop of a fallback transition. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `class BetaFallbackInfoParam` Identifies one hop of a fallback transition. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `class 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`. - `JsonElement Type = "fallback_message"` Usage for the fallback-model attempt that served the response - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 ### Beta Fallback Param - `class BetaFallbackParam` One entry in the `fallbacks` chain on a `/v1/messages` request. `model` is required. The override fields (`max_tokens`, `thinking`, `output_config`, and `speed`) set the corresponding parameter for this attempt only and are validated as if the request were made to `model`. Any other key is rejected at parse time. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `long? MaxTokens` The `max_tokens` for the fallback attempt that uses this `fallbacks` entry's `model`, in place of the request's `max_tokens`. If you leave it out or set it to `null`, the attempt uses the request's `max_tokens`. See the [refusals and fallback guide](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=csharp#naming-your-own-fallback-models) to learn more about fallback entries. - `BetaOutputConfig? OutputConfig` Output parameters for the fallback attempt that uses this `fallbacks` entry's `model`, combined with the request's `output_config` one field at a time. - `format`: If you leave it out, the attempt uses the request's `format`. If you set it to `null`, the attempt runs without a format. - `effort`: If you leave it out, the attempt uses the request's `effort` when `model` supports that level with the attempt's `thinking`. If the request doesn't set `effort`, if `model` doesn't support the level, or if you set `effort` to `null`, the attempt runs at the default effort of `model`. - `task_budget`: If you leave it out, the attempt uses the request's `task_budget` when `model` accepts a task budget of that size. If the request doesn't set `task_budget`, if `model` doesn't accept it, or if you set `task_budget` to `null`, the attempt runs without a task budget. Set `output_config` to `null` to run the attempt without a format or a task budget, at the default effort of `model`. These rules apply with the `server-side-fallback-2026-07-01` beta header. - `Effort? Effort` 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`. - `Low("low")` - `Medium("medium")` - `High("high")` - `Xhigh("xhigh")` - `Max("max")` - `BetaJsonOutputFormat? Format` 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=csharp) - `JsonElement Type = "json_schema"` - `required IReadOnlyDictionary Schema` The JSON schema of the format - `BetaTokenTaskBudget? TaskBudget` Configuration for token budget tracking across contexts. - `JsonElement Type = "tokens"` The budget type. Currently only 'tokens' is supported. - `required long Total` Total token budget across all contexts in the session. minimum: 1024 - `long? Remaining` 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? Speed` The inference speed mode for the fallback attempt that uses this `fallbacks` entry's `model`. If you leave it out, the attempt runs at `fast` speed only when the request sets `speed` to `fast` and your organization can use fast mode on `model`. Otherwise, or when you set this field to `null`, the attempt runs at `standard` speed. These rules apply with the `server-side-fallback-2026-07-01` beta header. - `Standard("standard")` - `Fast("fast")` - `Thinking? Thinking` The thinking configuration for the fallback attempt that uses this `fallbacks` entry's `model`. If you leave it out, the attempt uses the request's `thinking` when `model` supports that thinking `type`. If you leave it out and the request's thinking `type` is `between_tools` but `model` doesn't support `between_tools`, the attempt uses `disabled` if `model` supports it. Otherwise, if `model` doesn't support the request's thinking `type`, if the request doesn't set `thinking`, or if you set this field to `null`, the attempt uses the thinking `type` that `model` uses when a request leaves out `thinking`. The request's `thinking.display` still applies where `model` allows it. These rules apply with the `server-side-fallback-2026-07-01` beta header. - `class BetaThinkingConfigEnabled` - `JsonElement Type = "enabled"` - `required long BudgetTokens` 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=csharp) for details. minimum: 1024 - `BetaThinkingBlockBinding? BlockBinding` 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. - `BetaThinkingPrefixMismatchBehavior? PrefixMismatchBehavior` "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`. - `Error("error")` - `DropBlock("drop_block")` - `Display? Display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#controlling-thinking-display). - `Summarized("summarized")` - `Omitted("omitted")` - `Updates("updates")` - `class BetaThinkingConfigDisabled` - `JsonElement Type = "disabled"` - `class BetaThinkingConfigBetweenTools` - `JsonElement Type = "between_tools"` - `class BetaThinkingConfigAdaptive` - `JsonElement Type = "adaptive"` - `BetaThinkingBlockBinding? BlockBinding` 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? Display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#controlling-thinking-display). - `Summarized("summarized")` - `Omitted("omitted")` - `Updates("updates")` ### Beta Fallback Refusal Trigger - `class BetaFallbackRefusalTrigger` The `from` model declined for policy reasons. - `JsonElement Type = "refusal"` - `required BetaFallbackRefusalTriggerCategory? Category` The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("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 - `class BetaFallbacksParam: union` 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=csharp#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. - `IReadOnlyList` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `long? MaxTokens` The `max_tokens` for the fallback attempt that uses this `fallbacks` entry's `model`, in place of the request's `max_tokens`. If you leave it out or set it to `null`, the attempt uses the request's `max_tokens`. See the [refusals and fallback guide](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=csharp#naming-your-own-fallback-models) to learn more about fallback entries. - `BetaOutputConfig? OutputConfig` Output parameters for the fallback attempt that uses this `fallbacks` entry's `model`, combined with the request's `output_config` one field at a time. - `format`: If you leave it out, the attempt uses the request's `format`. If you set it to `null`, the attempt runs without a format. - `effort`: If you leave it out, the attempt uses the request's `effort` when `model` supports that level with the attempt's `thinking`. If the request doesn't set `effort`, if `model` doesn't support the level, or if you set `effort` to `null`, the attempt runs at the default effort of `model`. - `task_budget`: If you leave it out, the attempt uses the request's `task_budget` when `model` accepts a task budget of that size. If the request doesn't set `task_budget`, if `model` doesn't accept it, or if you set `task_budget` to `null`, the attempt runs without a task budget. Set `output_config` to `null` to run the attempt without a format or a task budget, at the default effort of `model`. These rules apply with the `server-side-fallback-2026-07-01` beta header. - `Effort? Effort` 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`. - `Low("low")` - `Medium("medium")` - `High("high")` - `Xhigh("xhigh")` - `Max("max")` - `BetaJsonOutputFormat? Format` 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=csharp) - `JsonElement Type = "json_schema"` - `required IReadOnlyDictionary Schema` The JSON schema of the format - `BetaTokenTaskBudget? TaskBudget` Configuration for token budget tracking across contexts. - `JsonElement Type = "tokens"` The budget type. Currently only 'tokens' is supported. - `required long Total` Total token budget across all contexts in the session. minimum: 1024 - `long? Remaining` 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? Speed` The inference speed mode for the fallback attempt that uses this `fallbacks` entry's `model`. If you leave it out, the attempt runs at `fast` speed only when the request sets `speed` to `fast` and your organization can use fast mode on `model`. Otherwise, or when you set this field to `null`, the attempt runs at `standard` speed. These rules apply with the `server-side-fallback-2026-07-01` beta header. - `Standard("standard")` - `Fast("fast")` - `Thinking? Thinking` The thinking configuration for the fallback attempt that uses this `fallbacks` entry's `model`. If you leave it out, the attempt uses the request's `thinking` when `model` supports that thinking `type`. If you leave it out and the request's thinking `type` is `between_tools` but `model` doesn't support `between_tools`, the attempt uses `disabled` if `model` supports it. Otherwise, if `model` doesn't support the request's thinking `type`, if the request doesn't set `thinking`, or if you set this field to `null`, the attempt uses the thinking `type` that `model` uses when a request leaves out `thinking`. The request's `thinking.display` still applies where `model` allows it. These rules apply with the `server-side-fallback-2026-07-01` beta header. - `class BetaThinkingConfigEnabled` - `JsonElement Type = "enabled"` - `required long BudgetTokens` 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=csharp) for details. minimum: 1024 - `BetaThinkingBlockBinding? BlockBinding` 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. - `BetaThinkingPrefixMismatchBehavior? PrefixMismatchBehavior` "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`. - `Error("error")` - `DropBlock("drop_block")` - `Display? Display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#controlling-thinking-display). - `Summarized("summarized")` - `Omitted("omitted")` - `Updates("updates")` - `class BetaThinkingConfigDisabled` - `JsonElement Type = "disabled"` - `class BetaThinkingConfigBetweenTools` - `JsonElement Type = "between_tools"` - `class BetaThinkingConfigAdaptive` - `JsonElement Type = "adaptive"` - `BetaThinkingBlockBinding? BlockBinding` 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? Display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#controlling-thinking-display). - `Summarized("summarized")` - `Omitted("omitted")` - `Updates("updates")` - `JsonElement` ### Beta File Document Source - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` ### Beta File Image Source - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` ### Beta Image Block Param - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` ### Beta Image Transformations Param - `class BetaImageTransformationsParam` Configures the transformations the server applies to this image before the model observes it. Each key names a condition the server transforms images for; its value selects the transformation applied. Omitted keys keep their default behavior, and an empty object is equivalent to omitting the field. - `OversizedImage OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` ### Beta Input JSON Delta - `class BetaInputJsonDelta` - `JsonElement Type = "input_json_delta"` - `required string PartialJson` ### Beta Input Tokens Clear At Least - `class BetaInputTokensClearAtLeast` - `JsonElement Type = "input_tokens"` - `required long Value` minimum: 0 ### Beta Input Tokens Trigger - `class BetaInputTokensTrigger` - `JsonElement Type = "input_tokens"` - `required long Value` minimum: 1 ### Beta Input Transformation - `class BetaInputTransformation: union` 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. - `class BetaThinkingDroppedInputTransformation` - `JsonElement Type = "thinking_dropped"` Always `thinking_dropped` for this entry type. - `required string Path` 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. - `required Reason Reason` 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`. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` - `class BetaThinkingMismatchAllowedInputTransformation` - `JsonElement Type = "thinking_mismatch_allowed"` Always `thinking_mismatch_allowed` for this entry type. - `required string Path` 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. - `required Reason Reason` 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. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` ### Beta JSON Output Format - `class BetaJsonOutputFormat` - `JsonElement Type = "json_schema"` - `required IReadOnlyDictionary Schema` The JSON schema of the format ### Beta MCP Tool - `class BetaMcpTool` A tool as an MCP server lists it: its name on that server, its description, and its input schema. - `required IReadOnlyDictionary InputSchema` - `required string Name` - `string Description` ### Beta MCP Tool Config - `class BetaMcpToolConfig` Configuration for a specific tool in an MCP toolset. - `bool DeferLoading` - `bool Enabled` ### Beta MCP Tool Default Config - `class BetaMcpToolDefaultConfig` Default configuration for tools in an MCP toolset. - `bool DeferLoading` - `bool Enabled` ### Beta MCP Tool Listing Block - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` - `required IReadOnlyList Tools` - `required IReadOnlyDictionary InputSchema` - `required string Name` - `string Description` ### Beta MCP Tool Listing Block Param - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `required IReadOnlyList Tools` The server's tools, exactly as the response listed them. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. ### Beta MCP Tool Param - `class BetaMcpToolParam` A tool as an MCP server lists it: its name on that server, its description, and its input schema. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. ### Beta MCP Tool Result Block - `class BetaMcpToolResultBlock` - `JsonElement Type = "mcp_tool_result"` - `required Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `required string Text` - `required bool IsError` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ ### Beta MCP Tool Use Block - `class BetaMcpToolUseBlock` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` The name of the MCP tool - `required string ServerName` The name of the MCP server ### Beta MCP Tool Use Block Param - `class BetaMcpToolUseBlockParam` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` - `required string ServerName` The name of the MCP server - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` ### Beta MCP Toolset - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. ### Beta Memory Tool 20250818 - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Memory Tool 20250818 Command - `class BetaMemoryTool20250818Command: union` - `class BetaMemoryTool20250818ViewCommand` - `JsonElement Command = "view"` Command type identifier - `required string Path` Path to directory or file to view - `IReadOnlyList ViewRange` Optional line range for viewing specific lines minItems: 2, maxItems: 2 - `class BetaMemoryTool20250818CreateCommand` - `JsonElement Command = "create"` Command type identifier - `required string FileText` Content to write to the file - `required string Path` Path where the file should be created - `class BetaMemoryTool20250818StrReplaceCommand` - `JsonElement Command = "str_replace"` Command type identifier - `required string NewStr` Text to replace with - `required string OldStr` Text to search for and replace - `required string Path` Path to the file where text should be replaced - `class BetaMemoryTool20250818InsertCommand` - `JsonElement Command = "insert"` Command type identifier - `required long InsertLine` Line number where text should be inserted minimum: 1 - `required string InsertText` Text to insert at the specified line - `required string Path` Path to the file where text should be inserted - `class BetaMemoryTool20250818DeleteCommand` - `JsonElement Command = "delete"` Command type identifier - `required string Path` Path to the file or directory to delete - `class BetaMemoryTool20250818RenameCommand` - `JsonElement Command = "rename"` Command type identifier - `required string NewPath` New path for the file or directory - `required string OldPath` Current path of the file or directory ### Beta Memory Tool 20250818 Create Command - `class BetaMemoryTool20250818CreateCommand` - `JsonElement Command = "create"` Command type identifier - `required string FileText` Content to write to the file - `required string Path` Path where the file should be created ### Beta Memory Tool 20250818 Delete Command - `class BetaMemoryTool20250818DeleteCommand` - `JsonElement Command = "delete"` Command type identifier - `required string Path` Path to the file or directory to delete ### Beta Memory Tool 20250818 Insert Command - `class BetaMemoryTool20250818InsertCommand` - `JsonElement Command = "insert"` Command type identifier - `required long InsertLine` Line number where text should be inserted minimum: 1 - `required string InsertText` Text to insert at the specified line - `required string Path` Path to the file where text should be inserted ### Beta Memory Tool 20250818 Rename Command - `class BetaMemoryTool20250818RenameCommand` - `JsonElement Command = "rename"` Command type identifier - `required string NewPath` New path for the file or directory - `required string OldPath` Current path of the file or directory ### Beta Memory Tool 20250818 Str Replace Command - `class BetaMemoryTool20250818StrReplaceCommand` - `JsonElement Command = "str_replace"` Command type identifier - `required string NewStr` Text to replace with - `required string OldStr` Text to search for and replace - `required string Path` Path to the file where text should be replaced ### Beta Memory Tool 20250818 View Command - `class BetaMemoryTool20250818ViewCommand` - `JsonElement Command = "view"` Command type identifier - `required string Path` Path to directory or file to view - `IReadOnlyList ViewRange` Optional line range for viewing specific lines minItems: 2, maxItems: 2 ### Beta Message - `class BetaMessage` - `JsonElement Type = "message"` Object type. For Messages, this is always `"message"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required BetaContainer? Container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `required string ID` Identifier for the container used in this request - `required DateTimeOffset ExpiresAt` The time at which the container will expire. format: date-time - `required IReadOnlyList? Skills` Skills loaded in the container - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `required string Version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `required IReadOnlyList Content` 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)"}] ``` - `class BetaTextBlock` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `required string Text` - `class BetaThinkingBlock` - `JsonElement Type = "thinking"` - `required string Signature` 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=csharp) for details. - `required string Thinking` The text of Claude's thinking process for this block. - `class BetaRedactedThinkingBlock` - `JsonElement Type = "redacted_thinking"` - `required string Data` 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=csharp#redacted-thinking-blocks) for details. - `class BetaToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1 - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlock` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlock` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockContent Content` - `class BetaWebSearchToolResultError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string? PageAge` - `required string Title` - `required string Url` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlock` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlock` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlock` - `JsonElement Type = "web_fetch_result"` - `required BetaDocumentBlock Content` - `JsonElement Type = "document"` - `required BetaCitationConfig? Citations` Citation configuration for the document - `required bool Enabled` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `required string? Title` The title of the document - `required string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string Url` Fetched content URL - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlock` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultError` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlock` - `JsonElement Type = "advisor_result"` - `required string? StopReason` 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. - `required string Text` - `class BetaAdvisorRedactedResultBlock` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `required string? StopReason` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaCodeExecutionToolResultBlock` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockContent Content` - `class BetaCodeExecutionToolResultError` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlock` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlock` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form. The API returns this block in place of `code_execution_result` when the code called the web search tool. See the [programmatic tool calling guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling?sdk_languages=csharp) to learn more about programmatic tool calling. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaBashCodeExecutionToolResultBlock` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultError` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlock` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaTextEditorCodeExecutionToolResultBlock` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultError` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `required string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlock` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `required long? NumLines` - `required long? StartLine` - `required long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlock` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlock` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `required IReadOnlyList? Lines` - `required long? NewLines` - `required long? NewStart` - `required long? OldLines` - `required long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaToolSearchToolResultBlock` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultError` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `required string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlock` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaMcpToolUseBlock` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` The name of the MCP tool - `required string ServerName` The name of the MCP server - `class BetaMcpToolResultBlock` - `JsonElement Type = "mcp_tool_result"` - `required Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` 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`. - `required string Text` - `required bool IsError` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `class BetaContainerUploadBlock` Response model for a file uploaded to the container. - `JsonElement Type = "container_upload"` - `required string FileID` - `class BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `JsonElement Type = "compaction"` - `required string? Content` Summary of compacted content, or null if compaction failed - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` Signature over the summary, to be sent back with the block verbatim - `IReadOnlyList? ToolChanges` 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. - `class 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `class 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. - `JsonElement Type = "tool_reference"` - `required string Name` - `class 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. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class 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. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaResponseToolUnion Definition` - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `class 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. - `class 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. - `class 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. - `class BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `JsonElement Type = "fallback"` - `required BetaFallbackInfo From` 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. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfo To` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `required BetaFallbackRefusalTrigger Trigger` What caused the `from` model to hand over at this hop. - `JsonElement Type = "refusal"` - `required BetaFallbackRefusalTriggerCategory? Category` The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` - `required IReadOnlyList Tools` - `required IReadOnlyDictionary InputSchema` - `required string Name` - `string Description` - `required BetaContextManagementResponse? ContextManagement` Context management response. Information about context management strategies applied during the request. - `required IReadOnlyList AppliedEdits` List of context management edits that were applied. - `class BetaClearToolUses20250919EditResponse` - `JsonElement Type = "clear_tool_uses_20250919"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedToolUses` Number of tool uses that were cleared. minimum: 0 - `class BetaClearThinking20251015EditResponse` - `JsonElement Type = "clear_thinking_20251015"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedThinkingTurns` Number of thinking turns that were cleared. minimum: 0 - `required BetaDiagnostics? Diagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `required BetaCacheMissReason? CacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class BetaCacheMissModelChanged` A `cache_miss_reason` for a request whose `model` or `speed` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "model_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissSystemChanged` A `cache_miss_reason` for a request whose `system` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "system_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissToolsChanged` A `cache_miss_reason` for a request whose `tools` differ from the previous request's, for example because tools were added, removed, or reordered. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "tools_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissMessagesChanged` A `cache_miss_reason` for a request whose `messages` differ from the previous request's in an earlier entry, instead of only having entries appended. The `model`, `system`, and `tools` match. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "messages_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissPreviousMessageNotFound` A `cache_miss_reason` for when the API doesn't have a stored record of the request that `diagnostics.previous_message_id` references. This doesn't mean that this request changed. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "previous_message_not_found"` - `class BetaCacheMissUnavailable` A `cache_miss_reason` for when the API can't give a diagnosis. The request itself was processed normally. This includes a request whose `model`, `system`, and `tools` match the previous request's but whose other prompt-affecting parameters, such as `thinking` or `tool_choice`, differ. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "unavailable"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `JsonElement Role = "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `required BetaRefusalStopDetails? StopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonElement Type = "refusal"` - `required Category? Category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `required string? Explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `required string? FallbackCreditToken` 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. - `required bool? FallbackHasPrefillClaim` 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. - `required string? RecommendedModel` 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. - `required BetaStopReason? StopReason` 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. - `EndTurn("end_turn")` - `MaxTokens("max_tokens")` - `StopSequence("stop_sequence")` - `ToolUse("tool_use")` - `PauseTurn("pause_turn")` - `Compaction("compaction")` - `Refusal("refusal")` - `ModelContextWindowExceeded("model_context_window_exceeded")` - `required string? StopSequence` 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. - `required BetaUsage Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long? CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long? CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required BetaFallbackCreditUsage? FallbackCredit` 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). - `required Status Status` Whether the fallback-credit reprice was applied to this response's billing. A union discriminated on `type`. `redeemed`: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - `class BetaFallbackCreditRedeemed` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `JsonElement Type = "redeemed"` - `class BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `JsonElement Type = "not_applied"` - `required Reason Reason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `BodyMismatch("body_mismatch")` - `ContinuationExcluded("continuation_excluded")` - `ContinuationOnly("continuation_only")` - `Expired("expired")` - `InvalidTargetModel("invalid_target_model")` - `NotEnabled("not_enabled")` - `RepriceUnavailable("reprice_unavailable")` - `TemporarilyUnavailable("temporarily_unavailable")` - `VariantFieldsPresent("variant_fields_present")` - `WrongOrganization("wrong_organization")` - `WrongPlatform("wrong_platform")` - `WrongWorkspace("wrong_workspace")` - `IReadOnlyList? RemoveToRedeem` 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. - `required string? InferenceGeo` The geographic region where inference was performed for this request. - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required IReadOnlyList? Iterations` 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. - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `JsonElement Type = "message"` Usage for a sampling iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model? Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `JsonElement Type = "compaction"` Usage for a compaction iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `JsonElement Type = "advisor_message"` Usage for an advisor sub-inference iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class 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`. - `JsonElement Type = "fallback_message"` Usage for the fallback-model attempt that served the response - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required BetaOutputTokensDetails? OutputTokensDetails` 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. - `required long ThinkingTokens` 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. minimum: 0 - `required BetaServerToolUsage? ServerToolUse` The number of server tool requests. - `required long WebFetchRequests` The number of web fetch tool requests. minimum: 0 - `required long WebSearchRequests` The number of web search tool requests. minimum: 0 - `required ServiceTier? ServiceTier` If the request used the priority, standard, or batch tier. - `Standard("standard")` - `Priority("priority")` - `Batch("batch")` - `required Speed? Speed` The inference speed mode used for this request. - `Standard("standard")` - `Fast("fast")` - `IReadOnlyList? InputTransformations` 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`. - `class BetaThinkingDroppedInputTransformation` - `JsonElement Type = "thinking_dropped"` Always `thinking_dropped` for this entry type. - `required string Path` 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. - `required Reason Reason` 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`. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` - `class BetaThinkingMismatchAllowedInputTransformation` - `JsonElement Type = "thinking_mismatch_allowed"` Always `thinking_mismatch_allowed` for this entry type. - `required string Path` 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. - `required Reason Reason` 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. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` ### Beta Message Content Param - `class BetaMessageContentParam: union` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaRequestDocumentBlock` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `bool Enabled` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 - `class BetaSearchResultBlockParam` - `JsonElement Type = "search_result"` - `required IReadOnlyList Content` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `required string Source` - `required string Title` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam Citations` - `class BetaThinkingBlockParam` - `JsonElement Type = "thinking"` - `required string Signature` 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`. - `required string Thinking` The `thinking` text of this block as returned by the API. - `class BetaRedactedThinkingBlockParam` - `JsonElement Type = "redacted_thinking"` - `required string Data` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `class BetaToolUseBlockParam` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1, maxLength: 200 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaToolResultBlockParam` - `JsonElement Type = "tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaSearchResultBlockParam` - `class BetaRequestDocumentBlock` - `class BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonElement Type = "browser_state"` - `required IReadOnlyList Tabs` 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 - `required string TabID` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool Active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? StateChanges` 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 - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool IsError` - `string? ToolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlockParam` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlockParam` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockParamContent Content` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string Title` - `required string Url` - `string? PageAge` - `class BetaWebSearchToolRequestError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlockParam` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlockParam` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlockParam` - `JsonElement Type = "web_fetch_result"` - `required BetaRequestDocumentBlock Content` - `required string Url` Fetched content URL - `string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlockParam` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultErrorParam` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlockParam` - `JsonElement Type = "advisor_result"` - `required string Text` - `string? StopReason` - `class BetaAdvisorRedactedResultBlockParam` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob produced by a prior response; must be round-tripped verbatim. - `string? StopReason` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCodeExecutionToolResultBlockParam` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockParamContent Content` - `class BetaCodeExecutionToolResultErrorParam` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlockParam` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlockParam` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form, sent back in a later request. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBashCodeExecutionToolResultBlockParam` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultErrorParam` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlockParam` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaTextEditorCodeExecutionToolResultBlockParam` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultErrorParam` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlockParam` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `long? NumLines` - `long? StartLine` - `long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlockParam` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `IReadOnlyList? Lines` - `long? NewLines` - `long? NewStart` - `long? OldLines` - `long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaToolSearchToolResultBlockParam` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultErrorParam` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlockParam` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaMcpToolUseBlockParam` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` - `required string ServerName` The name of the MCP server - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestMcpToolResultBlockParam` - `JsonElement Type = "mcp_tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `bool IsError` - `class BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonElement Type = "container_upload"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `JsonElement Type = "compaction"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `string? Content` Summary of previously compacted content, or null if compaction failed - `string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` The block's signature as returned, to be sent back verbatim - `IReadOnlyList? ToolChanges` 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. - `class BetaRequestToolAdditionBlock` 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolRemovalBlock` 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `required IReadOnlyList Tools` The server's tools, exactly as the response listed them. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `JsonElement Type = "fallback"` - `required BetaFallbackInfoParam From` Identifies one hop of a fallback transition. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfoParam To` Identifies one hop of a fallback transition. - `JsonElement Trigger` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. ### Beta Message Delta Usage - `class BetaMessageDeltaUsage` - `required long? CacheCreationInputTokens` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `required long? CacheReadInputTokens` The cumulative number of input tokens read from the cache. minimum: 0 - `required BetaFallbackCreditUsage? FallbackCredit` 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). - `required Status Status` Whether the fallback-credit reprice was applied to this response's billing. A union discriminated on `type`. `redeemed`: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - `class BetaFallbackCreditRedeemed` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `JsonElement Type = "redeemed"` - `class BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `JsonElement Type = "not_applied"` - `required Reason Reason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `BodyMismatch("body_mismatch")` - `ContinuationExcluded("continuation_excluded")` - `ContinuationOnly("continuation_only")` - `Expired("expired")` - `InvalidTargetModel("invalid_target_model")` - `NotEnabled("not_enabled")` - `RepriceUnavailable("reprice_unavailable")` - `TemporarilyUnavailable("temporarily_unavailable")` - `VariantFieldsPresent("variant_fields_present")` - `WrongOrganization("wrong_organization")` - `WrongPlatform("wrong_platform")` - `WrongWorkspace("wrong_workspace")` - `IReadOnlyList? RemoveToRedeem` 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. - `required long? InputTokens` The cumulative number of input tokens which were used. minimum: 0 - `required IReadOnlyList? Iterations` 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. - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `JsonElement Type = "message"` Usage for a sampling iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model? Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `JsonElement Type = "compaction"` Usage for a compaction iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `JsonElement Type = "advisor_message"` Usage for an advisor sub-inference iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class 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`. - `JsonElement Type = "fallback_message"` Usage for the fallback-model attempt that served the response - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required long OutputTokens` The cumulative number of output tokens which were used. - `required BetaOutputTokensDetails? OutputTokensDetails` 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. - `required long ThinkingTokens` 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. minimum: 0 - `required BetaServerToolUsage? ServerToolUse` The number of server tool requests. - `required long WebFetchRequests` The number of web fetch tool requests. minimum: 0 - `required long WebSearchRequests` The number of web search tool requests. minimum: 0 ### Beta Message Iteration Usage - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `JsonElement Type = "message"` Usage for a sampling iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model? Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 ### Beta Message Param - `class BetaMessageParam: union` - `class BetaUserMessageParam` - `required BetaMessageContentParam Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaRequestDocumentBlock` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `bool Enabled` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 - `class BetaSearchResultBlockParam` - `JsonElement Type = "search_result"` - `required IReadOnlyList Content` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `required string Source` - `required string Title` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam Citations` - `class BetaThinkingBlockParam` - `JsonElement Type = "thinking"` - `required string Signature` 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`. - `required string Thinking` The `thinking` text of this block as returned by the API. - `class BetaRedactedThinkingBlockParam` - `JsonElement Type = "redacted_thinking"` - `required string Data` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `class BetaToolUseBlockParam` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1, maxLength: 200 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaToolResultBlockParam` - `JsonElement Type = "tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaSearchResultBlockParam` - `class BetaRequestDocumentBlock` - `class BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonElement Type = "browser_state"` - `required IReadOnlyList Tabs` 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 - `required string TabID` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool Active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? StateChanges` 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 - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool IsError` - `string? ToolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlockParam` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlockParam` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockParamContent Content` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string Title` - `required string Url` - `string? PageAge` - `class BetaWebSearchToolRequestError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlockParam` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlockParam` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlockParam` - `JsonElement Type = "web_fetch_result"` - `required BetaRequestDocumentBlock Content` - `required string Url` Fetched content URL - `string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlockParam` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultErrorParam` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlockParam` - `JsonElement Type = "advisor_result"` - `required string Text` - `string? StopReason` - `class BetaAdvisorRedactedResultBlockParam` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob produced by a prior response; must be round-tripped verbatim. - `string? StopReason` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCodeExecutionToolResultBlockParam` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockParamContent Content` - `class BetaCodeExecutionToolResultErrorParam` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlockParam` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlockParam` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form, sent back in a later request. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBashCodeExecutionToolResultBlockParam` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultErrorParam` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlockParam` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaTextEditorCodeExecutionToolResultBlockParam` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultErrorParam` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlockParam` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `long? NumLines` - `long? StartLine` - `long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlockParam` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `IReadOnlyList? Lines` - `long? NewLines` - `long? NewStart` - `long? OldLines` - `long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaToolSearchToolResultBlockParam` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultErrorParam` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlockParam` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaMcpToolUseBlockParam` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` - `required string ServerName` The name of the MCP server - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestMcpToolResultBlockParam` - `JsonElement Type = "mcp_tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `bool IsError` - `class BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonElement Type = "container_upload"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `JsonElement Type = "compaction"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `string? Content` Summary of previously compacted content, or null if compaction failed - `string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` The block's signature as returned, to be sent back verbatim - `IReadOnlyList? ToolChanges` 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. - `class BetaRequestToolAdditionBlock` 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolRemovalBlock` 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `required IReadOnlyList Tools` The server's tools, exactly as the response listed them. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `JsonElement Type = "fallback"` - `required BetaFallbackInfoParam From` Identifies one hop of a fallback transition. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfoParam To` Identifies one hop of a fallback transition. - `JsonElement Trigger` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `JsonElement Role = "user"` - `class BetaAssistantMessageParam` - `required BetaMessageContentParam Content` - `JsonElement Role = "assistant"` - `class BetaSystemMessageParam` - `JsonElement Role = "system"` - `ClearAt? ClearAt` 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. - `NextUserMessage("next_user_message")` - `Never("never")` - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `BetaSystemMessageOutputConfig? OutputConfig` 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? Effort` 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`. - `Low("low")` - `Medium("medium")` - `High("high")` - `Xhigh("xhigh")` - `Max("max")` ### Beta Message Thread Param - `class BetaMessageThreadParam: union` Server-held conversation state (a Thread). `{"type": "create"}` asks the server to hold this conversation's state under the response's `id`; `{"type": "continue", "previous_message_id": ...}` resumes from a previous response so only the new turn's messages are sent. The response shape is unchanged. - `class BetaThreadCreateParams` Start holding conversation state under this response's `id`. - `JsonElement Type = "create"` - `class BetaThreadContinueParams` Resume from the response named by `previous_message_id`. - `JsonElement Type = "continue"` - `required string PreviousMessageID` The `id` of the previous response in this Thread. ### Beta Message Tokens Count - `class BetaMessageTokensCount` - `required BetaCountTokensContextManagementResponse? ContextManagement` Information about context management applied to the message. - `required long OriginalInputTokens` The original token count before context management was applied - `required long InputTokens` The total number of tokens across the provided list of messages, system prompt, and tools. ### Beta Metadata - `class BetaMetadata` - `string? UserID` 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 - `class BetaOutputConfig` - `Effort? Effort` 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`. - `Low("low")` - `Medium("medium")` - `High("high")` - `Xhigh("xhigh")` - `Max("max")` - `BetaJsonOutputFormat? Format` 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=csharp) - `JsonElement Type = "json_schema"` - `required IReadOnlyDictionary Schema` The JSON schema of the format - `BetaTokenTaskBudget? TaskBudget` Configuration for token budget tracking across contexts. - `JsonElement Type = "tokens"` The budget type. Currently only 'tokens' is supported. - `required long Total` Total token budget across all contexts in the session. minimum: 1024 - `long? Remaining` 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 - `class BetaOutputTokensDetails` - `required long ThinkingTokens` 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. minimum: 0 ### Beta Plain Text Source - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` ### Beta Raw Content Block Delta - `class BetaRawContentBlockDelta: union` - `class BetaTextDelta` - `JsonElement Type = "text_delta"` - `required string Text` - `class BetaInputJsonDelta` - `JsonElement Type = "input_json_delta"` - `required string PartialJson` - `class BetaCitationsDelta` - `JsonElement Type = "citations_delta"` - `required Citation Citation` - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaThinkingDelta` - `JsonElement Type = "thinking_delta"` - `required long? EstimatedTokens` 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. - `required string Thinking` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `class BetaSignatureDelta` - `JsonElement Type = "signature_delta"` - `required string Signature` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `class BetaCompactionContentBlockDelta` - `JsonElement Type = "compaction_delta"` - `required string? Content` - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim ### Beta Raw Content Block Delta Event - `class BetaRawContentBlockDeltaEvent` - `JsonElement Type = "content_block_delta"` - `required BetaRawContentBlockDelta Delta` - `class BetaTextDelta` - `JsonElement Type = "text_delta"` - `required string Text` - `class BetaInputJsonDelta` - `JsonElement Type = "input_json_delta"` - `required string PartialJson` - `class BetaCitationsDelta` - `JsonElement Type = "citations_delta"` - `required Citation Citation` - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaThinkingDelta` - `JsonElement Type = "thinking_delta"` - `required long? EstimatedTokens` 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. - `required string Thinking` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `class BetaSignatureDelta` - `JsonElement Type = "signature_delta"` - `required string Signature` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `class BetaCompactionContentBlockDelta` - `JsonElement Type = "compaction_delta"` - `required string? Content` - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `required long Index` ### Beta Raw Content Block Start Event - `class BetaRawContentBlockStartEvent` - `JsonElement Type = "content_block_start"` - `required ContentBlock ContentBlock` - `class BetaTextBlock` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `required string Text` - `class BetaThinkingBlock` - `JsonElement Type = "thinking"` - `required string Signature` 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=csharp) for details. - `required string Thinking` The text of Claude's thinking process for this block. - `class BetaRedactedThinkingBlock` - `JsonElement Type = "redacted_thinking"` - `required string Data` 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=csharp#redacted-thinking-blocks) for details. - `class BetaToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1 - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlock` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlock` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockContent Content` - `class BetaWebSearchToolResultError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string? PageAge` - `required string Title` - `required string Url` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlock` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlock` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlock` - `JsonElement Type = "web_fetch_result"` - `required BetaDocumentBlock Content` - `JsonElement Type = "document"` - `required BetaCitationConfig? Citations` Citation configuration for the document - `required bool Enabled` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `required string? Title` The title of the document - `required string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string Url` Fetched content URL - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlock` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultError` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlock` - `JsonElement Type = "advisor_result"` - `required string? StopReason` 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. - `required string Text` - `class BetaAdvisorRedactedResultBlock` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `required string? StopReason` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaCodeExecutionToolResultBlock` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockContent Content` - `class BetaCodeExecutionToolResultError` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlock` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlock` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form. The API returns this block in place of `code_execution_result` when the code called the web search tool. See the [programmatic tool calling guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling?sdk_languages=csharp) to learn more about programmatic tool calling. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaBashCodeExecutionToolResultBlock` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultError` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlock` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaTextEditorCodeExecutionToolResultBlock` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultError` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `required string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlock` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `required long? NumLines` - `required long? StartLine` - `required long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlock` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlock` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `required IReadOnlyList? Lines` - `required long? NewLines` - `required long? NewStart` - `required long? OldLines` - `required long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaToolSearchToolResultBlock` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultError` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `required string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlock` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaMcpToolUseBlock` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` The name of the MCP tool - `required string ServerName` The name of the MCP server - `class BetaMcpToolResultBlock` - `JsonElement Type = "mcp_tool_result"` - `required Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` 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`. - `required string Text` - `required bool IsError` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `class BetaContainerUploadBlock` Response model for a file uploaded to the container. - `JsonElement Type = "container_upload"` - `required string FileID` - `class BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `JsonElement Type = "compaction"` - `required string? Content` Summary of compacted content, or null if compaction failed - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` Signature over the summary, to be sent back with the block verbatim - `IReadOnlyList? ToolChanges` 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. - `class 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `class 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. - `JsonElement Type = "tool_reference"` - `required string Name` - `class 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. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class 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. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaResponseToolUnion Definition` - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `class 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. - `class 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. - `class 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. - `class BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `JsonElement Type = "fallback"` - `required BetaFallbackInfo From` 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. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfo To` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `required BetaFallbackRefusalTrigger Trigger` What caused the `from` model to hand over at this hop. - `JsonElement Type = "refusal"` - `required BetaFallbackRefusalTriggerCategory? Category` The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` - `required IReadOnlyList Tools` - `required IReadOnlyDictionary InputSchema` - `required string Name` - `string Description` - `required long Index` ### Beta Raw Content Block Stop Event - `class BetaRawContentBlockStopEvent` - `JsonElement Type = "content_block_stop"` - `required long Index` ### Beta Raw Message Delta Event - `class BetaRawMessageDeltaEvent` - `JsonElement Type = "message_delta"` - `required BetaContextManagementResponse? ContextManagement` Information about context management strategies applied during the request - `required IReadOnlyList AppliedEdits` List of context management edits that were applied. - `class BetaClearToolUses20250919EditResponse` - `JsonElement Type = "clear_tool_uses_20250919"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedToolUses` Number of tool uses that were cleared. minimum: 0 - `class BetaClearThinking20251015EditResponse` - `JsonElement Type = "clear_thinking_20251015"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedThinkingTurns` Number of thinking turns that were cleared. minimum: 0 - `required Delta Delta` - `required BetaContainer? Container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `required string ID` Identifier for the container used in this request - `required DateTimeOffset ExpiresAt` The time at which the container will expire. format: date-time - `required IReadOnlyList? Skills` Skills loaded in the container - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `required string Version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `required BetaRefusalStopDetails? StopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonElement Type = "refusal"` - `required Category? Category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `required string? Explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `required string? FallbackCreditToken` 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. - `required bool? FallbackHasPrefillClaim` 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. - `required string? RecommendedModel` 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. - `required BetaStopReason? StopReason` - `EndTurn("end_turn")` - `MaxTokens("max_tokens")` - `StopSequence("stop_sequence")` - `ToolUse("tool_use")` - `PauseTurn("pause_turn")` - `Compaction("compaction")` - `Refusal("refusal")` - `ModelContextWindowExceeded("model_context_window_exceeded")` - `required string? StopSequence` - `required BetaMessageDeltaUsage Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `required long? CacheCreationInputTokens` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `required long? CacheReadInputTokens` The cumulative number of input tokens read from the cache. minimum: 0 - `required BetaFallbackCreditUsage? FallbackCredit` 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). - `required Status Status` Whether the fallback-credit reprice was applied to this response's billing. A union discriminated on `type`. `redeemed`: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - `class BetaFallbackCreditRedeemed` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `JsonElement Type = "redeemed"` - `class BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `JsonElement Type = "not_applied"` - `required Reason Reason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `BodyMismatch("body_mismatch")` - `ContinuationExcluded("continuation_excluded")` - `ContinuationOnly("continuation_only")` - `Expired("expired")` - `InvalidTargetModel("invalid_target_model")` - `NotEnabled("not_enabled")` - `RepriceUnavailable("reprice_unavailable")` - `TemporarilyUnavailable("temporarily_unavailable")` - `VariantFieldsPresent("variant_fields_present")` - `WrongOrganization("wrong_organization")` - `WrongPlatform("wrong_platform")` - `WrongWorkspace("wrong_workspace")` - `IReadOnlyList? RemoveToRedeem` 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. - `required long? InputTokens` The cumulative number of input tokens which were used. minimum: 0 - `required IReadOnlyList? Iterations` 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. - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `JsonElement Type = "message"` Usage for a sampling iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model? Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `JsonElement Type = "compaction"` Usage for a compaction iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `JsonElement Type = "advisor_message"` Usage for an advisor sub-inference iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class 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`. - `JsonElement Type = "fallback_message"` Usage for the fallback-model attempt that served the response - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required long OutputTokens` The cumulative number of output tokens which were used. - `required BetaOutputTokensDetails? OutputTokensDetails` 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. - `required long ThinkingTokens` 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. minimum: 0 - `required BetaServerToolUsage? ServerToolUse` The number of server tool requests. - `required long WebFetchRequests` The number of web fetch tool requests. minimum: 0 - `required long WebSearchRequests` The number of web search tool requests. minimum: 0 - `IReadOnlyList? InputTransformations` 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`. - `class BetaThinkingDroppedInputTransformation` - `JsonElement Type = "thinking_dropped"` Always `thinking_dropped` for this entry type. - `required string Path` 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. - `required Reason Reason` 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`. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` - `class BetaThinkingMismatchAllowedInputTransformation` - `JsonElement Type = "thinking_mismatch_allowed"` Always `thinking_mismatch_allowed` for this entry type. - `required string Path` 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. - `required Reason Reason` 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. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` ### Beta Raw Message Start Event - `class BetaRawMessageStartEvent` - `JsonElement Type = "message_start"` - `required BetaMessage Message` - `JsonElement Type = "message"` Object type. For Messages, this is always `"message"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required BetaContainer? Container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `required string ID` Identifier for the container used in this request - `required DateTimeOffset ExpiresAt` The time at which the container will expire. format: date-time - `required IReadOnlyList? Skills` Skills loaded in the container - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `required string Version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `required IReadOnlyList Content` 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)"}] ``` - `class BetaTextBlock` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `required string Text` - `class BetaThinkingBlock` - `JsonElement Type = "thinking"` - `required string Signature` 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=csharp) for details. - `required string Thinking` The text of Claude's thinking process for this block. - `class BetaRedactedThinkingBlock` - `JsonElement Type = "redacted_thinking"` - `required string Data` 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=csharp#redacted-thinking-blocks) for details. - `class BetaToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1 - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlock` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlock` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockContent Content` - `class BetaWebSearchToolResultError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string? PageAge` - `required string Title` - `required string Url` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlock` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlock` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlock` - `JsonElement Type = "web_fetch_result"` - `required BetaDocumentBlock Content` - `JsonElement Type = "document"` - `required BetaCitationConfig? Citations` Citation configuration for the document - `required bool Enabled` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `required string? Title` The title of the document - `required string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string Url` Fetched content URL - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlock` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultError` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlock` - `JsonElement Type = "advisor_result"` - `required string? StopReason` 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. - `required string Text` - `class BetaAdvisorRedactedResultBlock` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `required string? StopReason` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaCodeExecutionToolResultBlock` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockContent Content` - `class BetaCodeExecutionToolResultError` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlock` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlock` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form. The API returns this block in place of `code_execution_result` when the code called the web search tool. See the [programmatic tool calling guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling?sdk_languages=csharp) to learn more about programmatic tool calling. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaBashCodeExecutionToolResultBlock` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultError` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlock` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaTextEditorCodeExecutionToolResultBlock` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultError` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `required string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlock` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `required long? NumLines` - `required long? StartLine` - `required long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlock` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlock` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `required IReadOnlyList? Lines` - `required long? NewLines` - `required long? NewStart` - `required long? OldLines` - `required long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaToolSearchToolResultBlock` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultError` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `required string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlock` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaMcpToolUseBlock` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` The name of the MCP tool - `required string ServerName` The name of the MCP server - `class BetaMcpToolResultBlock` - `JsonElement Type = "mcp_tool_result"` - `required Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` 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`. - `required string Text` - `required bool IsError` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `class BetaContainerUploadBlock` Response model for a file uploaded to the container. - `JsonElement Type = "container_upload"` - `required string FileID` - `class BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `JsonElement Type = "compaction"` - `required string? Content` Summary of compacted content, or null if compaction failed - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` Signature over the summary, to be sent back with the block verbatim - `IReadOnlyList? ToolChanges` 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. - `class 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `class 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. - `JsonElement Type = "tool_reference"` - `required string Name` - `class 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. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class 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. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaResponseToolUnion Definition` - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `class 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. - `class 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. - `class 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. - `class BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `JsonElement Type = "fallback"` - `required BetaFallbackInfo From` 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. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfo To` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `required BetaFallbackRefusalTrigger Trigger` What caused the `from` model to hand over at this hop. - `JsonElement Type = "refusal"` - `required BetaFallbackRefusalTriggerCategory? Category` The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` - `required IReadOnlyList Tools` - `required IReadOnlyDictionary InputSchema` - `required string Name` - `string Description` - `required BetaContextManagementResponse? ContextManagement` Context management response. Information about context management strategies applied during the request. - `required IReadOnlyList AppliedEdits` List of context management edits that were applied. - `class BetaClearToolUses20250919EditResponse` - `JsonElement Type = "clear_tool_uses_20250919"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedToolUses` Number of tool uses that were cleared. minimum: 0 - `class BetaClearThinking20251015EditResponse` - `JsonElement Type = "clear_thinking_20251015"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedThinkingTurns` Number of thinking turns that were cleared. minimum: 0 - `required BetaDiagnostics? Diagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `required BetaCacheMissReason? CacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class BetaCacheMissModelChanged` A `cache_miss_reason` for a request whose `model` or `speed` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "model_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissSystemChanged` A `cache_miss_reason` for a request whose `system` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "system_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissToolsChanged` A `cache_miss_reason` for a request whose `tools` differ from the previous request's, for example because tools were added, removed, or reordered. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "tools_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissMessagesChanged` A `cache_miss_reason` for a request whose `messages` differ from the previous request's in an earlier entry, instead of only having entries appended. The `model`, `system`, and `tools` match. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "messages_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissPreviousMessageNotFound` A `cache_miss_reason` for when the API doesn't have a stored record of the request that `diagnostics.previous_message_id` references. This doesn't mean that this request changed. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "previous_message_not_found"` - `class BetaCacheMissUnavailable` A `cache_miss_reason` for when the API can't give a diagnosis. The request itself was processed normally. This includes a request whose `model`, `system`, and `tools` match the previous request's but whose other prompt-affecting parameters, such as `thinking` or `tool_choice`, differ. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "unavailable"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `JsonElement Role = "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `required BetaRefusalStopDetails? StopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonElement Type = "refusal"` - `required Category? Category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `required string? Explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `required string? FallbackCreditToken` 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. - `required bool? FallbackHasPrefillClaim` 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. - `required string? RecommendedModel` 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. - `required BetaStopReason? StopReason` 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. - `EndTurn("end_turn")` - `MaxTokens("max_tokens")` - `StopSequence("stop_sequence")` - `ToolUse("tool_use")` - `PauseTurn("pause_turn")` - `Compaction("compaction")` - `Refusal("refusal")` - `ModelContextWindowExceeded("model_context_window_exceeded")` - `required string? StopSequence` 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. - `required BetaUsage Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long? CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long? CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required BetaFallbackCreditUsage? FallbackCredit` 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). - `required Status Status` Whether the fallback-credit reprice was applied to this response's billing. A union discriminated on `type`. `redeemed`: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - `class BetaFallbackCreditRedeemed` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `JsonElement Type = "redeemed"` - `class BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `JsonElement Type = "not_applied"` - `required Reason Reason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `BodyMismatch("body_mismatch")` - `ContinuationExcluded("continuation_excluded")` - `ContinuationOnly("continuation_only")` - `Expired("expired")` - `InvalidTargetModel("invalid_target_model")` - `NotEnabled("not_enabled")` - `RepriceUnavailable("reprice_unavailable")` - `TemporarilyUnavailable("temporarily_unavailable")` - `VariantFieldsPresent("variant_fields_present")` - `WrongOrganization("wrong_organization")` - `WrongPlatform("wrong_platform")` - `WrongWorkspace("wrong_workspace")` - `IReadOnlyList? RemoveToRedeem` 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. - `required string? InferenceGeo` The geographic region where inference was performed for this request. - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required IReadOnlyList? Iterations` 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. - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `JsonElement Type = "message"` Usage for a sampling iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model? Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `JsonElement Type = "compaction"` Usage for a compaction iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `JsonElement Type = "advisor_message"` Usage for an advisor sub-inference iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class 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`. - `JsonElement Type = "fallback_message"` Usage for the fallback-model attempt that served the response - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required BetaOutputTokensDetails? OutputTokensDetails` 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. - `required long ThinkingTokens` 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. minimum: 0 - `required BetaServerToolUsage? ServerToolUse` The number of server tool requests. - `required long WebFetchRequests` The number of web fetch tool requests. minimum: 0 - `required long WebSearchRequests` The number of web search tool requests. minimum: 0 - `required ServiceTier? ServiceTier` If the request used the priority, standard, or batch tier. - `Standard("standard")` - `Priority("priority")` - `Batch("batch")` - `required Speed? Speed` The inference speed mode used for this request. - `Standard("standard")` - `Fast("fast")` - `IReadOnlyList? InputTransformations` 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`. - `class BetaThinkingDroppedInputTransformation` - `JsonElement Type = "thinking_dropped"` Always `thinking_dropped` for this entry type. - `required string Path` 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. - `required Reason Reason` 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`. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` - `class BetaThinkingMismatchAllowedInputTransformation` - `JsonElement Type = "thinking_mismatch_allowed"` Always `thinking_mismatch_allowed` for this entry type. - `required string Path` 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. - `required Reason Reason` 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. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` ### Beta Raw Message Stop Event - `class BetaRawMessageStopEvent` - `JsonElement Type = "message_stop"` ### Beta Raw Message Stream Event - `class BetaRawMessageStreamEvent: union` - `class BetaRawMessageStartEvent` - `JsonElement Type = "message_start"` - `required BetaMessage Message` - `JsonElement Type = "message"` Object type. For Messages, this is always `"message"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required BetaContainer? Container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `required string ID` Identifier for the container used in this request - `required DateTimeOffset ExpiresAt` The time at which the container will expire. format: date-time - `required IReadOnlyList? Skills` Skills loaded in the container - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `required string Version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `required IReadOnlyList Content` 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)"}] ``` - `class BetaTextBlock` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `required string Text` - `class BetaThinkingBlock` - `JsonElement Type = "thinking"` - `required string Signature` 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=csharp) for details. - `required string Thinking` The text of Claude's thinking process for this block. - `class BetaRedactedThinkingBlock` - `JsonElement Type = "redacted_thinking"` - `required string Data` 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=csharp#redacted-thinking-blocks) for details. - `class BetaToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1 - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlock` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlock` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockContent Content` - `class BetaWebSearchToolResultError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string? PageAge` - `required string Title` - `required string Url` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlock` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlock` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlock` - `JsonElement Type = "web_fetch_result"` - `required BetaDocumentBlock Content` - `JsonElement Type = "document"` - `required BetaCitationConfig? Citations` Citation configuration for the document - `required bool Enabled` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `required string? Title` The title of the document - `required string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string Url` Fetched content URL - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlock` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultError` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlock` - `JsonElement Type = "advisor_result"` - `required string? StopReason` 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. - `required string Text` - `class BetaAdvisorRedactedResultBlock` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `required string? StopReason` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaCodeExecutionToolResultBlock` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockContent Content` - `class BetaCodeExecutionToolResultError` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlock` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlock` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form. The API returns this block in place of `code_execution_result` when the code called the web search tool. See the [programmatic tool calling guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling?sdk_languages=csharp) to learn more about programmatic tool calling. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaBashCodeExecutionToolResultBlock` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultError` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlock` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaTextEditorCodeExecutionToolResultBlock` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultError` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `required string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlock` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `required long? NumLines` - `required long? StartLine` - `required long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlock` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlock` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `required IReadOnlyList? Lines` - `required long? NewLines` - `required long? NewStart` - `required long? OldLines` - `required long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaToolSearchToolResultBlock` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultError` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `required string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlock` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaMcpToolUseBlock` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` The name of the MCP tool - `required string ServerName` The name of the MCP server - `class BetaMcpToolResultBlock` - `JsonElement Type = "mcp_tool_result"` - `required Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` 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`. - `required string Text` - `required bool IsError` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `class BetaContainerUploadBlock` Response model for a file uploaded to the container. - `JsonElement Type = "container_upload"` - `required string FileID` - `class BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `JsonElement Type = "compaction"` - `required string? Content` Summary of compacted content, or null if compaction failed - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` Signature over the summary, to be sent back with the block verbatim - `IReadOnlyList? ToolChanges` 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. - `class 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `class 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. - `JsonElement Type = "tool_reference"` - `required string Name` - `class 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. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class 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. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaResponseToolUnion Definition` - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `class 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. - `class 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. - `class 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. - `class BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `JsonElement Type = "fallback"` - `required BetaFallbackInfo From` 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. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfo To` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `required BetaFallbackRefusalTrigger Trigger` What caused the `from` model to hand over at this hop. - `JsonElement Type = "refusal"` - `required BetaFallbackRefusalTriggerCategory? Category` The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` - `required IReadOnlyList Tools` - `required IReadOnlyDictionary InputSchema` - `required string Name` - `string Description` - `required BetaContextManagementResponse? ContextManagement` Context management response. Information about context management strategies applied during the request. - `required IReadOnlyList AppliedEdits` List of context management edits that were applied. - `class BetaClearToolUses20250919EditResponse` - `JsonElement Type = "clear_tool_uses_20250919"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedToolUses` Number of tool uses that were cleared. minimum: 0 - `class BetaClearThinking20251015EditResponse` - `JsonElement Type = "clear_thinking_20251015"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedThinkingTurns` Number of thinking turns that were cleared. minimum: 0 - `required BetaDiagnostics? Diagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `required BetaCacheMissReason? CacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class BetaCacheMissModelChanged` A `cache_miss_reason` for a request whose `model` or `speed` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "model_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissSystemChanged` A `cache_miss_reason` for a request whose `system` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "system_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissToolsChanged` A `cache_miss_reason` for a request whose `tools` differ from the previous request's, for example because tools were added, removed, or reordered. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "tools_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissMessagesChanged` A `cache_miss_reason` for a request whose `messages` differ from the previous request's in an earlier entry, instead of only having entries appended. The `model`, `system`, and `tools` match. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "messages_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissPreviousMessageNotFound` A `cache_miss_reason` for when the API doesn't have a stored record of the request that `diagnostics.previous_message_id` references. This doesn't mean that this request changed. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "previous_message_not_found"` - `class BetaCacheMissUnavailable` A `cache_miss_reason` for when the API can't give a diagnosis. The request itself was processed normally. This includes a request whose `model`, `system`, and `tools` match the previous request's but whose other prompt-affecting parameters, such as `thinking` or `tool_choice`, differ. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "unavailable"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `JsonElement Role = "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `required BetaRefusalStopDetails? StopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonElement Type = "refusal"` - `required Category? Category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `required string? Explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `required string? FallbackCreditToken` 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. - `required bool? FallbackHasPrefillClaim` 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. - `required string? RecommendedModel` 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. - `required BetaStopReason? StopReason` 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. - `EndTurn("end_turn")` - `MaxTokens("max_tokens")` - `StopSequence("stop_sequence")` - `ToolUse("tool_use")` - `PauseTurn("pause_turn")` - `Compaction("compaction")` - `Refusal("refusal")` - `ModelContextWindowExceeded("model_context_window_exceeded")` - `required string? StopSequence` 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. - `required BetaUsage Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long? CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long? CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required BetaFallbackCreditUsage? FallbackCredit` 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). - `required Status Status` Whether the fallback-credit reprice was applied to this response's billing. A union discriminated on `type`. `redeemed`: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - `class BetaFallbackCreditRedeemed` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `JsonElement Type = "redeemed"` - `class BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `JsonElement Type = "not_applied"` - `required Reason Reason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `BodyMismatch("body_mismatch")` - `ContinuationExcluded("continuation_excluded")` - `ContinuationOnly("continuation_only")` - `Expired("expired")` - `InvalidTargetModel("invalid_target_model")` - `NotEnabled("not_enabled")` - `RepriceUnavailable("reprice_unavailable")` - `TemporarilyUnavailable("temporarily_unavailable")` - `VariantFieldsPresent("variant_fields_present")` - `WrongOrganization("wrong_organization")` - `WrongPlatform("wrong_platform")` - `WrongWorkspace("wrong_workspace")` - `IReadOnlyList? RemoveToRedeem` 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. - `required string? InferenceGeo` The geographic region where inference was performed for this request. - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required IReadOnlyList? Iterations` 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. - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `JsonElement Type = "message"` Usage for a sampling iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model? Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `JsonElement Type = "compaction"` Usage for a compaction iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `JsonElement Type = "advisor_message"` Usage for an advisor sub-inference iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class 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`. - `JsonElement Type = "fallback_message"` Usage for the fallback-model attempt that served the response - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required BetaOutputTokensDetails? OutputTokensDetails` 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. - `required long ThinkingTokens` 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. minimum: 0 - `required BetaServerToolUsage? ServerToolUse` The number of server tool requests. - `required long WebFetchRequests` The number of web fetch tool requests. minimum: 0 - `required long WebSearchRequests` The number of web search tool requests. minimum: 0 - `required ServiceTier? ServiceTier` If the request used the priority, standard, or batch tier. - `Standard("standard")` - `Priority("priority")` - `Batch("batch")` - `required Speed? Speed` The inference speed mode used for this request. - `Standard("standard")` - `Fast("fast")` - `IReadOnlyList? InputTransformations` 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`. - `class BetaThinkingDroppedInputTransformation` - `JsonElement Type = "thinking_dropped"` Always `thinking_dropped` for this entry type. - `required string Path` 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. - `required Reason Reason` 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`. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` - `class BetaThinkingMismatchAllowedInputTransformation` - `JsonElement Type = "thinking_mismatch_allowed"` Always `thinking_mismatch_allowed` for this entry type. - `required string Path` 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. - `required Reason Reason` 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. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` - `class BetaRawMessageDeltaEvent` - `JsonElement Type = "message_delta"` - `required BetaContextManagementResponse? ContextManagement` Information about context management strategies applied during the request - `required Delta Delta` - `required BetaContainer? Container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `required BetaRefusalStopDetails? StopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `required BetaStopReason? StopReason` - `required string? StopSequence` - `required BetaMessageDeltaUsage Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `required long? CacheCreationInputTokens` The cumulative number of input tokens used to create the cache entry. minimum: 0 - `required long? CacheReadInputTokens` The cumulative number of input tokens read from the cache. minimum: 0 - `required BetaFallbackCreditUsage? FallbackCredit` 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). - `required long? InputTokens` The cumulative number of input tokens which were used. minimum: 0 - `required IReadOnlyList? Iterations` 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. - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `class 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`. - `required long OutputTokens` The cumulative number of output tokens which were used. - `required BetaOutputTokensDetails? OutputTokensDetails` 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. - `required BetaServerToolUsage? ServerToolUse` The number of server tool requests. - `IReadOnlyList? InputTransformations` 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`. - `class BetaThinkingDroppedInputTransformation` - `class BetaThinkingMismatchAllowedInputTransformation` - `class BetaRawMessageStopEvent` - `JsonElement Type = "message_stop"` - `class BetaRawContentBlockStartEvent` - `JsonElement Type = "content_block_start"` - `required ContentBlock ContentBlock` - `class BetaTextBlock` - `class BetaThinkingBlock` - `class BetaRedactedThinkingBlock` - `class BetaToolUseBlock` - `class BetaServerToolUseBlock` - `class BetaWebSearchToolResultBlock` - `class BetaWebFetchToolResultBlock` - `class BetaAdvisorToolResultBlock` - `class BetaCodeExecutionToolResultBlock` - `class BetaBashCodeExecutionToolResultBlock` - `class BetaTextEditorCodeExecutionToolResultBlock` - `class BetaToolSearchToolResultBlock` - `class BetaMcpToolUseBlock` - `class BetaMcpToolResultBlock` - `class BetaContainerUploadBlock` Response model for a file uploaded to the container. - `class BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `class BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `class 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. - `required long Index` - `class BetaRawContentBlockDeltaEvent` - `JsonElement Type = "content_block_delta"` - `required BetaRawContentBlockDelta Delta` - `class BetaTextDelta` - `JsonElement Type = "text_delta"` - `required string Text` - `class BetaInputJsonDelta` - `JsonElement Type = "input_json_delta"` - `required string PartialJson` - `class BetaCitationsDelta` - `JsonElement Type = "citations_delta"` - `required Citation Citation` - `class BetaCitationCharLocation` - `class BetaCitationPageLocation` - `class BetaCitationContentBlockLocation` - `class BetaCitationsWebSearchResultLocation` - `class BetaCitationSearchResultLocation` - `class BetaThinkingDelta` - `JsonElement Type = "thinking_delta"` - `required long? EstimatedTokens` 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. - `required string Thinking` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. - `class BetaSignatureDelta` - `JsonElement Type = "signature_delta"` - `required string Signature` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. - `class BetaCompactionContentBlockDelta` - `JsonElement Type = "compaction_delta"` - `required string? Content` - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `required long Index` - `class BetaRawContentBlockStopEvent` - `JsonElement Type = "content_block_stop"` - `required long Index` ### Beta Redacted Thinking Block - `class BetaRedactedThinkingBlock` - `JsonElement Type = "redacted_thinking"` - `required string Data` 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=csharp#redacted-thinking-blocks) for details. ### Beta Redacted Thinking Block Param - `class BetaRedactedThinkingBlockParam` - `JsonElement Type = "redacted_thinking"` - `required string Data` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. ### Beta Refusal Stop Details - `class BetaRefusalStopDetails` Structured information about a refusal. - `JsonElement Type = "refusal"` - `required Category? Category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `required string? Explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `required string? FallbackCreditToken` 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. - `required bool? FallbackHasPrefillClaim` 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. - `required string? RecommendedModel` 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 - `class BetaRequestDocumentBlock` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `bool Enabled` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 ### Beta Request MCP Server Tool Configuration - `class BetaRequestMcpServerToolConfiguration` - `IReadOnlyList? AllowedTools` - `bool? Enabled` ### Beta Request MCP Server URL Definition - `class BetaRequestMcpServerUrlDefinition` - `JsonElement Type = "url"` - `required string Name` - `required string Url` - `string? AuthorizationToken` - `BetaRequestMcpServerToolConfiguration? ToolConfiguration` - `IReadOnlyList? AllowedTools` - `bool? Enabled` ### Beta Request MCP Tool Result Block Param - `class BetaRequestMcpToolResultBlockParam` - `JsonElement Type = "mcp_tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `bool IsError` ### Beta Request Tool Addition Block - `class BetaRequestToolAdditionBlock` 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. ### Beta Request Tool Removal Block - `class BetaRequestToolRemovalBlock` 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` ### Beta Response Tool - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Response Tool Addition Block - `class 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `class 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. - `JsonElement Type = "tool_reference"` - `required string Name` - `class 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. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class 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. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaResponseToolUnion Definition` - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. ### Beta Response Tool Change MCP Tool Reference - `class 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. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` ### Beta Response Tool Change MCP Toolset Reference - `class 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. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` ### Beta Response Tool Change Tool Reference - `class 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. - `JsonElement Type = "tool_reference"` - `required string Name` ### Beta Response Tool Input Schema - `class 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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` ### Beta Response Tool Removal Block - `class 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `class 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. - `JsonElement Type = "tool_reference"` - `required string Name` - `class 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. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class 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. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` ### Beta Response Tool Union - `class BetaResponseToolUnion: union` - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. ### Beta Search Result Block Param - `class BetaSearchResultBlockParam` - `JsonElement Type = "search_result"` - `required IReadOnlyList Content` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `required string Source` - `required string Title` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam Citations` - `bool Enabled` ### Beta Server Tool Caller - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Server Tool Caller 20260120 - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Server Tool Usage - `class BetaServerToolUsage` - `required long WebFetchRequests` The number of web fetch tool requests. minimum: 0 - `required long WebSearchRequests` The number of web search tool requests. minimum: 0 ### Beta Server Tool Use Block - `class BetaServerToolUseBlock` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Server Tool Use Block Param - `class BetaServerToolUseBlockParam` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Signature Delta - `class BetaSignatureDelta` - `JsonElement Type = "signature_delta"` - `required string Signature` The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. ### Beta Skill Params - `class BetaSkillParams` Specification for a skill to be loaded in a container. - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `string Version` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 ### Beta Stop Reason - `enum BetaStopReason` - `EndTurn("end_turn")` - `MaxTokens("max_tokens")` - `StopSequence("stop_sequence")` - `ToolUse("tool_use")` - `PauseTurn("pause_turn")` - `Compaction("compaction")` - `Refusal("refusal")` - `ModelContextWindowExceeded("model_context_window_exceeded")` ### Beta Summarize Compaction - `class 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. - `JsonElement Type = "summarize"` - `string? Instructions` 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 - `class BetaSystemMessageOutputConfig` 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? Effort` 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`. - `Low("low")` - `Medium("medium")` - `High("high")` - `Xhigh("xhigh")` - `Max("max")` ### Beta System Message Param - `class BetaSystemMessageParam` - `JsonElement Role = "system"` - `ClearAt? ClearAt` 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. - `NextUserMessage("next_user_message")` - `Never("never")` - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaRequestToolAdditionBlock` 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolRemovalBlock` 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaSystemMessageOutputConfig? OutputConfig` 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? Effort` 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`. - `Low("low")` - `Medium("medium")` - `High("high")` - `Xhigh("xhigh")` - `Max("max")` ### Beta Text Block - `class BetaTextBlock` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `required string Text` ### Beta Text Block Param - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` ### Beta Text Citation - `class BetaTextCitation: union` - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` ### Beta Text Citation Param - `class BetaTextCitationParam: union` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` ### Beta Text Delta - `class BetaTextDelta` - `JsonElement Type = "text_delta"` - `required string Text` ### Beta Text Editor Code Execution Create Result Block - `class BetaTextEditorCodeExecutionCreateResultBlock` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` ### Beta Text Editor Code Execution Create Result Block Param - `class BetaTextEditorCodeExecutionCreateResultBlockParam` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` ### Beta Text Editor Code Execution Str Replace Result Block - `class BetaTextEditorCodeExecutionStrReplaceResultBlock` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `required IReadOnlyList? Lines` - `required long? NewLines` - `required long? NewStart` - `required long? OldLines` - `required long? OldStart` ### Beta Text Editor Code Execution Str Replace Result Block Param - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `IReadOnlyList? Lines` - `long? NewLines` - `long? NewStart` - `long? OldLines` - `long? OldStart` ### Beta Text Editor Code Execution Tool Result Block - `class BetaTextEditorCodeExecutionToolResultBlock` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultError` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `required string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlock` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `required long? NumLines` - `required long? StartLine` - `required long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlock` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlock` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `required IReadOnlyList? Lines` - `required long? NewLines` - `required long? NewStart` - `required long? OldLines` - `required long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Text Editor Code Execution Tool Result Block Param - `class BetaTextEditorCodeExecutionToolResultBlockParam` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultErrorParam` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlockParam` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `long? NumLines` - `long? StartLine` - `long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlockParam` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `IReadOnlyList? Lines` - `long? NewLines` - `long? NewStart` - `long? OldLines` - `long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` ### Beta Text Editor Code Execution Tool Result Error - `class BetaTextEditorCodeExecutionToolResultError` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `required string? ErrorMessage` ### Beta Text Editor Code Execution Tool Result Error Param - `class BetaTextEditorCodeExecutionToolResultErrorParam` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `string? ErrorMessage` ### Beta Text Editor Code Execution View Result Block - `class BetaTextEditorCodeExecutionViewResultBlock` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `required long? NumLines` - `required long? StartLine` - `required long? TotalLines` ### Beta Text Editor Code Execution View Result Block Param - `class BetaTextEditorCodeExecutionViewResultBlockParam` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `long? NumLines` - `long? StartLine` - `long? TotalLines` ### Beta Thinking Block - `class BetaThinkingBlock` - `JsonElement Type = "thinking"` - `required string Signature` 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=csharp) for details. - `required string Thinking` The text of Claude's thinking process for this block. ### Beta Thinking Block Binding - `class BetaThinkingBlockBinding` 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. - `BetaThinkingPrefixMismatchBehavior? PrefixMismatchBehavior` "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`. - `Error("error")` - `DropBlock("drop_block")` ### Beta Thinking Block Param - `class BetaThinkingBlockParam` - `JsonElement Type = "thinking"` - `required string Signature` 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`. - `required string Thinking` The `thinking` text of this block as returned by the API. ### Beta Thinking Config Adaptive - `class BetaThinkingConfigAdaptive` - `JsonElement Type = "adaptive"` - `BetaThinkingBlockBinding? BlockBinding` 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. - `BetaThinkingPrefixMismatchBehavior? PrefixMismatchBehavior` "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`. - `Error("error")` - `DropBlock("drop_block")` - `Display? Display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#controlling-thinking-display). - `Summarized("summarized")` - `Omitted("omitted")` - `Updates("updates")` ### Beta Thinking Config Between Tools - `class BetaThinkingConfigBetweenTools` - `JsonElement Type = "between_tools"` ### Beta Thinking Config Disabled - `class BetaThinkingConfigDisabled` - `JsonElement Type = "disabled"` ### Beta Thinking Config Enabled - `class BetaThinkingConfigEnabled` - `JsonElement Type = "enabled"` - `required long BudgetTokens` 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=csharp) for details. minimum: 1024 - `BetaThinkingBlockBinding? BlockBinding` 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. - `BetaThinkingPrefixMismatchBehavior? PrefixMismatchBehavior` "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`. - `Error("error")` - `DropBlock("drop_block")` - `Display? Display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#controlling-thinking-display). - `Summarized("summarized")` - `Omitted("omitted")` - `Updates("updates")` ### Beta Thinking Config Param - `class BetaThinkingConfigParam: union` 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=csharp#configuring-thinking) for each model's behavior. - `class BetaThinkingConfigEnabled` - `JsonElement Type = "enabled"` - `required long BudgetTokens` 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=csharp) for details. minimum: 1024 - `BetaThinkingBlockBinding? BlockBinding` 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. - `BetaThinkingPrefixMismatchBehavior? PrefixMismatchBehavior` "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`. - `Error("error")` - `DropBlock("drop_block")` - `Display? Display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#controlling-thinking-display). - `Summarized("summarized")` - `Omitted("omitted")` - `Updates("updates")` - `class BetaThinkingConfigDisabled` - `JsonElement Type = "disabled"` - `class BetaThinkingConfigBetweenTools` - `JsonElement Type = "between_tools"` - `class BetaThinkingConfigAdaptive` - `JsonElement Type = "adaptive"` - `BetaThinkingBlockBinding? BlockBinding` 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? Display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#controlling-thinking-display). - `Summarized("summarized")` - `Omitted("omitted")` - `Updates("updates")` ### Beta Thinking Delta - `class BetaThinkingDelta` - `JsonElement Type = "thinking_delta"` - `required long? EstimatedTokens` 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. - `required string Thinking` The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. ### Beta Thinking Dropped Input Transformation - `class BetaThinkingDroppedInputTransformation` - `JsonElement Type = "thinking_dropped"` Always `thinking_dropped` for this entry type. - `required string Path` 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. - `required Reason Reason` 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`. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` ### Beta Thinking Mismatch Allowed Input Transformation - `class BetaThinkingMismatchAllowedInputTransformation` - `JsonElement Type = "thinking_mismatch_allowed"` Always `thinking_mismatch_allowed` for this entry type. - `required string Path` 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. - `required Reason Reason` 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. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` ### Beta Thinking Prefix Mismatch Behavior - `enum BetaThinkingPrefixMismatchBehavior` 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. - `Error("error")` - `DropBlock("drop_block")` ### Beta Thinking Turns - `class BetaThinkingTurns` - `JsonElement Type = "thinking_turns"` - `required long Value` minimum: 1 ### Beta Thread Continue Params - `class BetaThreadContinueParams` Resume from the response named by `previous_message_id`. - `JsonElement Type = "continue"` - `required string PreviousMessageID` The `id` of the previous response in this Thread. ### Beta Thread Create Params - `class BetaThreadCreateParams` Start holding conversation state under this response's `id`. - `JsonElement Type = "create"` ### Beta Token Task Budget - `class BetaTokenTaskBudget` User-configurable total token budget across contexts. - `JsonElement Type = "tokens"` The budget type. Currently only 'tokens' is supported. - `required long Total` Total token budget across all contexts in the session. minimum: 1024 - `long? Remaining` 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 - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Bash 20241022 - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Bash 20250124 - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Change MCP Tool Reference - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` ### Beta Tool Change MCP Toolset Reference - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` ### Beta Tool Change Tool Definition - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaResponseToolUnion Definition` - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. ### Beta Tool Change Tool Definition Param - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. ### Beta Tool Change Tool Reference - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ ### Beta Tool Choice - `class BetaToolChoice: union` 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. - `class BetaToolChoiceAuto` The model will automatically decide whether to use tools. - `JsonElement Type = "auto"` - `bool DisableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `class BetaToolChoiceAny` The model will use any available tools. - `JsonElement Type = "any"` - `bool DisableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `class BetaToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `JsonElement Type = "tool"` - `required string Name` The name of the tool to use. - `bool DisableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `class BetaToolChoiceNone` The model will not be allowed to use tools. - `JsonElement Type = "none"` ### Beta Tool Choice Any - `class BetaToolChoiceAny` The model will use any available tools. - `JsonElement Type = "any"` - `bool DisableParallelToolUse` 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 - `class BetaToolChoiceAuto` The model will automatically decide whether to use tools. - `JsonElement Type = "auto"` - `bool DisableParallelToolUse` 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 - `class BetaToolChoiceNone` The model will not be allowed to use tools. - `JsonElement Type = "none"` ### Beta Tool Choice Tool - `class BetaToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `JsonElement Type = "tool"` - `required string Name` The name of the tool to use. - `bool DisableParallelToolUse` 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 - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Computer Use 20250124 - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Computer Use 20251124 - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Reference Block - `class BetaToolReferenceBlock` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ ### Beta Tool Reference Block Param - `class BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` ### Beta Tool Result Block Param - `class BetaToolResultBlockParam` - `JsonElement Type = "tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaSearchResultBlockParam` - `JsonElement Type = "search_result"` - `required IReadOnlyList Content` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `required string Source` - `required string Title` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam Citations` - `bool Enabled` - `class BetaRequestDocumentBlock` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 - `class BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonElement Type = "browser_state"` - `required IReadOnlyList Tabs` 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 - `required string TabID` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool Active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? StateChanges` 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 - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool IsError` - `string? ToolsetName` 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 - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Search Tool Regex 20251119 - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Search Tool Result Block - `class BetaToolSearchToolResultBlock` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultError` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `required string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlock` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Tool Search Tool Result Block Param - `class BetaToolSearchToolResultBlockParam` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultErrorParam` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlockParam` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. ### Beta Tool Search Tool Result Error - `class BetaToolSearchToolResultError` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `required string? ErrorMessage` ### Beta Tool Search Tool Result Error Param - `class BetaToolSearchToolResultErrorParam` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `string? ErrorMessage` ### Beta Tool Search Tool Search Result Block - `class BetaToolSearchToolSearchResultBlock` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ ### Beta Tool Search Tool Search Result Block Param - `class BetaToolSearchToolSearchResultBlockParam` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` ### Beta Tool Text Editor 20241022 - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250124 - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250429 - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Text Editor 20250728 - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs ### Beta Tool Union - `class BetaToolUnion: union` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. ### Beta Tool Use Block - `class BetaToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1 - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Beta Tool Use Block Param - `class BetaToolUseBlockParam` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1, maxLength: 200 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` 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 - `class BetaToolUseCaller: union` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Tool Uses Keep - `class BetaToolUsesKeep` - `JsonElement Type = "tool_uses"` - `required long Value` minimum: 0 ### Beta Tool Uses Trigger - `class BetaToolUsesTrigger` - `JsonElement Type = "tool_uses"` - `required long Value` minimum: 1 ### Beta Toolset Tool Use Block - `class BetaToolsetToolUseBlock: union` - `class BetaBrowserToolUseBlock: union` - `class BetaBrowserNavigateToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserNavigateInput Input` Navigate to a URL, or go back/forward/reload in history. The protocol may be omitted (defaults to https://). - `required string Url` The URL to navigate to, or "back" / "forward" / "reload" for history navigation. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "navigate"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaBrowserListTabsToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserListTabsInput Input` List all open tabs with each tab's tab_id, title, and URL. - `JsonElement Name = "list_tabs"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserNewTabToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserNewTabInput Input` Open a new empty tab and return its tab_id. - `JsonElement Name = "new_tab"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserSwitchTabToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserSwitchTabInput Input` Make the tab with the given tab_id the active tab — the tab that actions without a tab_id apply to. - `required string TabID` The tab to switch to. - `JsonElement Name = "switch_tab"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserCloseTabToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserCloseTabInput Input` Close the tab with the given tab_id. - `required string TabID` The tab to close. - `JsonElement Name = "close_tab"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserReadPageToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserReadPageInput Input` 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. - `long? Depth` Maximum tree depth. Default 15. minimum: 1 - `BetaBrowserReadPageFilter? Filter` Which elements to include. Omitted: every visible element. "interactive": interactive elements only. "all": additionally includes off-viewport elements. - `All("all")` - `Interactive("interactive")` - `string? Ref` Element reference to read a subtree from. Omit to read from the page root. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "read_page"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserGetPageTextToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserGetPageTextInput Input` Return the page's visible text content as plain text, prioritizing article content. Suited to articles, documentation, and other text-heavy pages. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "get_page_text"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserReadConsoleToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserReadConsoleInput Input` 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. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "read_console"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserReadNetworkToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserReadNetworkInput Input` 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. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "read_network"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserFindToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserFindInput Input` Find elements matching a natural-language description (e.g. "search bar", "add to cart button") and return up to 20 matches with element references. - `required string Query` Natural-language description of the element(s) to find. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "find"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserFormInputToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserFormInputInput Input` Set the value of a form element (input, textarea, select, checkbox). Use a boolean for checkboxes, an option value or text for selects. - `required BetaBrowserRefTarget Target` 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. - `JsonElement Type = "ref"` - `required string Ref` An element reference (e.g. "ref_7") returned by a prior `read_page` or `find` result. - `required BetaBrowserFormInputValue Value` The value to set. - `string` - `double` - `bool` - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "form_input"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserFileUploadToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserFileUploadInput Input` 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. - `required BetaBrowserRefTarget Target` 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. - `IReadOnlyList? DocumentIds` References to files the harness has staged, for deployments where the browser executor cannot read the caller's filesystem. minItems: 1 - `IReadOnlyList? Paths` File paths on the browser executor's filesystem. minItems: 1 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "file_upload"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserScrollToToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserScrollToInput Input` Scroll an element into view. - `required BetaBrowserRefTarget Target` 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. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "scroll_to"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserScreenshotToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserScreenshotInput Input` Capture the current browser viewport. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "screenshot"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserZoomToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserZoomInput Input` 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. - `required IReadOnlyList Region` [x0, y0, x1, y1] in viewport pixels. minItems: 4, maxItems: 4 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "zoom"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserLeftClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftClickInput Input` Left-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `class BetaBrowserCoordinateTarget` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `JsonElement Type = "coordinate"` - `required long X` Pixels from the left edge of the viewport. minimum: 0 - `required long Y` Pixels from the top edge of the viewport. minimum: 0 - `class 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. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserRightClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserRightClickInput Input` Right-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "right_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserMiddleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserMiddleClickInput Input` Middle-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "middle_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserDoubleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserDoubleClickInput Input` Double left-click at a viewport coordinate or on an element by reference. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "double_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserTripleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserTripleClickInput Input` Triple left-click at a viewport coordinate or on an element by reference (typically selects a line or paragraph). - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `string? Modifiers` Optional modifier key chord to hold for the duration of this action (e.g. "shift", "ctrl+shift", "cmd+alt"). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "triple_click"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserHoverToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserHoverInput Input` Move the cursor to a coordinate or element without clicking. - `required BetaBrowserClickTarget Target` Where to act: either a viewport coordinate or an element reference. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "hover"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserLeftClickDragToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftClickDragInput Input` Press at `from`, drag to `target`, release. Both must be coordinate targets. - `required BetaBrowserCoordinateTarget From` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_click_drag"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserLeftMouseDownToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftMouseDownInput Input` Press and hold the left mouse button at a viewport coordinate. Pair with left_mouse_up to perform a custom drag. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_mouse_down"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserLeftMouseUpToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserLeftMouseUpInput Input` Release the left mouse button at a viewport coordinate. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "left_mouse_up"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserMouseMoveToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserMouseMoveInput Input` Move the pointer to a viewport coordinate without clicking. - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "mouse_move"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserScrollToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserScrollInput Input` Scroll at a viewport position. `target` must be a coordinate target. - `required BetaBrowserScrollDirection ScrollDirection` - `Up("up")` - `Down("down")` - `Left("left")` - `Right("right")` - `required BetaBrowserCoordinateTarget Target` A point in the browser viewport, in viewport pixels (the same frame as a full-viewport screenshot). - `long? ScrollAmount` Scroll-wheel notches (1–10). Default 3. minimum: 1, maximum: 10 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "scroll"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserTypeToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserTypeInput Input` Type a literal string at the current focus. - `required string Text` The text to type. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "type"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserKeyInput Input` 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. - `required string Text` The key, chord, or space-separated sequence to press. - `long? Repeat` Number of times to repeat. Default 1. minimum: 1, maximum: 100 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "key"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserHoldKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserHoldKeyInput Input` 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. - `required double Duration` Seconds to hold the key down (maximum 30). minimum: 0, maximum: 30 - `required string Text` The key or chord to hold. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "hold_key"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserWaitToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserWaitInput Input` Pause for the given duration. - `required double Duration` Seconds to wait (maximum 30). minimum: 0, maximum: 30 - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "wait"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaBrowserJavascriptExecToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaBrowserJavascriptExecInput Input` 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`. - `required string Text` JavaScript to execute in the page context. - `string? TabID` Tab to act on. Defaults to the active tab when omitted. - `JsonElement Name = "javascript_exec"` - `JsonElement ToolsetName = "browser"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerToolUseBlock: union` - `class BetaComputerKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerKeyInput Input` 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. - `required string Text` The key or key-combination to press. - `long? Repeat` Number of times to repeat the key press. Default is 1. minimum: 1, maximum: 100 - `JsonElement Name = "key"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerHoldKeyToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerHoldKeyInput Input` Hold down a key or key-combination for a specified duration. Uses the same key syntax as `key`. - `required long Duration` Duration to hold the key, in seconds. maximum: 300 - `required string Text` The key or key-combination to hold. - `JsonElement Name = "hold_key"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerTypeToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerTypeInput Input` Type a string of text on the keyboard. - `required string Text` The text to type. - `JsonElement Name = "type"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerCursorPositionToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerCursorPositionInput Input` Get the current (x, y) pixel coordinate of the cursor. - `JsonElement Name = "cursor_position"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerMouseMoveToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerMouseMoveInput Input` Move the cursor to a specified (x, y) pixel coordinate. Use this ONLY to hover without clicking; otherwise use a click action directly. - `required IReadOnlyList Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `JsonElement Name = "mouse_move"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerLeftMouseDownToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftMouseDownInput Input` Press and hold the left mouse button at the current cursor position. - `JsonElement Name = "left_mouse_down"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerLeftMouseUpToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftMouseUpInput Input` Release the left mouse button. - `JsonElement Name = "left_mouse_up"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerLeftClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftClickInput Input` Click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "left_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerLeftClickDragToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerLeftClickDragInput Input` Click and drag the cursor from `start_coordinate` to `coordinate`. - `required IReadOnlyList Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `required IReadOnlyList StartCoordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "left_click_drag"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerRightClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerRightClickInput Input` Click the right mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "right_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerMiddleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerMiddleClickInput Input` Click the middle mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "middle_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerDoubleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerDoubleClickInput Input` Double-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "double_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerTripleClickToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerTripleClickInput Input` Triple-click the left mouse button at the specified (x, y) pixel coordinate, or the current cursor position if `coordinate` is omitted. - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "triple_click"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerScrollToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerScrollInput Input` 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. - `required long ScrollAmount` Number of 'clicks' of the scroll wheel. - `required BetaComputerScrollDirection ScrollDirection` - `Up("up")` - `Down("down")` - `Left("left")` - `Right("right")` - `IReadOnlyList? Coordinate` (x, y): x pixels from the left edge, y pixels from the top edge. minItems: 2, maxItems: 2 - `string? Text` Optional key combination to hold down during this action (e.g. "ctrl", "shift", "ctrl+shift"). - `JsonElement Name = "scroll"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerWaitToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerWaitInput Input` Wait for a specified duration. - `required long Duration` Duration to wait, in seconds. maximum: 300 - `JsonElement Name = "wait"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerScreenshotToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerScreenshotInput Input` Take a screenshot of the screen. - `JsonElement Name = "screenshot"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaComputerZoomToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required BetaComputerZoomInput Input` 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. - `required IReadOnlyList Region` (x0, y0, x1, y1): The region to capture. minItems: 4, maxItems: 4 - `JsonElement Name = "zoom"` - `JsonElement ToolsetName = "computer"` - `BetaToolUseCaller Caller` Which party invoked the tool call: the model directly, or a server tool on its behalf. - `class BetaToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1 - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `string? ToolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ ### Beta URL Image Source - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` ### Beta URL PDF Source - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` ### Beta Usage - `class BetaUsage` - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long? CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long? CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required BetaFallbackCreditUsage? FallbackCredit` 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). - `required Status Status` Whether the fallback-credit reprice was applied to this response's billing. A union discriminated on `type`. `redeemed`: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - `class BetaFallbackCreditRedeemed` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `JsonElement Type = "redeemed"` - `class BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `JsonElement Type = "not_applied"` - `required Reason Reason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `BodyMismatch("body_mismatch")` - `ContinuationExcluded("continuation_excluded")` - `ContinuationOnly("continuation_only")` - `Expired("expired")` - `InvalidTargetModel("invalid_target_model")` - `NotEnabled("not_enabled")` - `RepriceUnavailable("reprice_unavailable")` - `TemporarilyUnavailable("temporarily_unavailable")` - `VariantFieldsPresent("variant_fields_present")` - `WrongOrganization("wrong_organization")` - `WrongPlatform("wrong_platform")` - `WrongWorkspace("wrong_workspace")` - `IReadOnlyList? RemoveToRedeem` 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. - `required string? InferenceGeo` The geographic region where inference was performed for this request. - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required IReadOnlyList? Iterations` 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. - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `JsonElement Type = "message"` Usage for a sampling iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model? Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `JsonElement Type = "compaction"` Usage for a compaction iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `JsonElement Type = "advisor_message"` Usage for an advisor sub-inference iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class 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`. - `JsonElement Type = "fallback_message"` Usage for the fallback-model attempt that served the response - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required BetaOutputTokensDetails? OutputTokensDetails` 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. - `required long ThinkingTokens` 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. minimum: 0 - `required BetaServerToolUsage? ServerToolUse` The number of server tool requests. - `required long WebFetchRequests` The number of web fetch tool requests. minimum: 0 - `required long WebSearchRequests` The number of web search tool requests. minimum: 0 - `required ServiceTier? ServiceTier` If the request used the priority, standard, or batch tier. - `Standard("standard")` - `Priority("priority")` - `Batch("batch")` - `required Speed? Speed` The inference speed mode used for this request. - `Standard("standard")` - `Fast("fast")` ### Beta User Location - `class BetaUserLocation` - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Beta User Message Param - `class BetaUserMessageParam` - `required BetaMessageContentParam Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaRequestDocumentBlock` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `bool Enabled` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 - `class BetaSearchResultBlockParam` - `JsonElement Type = "search_result"` - `required IReadOnlyList Content` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `required string Source` - `required string Title` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam Citations` - `class BetaThinkingBlockParam` - `JsonElement Type = "thinking"` - `required string Signature` 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`. - `required string Thinking` The `thinking` text of this block as returned by the API. - `class BetaRedactedThinkingBlockParam` - `JsonElement Type = "redacted_thinking"` - `required string Data` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `class BetaToolUseBlockParam` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1, maxLength: 200 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaToolResultBlockParam` - `JsonElement Type = "tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaSearchResultBlockParam` - `class BetaRequestDocumentBlock` - `class BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonElement Type = "browser_state"` - `required IReadOnlyList Tabs` 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 - `required string TabID` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool Active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? StateChanges` 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 - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool IsError` - `string? ToolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlockParam` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlockParam` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockParamContent Content` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string Title` - `required string Url` - `string? PageAge` - `class BetaWebSearchToolRequestError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlockParam` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlockParam` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlockParam` - `JsonElement Type = "web_fetch_result"` - `required BetaRequestDocumentBlock Content` - `required string Url` Fetched content URL - `string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlockParam` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultErrorParam` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlockParam` - `JsonElement Type = "advisor_result"` - `required string Text` - `string? StopReason` - `class BetaAdvisorRedactedResultBlockParam` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob produced by a prior response; must be round-tripped verbatim. - `string? StopReason` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCodeExecutionToolResultBlockParam` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockParamContent Content` - `class BetaCodeExecutionToolResultErrorParam` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlockParam` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlockParam` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form, sent back in a later request. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBashCodeExecutionToolResultBlockParam` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultErrorParam` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlockParam` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaTextEditorCodeExecutionToolResultBlockParam` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultErrorParam` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlockParam` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `long? NumLines` - `long? StartLine` - `long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlockParam` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `IReadOnlyList? Lines` - `long? NewLines` - `long? NewStart` - `long? OldLines` - `long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaToolSearchToolResultBlockParam` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultErrorParam` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlockParam` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaMcpToolUseBlockParam` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` - `required string ServerName` The name of the MCP server - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestMcpToolResultBlockParam` - `JsonElement Type = "mcp_tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `bool IsError` - `class BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonElement Type = "container_upload"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `JsonElement Type = "compaction"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `string? Content` Summary of previously compacted content, or null if compaction failed - `string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` The block's signature as returned, to be sent back verbatim - `IReadOnlyList? ToolChanges` 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. - `class BetaRequestToolAdditionBlock` 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolRemovalBlock` 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `required IReadOnlyList Tools` The server's tools, exactly as the response listed them. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `JsonElement Type = "fallback"` - `required BetaFallbackInfoParam From` Identifies one hop of a fallback transition. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfoParam To` Identifies one hop of a fallback transition. - `JsonElement Trigger` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `JsonElement Role = "user"` ### Beta Web Fetch Block - `class BetaWebFetchBlock` - `JsonElement Type = "web_fetch_result"` - `required BetaDocumentBlock Content` - `JsonElement Type = "document"` - `required BetaCitationConfig? Citations` Citation configuration for the document - `required bool Enabled` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `required string? Title` The title of the document - `required string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string Url` Fetched content URL ### Beta Web Fetch Block Param - `class BetaWebFetchBlockParam` - `JsonElement Type = "web_fetch_result"` - `required BetaRequestDocumentBlock Content` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `bool Enabled` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 - `required string Url` Fetched content URL - `string? RetrievedAt` ISO 8601 timestamp when the content was retrieved ### Beta Web Fetch Tool 20250910 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class 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 - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class 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 - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `bool UseCache` 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 - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `bool UseCache` 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 - `class BetaWebFetchToolResultBlock` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlock` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlock` - `JsonElement Type = "web_fetch_result"` - `required BetaDocumentBlock Content` - `JsonElement Type = "document"` - `required BetaCitationConfig? Citations` Citation configuration for the document - `required bool Enabled` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `required string? Title` The title of the document - `required string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string Url` Fetched content URL - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Web Fetch Tool Result Block Param - `class BetaWebFetchToolResultBlockParam` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlockParam` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlockParam` - `JsonElement Type = "web_fetch_result"` - `required BetaRequestDocumentBlock Content` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `bool Enabled` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 - `required string Url` Fetched content URL - `string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Web Fetch Tool Result Error Block - `class BetaWebFetchToolResultErrorBlock` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` ### Beta Web Fetch Tool Result Error Block Param - `class BetaWebFetchToolResultErrorBlockParam` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` ### Beta Web Fetch Tool Result Error Code - `enum BetaWebFetchToolResultErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` ### Beta Web Fetch URL Source All - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` ### Beta Web Fetch URL Source Except - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` ### Beta Web Fetch URL Source None - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` ### Beta Web Fetch URL Source Only - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` ### Beta Web Fetch URL Source Tool Reference - `class BetaWebFetchUrlSourceToolReference` One entry of a tool filter's `tools`: it must name a tool declared in this request's `tools[]`. - `JsonElement Type = "tool_reference"` - `required string Name` ### Beta Web Fetch URL Sources - `class 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 ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class 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 - `class BetaWebSearchResultBlock` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string? PageAge` - `required string Title` - `required string Url` ### Beta Web Search Result Block Param - `class BetaWebSearchResultBlockParam` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string Title` - `required string Url` - `string? PageAge` ### Beta Web Search Tool 20250305 - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Beta Web Search Tool 20260209 - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Beta Web Search Tool 20260318 - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 ### Beta Web Search Tool Request Error - `class BetaWebSearchToolRequestError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` ### Beta Web Search Tool Result Block - `class BetaWebSearchToolResultBlock` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockContent Content` - `class BetaWebSearchToolResultError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string? PageAge` - `required string Title` - `required string Url` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Web Search Tool Result Block Content - `class BetaWebSearchToolResultBlockContent: union` - `class BetaWebSearchToolResultError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string? PageAge` - `required string Title` - `required string Url` ### Beta Web Search Tool Result Block Param - `class BetaWebSearchToolResultBlockParam` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockParamContent Content` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string Title` - `required string Url` - `string? PageAge` - `class BetaWebSearchToolRequestError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ ### Beta Web Search Tool Result Block Param Content - `class BetaWebSearchToolResultBlockParamContent: union` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string Title` - `required string Url` - `string? PageAge` - `class BetaWebSearchToolRequestError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` ### Beta Web Search Tool Result Error - `class BetaWebSearchToolResultError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` ### Beta Web Search Tool Result Error Code - `enum BetaWebSearchToolResultErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` ## Messages › Batches ### Create a Message Batch `BetaMessageBatch Beta.Messages.Batches.Create(parameters, cancellationToken = default)` **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=csharp) #### Parameters - `BatchCreateParams parameters` - `required IReadOnlyList requests` List of requests for prompt completion. Each is an individual request to create a Message. minItems: 1, maxItems: 100000 - `required string CustomID` 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}$ - `required Params Params` Messages API creation parameters for the individual request. See the [Messages API reference](https://platform.claude.com/docs/en/api/messages?sdk_languages=csharp) for full documentation on available parameters. - `required long MaxTokens` 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=csharp#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=csharp) for details. minimum: 0 - `required IReadOnlyList Messages` 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=csharp#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=csharp). 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=csharp#give-claude-a-role), you can use the top-level `system` parameter. There is a limit of 100,000 messages in a single request. - `class BetaUserMessageParam` - `required BetaMessageContentParam Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `IReadOnlyList? Citations` - `class BetaCitationCharLocationParam` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndCharIndex` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocationParam` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndPageNumber` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocationParam` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` minLength: 1, maxLength: 500 - `required long EndBlockIndex` 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`. - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationWebSearchResultLocationParam` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` minLength: 1, maxLength: 512 - `required string Url` minLength: 1 - `class BetaCitationSearchResultLocationParam` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `class BetaImageBlockParam` - `JsonElement Type = "image"` - `required Source Source` - `class BetaBase64ImageSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `required MediaType MediaType` - `ImageJpeg("image/jpeg")` - `ImagePng("image/png")` - `ImageGif("image/gif")` - `ImageWebP("image/webp")` - `class BetaUrlImageSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileImageSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaImageTransformationsParam? Transformations` 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 OversizedImage` What the server does when this image exceeds the model's maximum image size. `"downsize"` (the default) scales the image down to fit, which changes the dimensions the model observes without telling you. `"error"` instead rejects the request with a 400 error naming the image's dimensions and the largest dimensions that fit, so you can scale the image deliberately — your image is never silently scaled down. - `Downsize("downsize")` - `Error("error")` - `class BetaRequestDocumentBlock` - `JsonElement Type = "document"` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `class BetaContentBlockSource` - `JsonElement Type = "content"` - `required Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaUrlPdfSource` - `JsonElement Type = "url"` - `required string Url` - `class BetaFileDocumentSource` - `JsonElement Type = "file"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` - `bool Enabled` - `string? Context` minLength: 1 - `string? Title` minLength: 1, maxLength: 500 - `class BetaSearchResultBlockParam` - `JsonElement Type = "search_result"` - `required IReadOnlyList Content` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `required string Source` - `required string Title` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam Citations` - `class BetaThinkingBlockParam` - `JsonElement Type = "thinking"` - `required string Signature` 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`. - `required string Thinking` The `thinking` text of this block as returned by the API. - `class BetaRedactedThinkingBlockParam` - `JsonElement Type = "redacted_thinking"` - `required string Data` The `data` value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged. - `class BetaToolUseBlockParam` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1, maxLength: 200 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family this member belongs to. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaToolResultBlockParam` - `JsonElement Type = "tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaImageBlockParam` - `class BetaSearchResultBlockParam` - `class BetaRequestDocumentBlock` - `class BetaToolReferenceBlockParam` Tool reference block that can be included in tool_result content. - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBrowserStateBlockParam` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side effects (tabs opened, download state changes) the call produced. At most one per `tool_result`, only on a non-error result answering a browser toolset member `tool_use`. The server renders the model-visible text from it; the model never sees the raw fields. - `JsonElement Type = "browser_state"` - `required IReadOnlyList Tabs` 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 - `required string TabID` The caller-assigned identifier for this tab, unique within the inventory. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Title` The title of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `required string Url` The URL of the page the tab is showing. May be empty. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool Active` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? StateChanges` 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 - `class BetaBrowserStateChangeTabOpened` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log. Carries only the `tab_id`; the tab's `title` and `url` live on its `tabs` entry, which must include the same `tab_id`. A tab opened during a failed call gets no deferred `tab_opened`; it simply appears in the next result's `tabs` inventory. - `JsonElement Type = "tab_opened"` - `required string TabID` The `tab_id` of the opened tab, present in `tabs`. minLength: 1, maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadStarted` A file download that started during this call. - `JsonElement Type = "download_started"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `class BetaBrowserStateChangeDownloadCompleted` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior `download_started`, when the download finished during the call that started it (at most one state change per `download_id` per result). - `JsonElement Type = "download_completed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Path` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `long? SizeBytes` The completed download's size. minimum: 0 - `class BetaBrowserStateChangeDownloadFailed` A file download that failed — or was cancelled — during this call. - `JsonElement Type = "download_failed"` - `required string DownloadID` 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]*$ - `required string Url` The final post-redirect URL the download was served from. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `string? Error` The failure or cancellation detail, when known. maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ - `bool IsError` - `string? ToolsetName` For a toolset member tool_result, the toolset family of the paired tool_use. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlockParam` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlockParam` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockParamContent Content` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string Title` - `required string Url` - `string? PageAge` - `class BetaWebSearchToolRequestError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlockParam` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlockParam` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlockParam` - `JsonElement Type = "web_fetch_result"` - `required BetaRequestDocumentBlock Content` - `required string Url` Fetched content URL - `string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlockParam` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultErrorParam` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlockParam` - `JsonElement Type = "advisor_result"` - `required string Text` - `string? StopReason` - `class BetaAdvisorRedactedResultBlockParam` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob produced by a prior response; must be round-tripped verbatim. - `string? StopReason` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCodeExecutionToolResultBlockParam` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockParamContent Content` - `class BetaCodeExecutionToolResultErrorParam` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlockParam` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlockParam` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form, sent back in a later request. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaBashCodeExecutionToolResultBlockParam` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultErrorParam` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlockParam` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaTextEditorCodeExecutionToolResultBlockParam` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultErrorParam` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlockParam` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `long? NumLines` - `long? StartLine` - `long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlockParam` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlockParam` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `IReadOnlyList? Lines` - `long? NewLines` - `long? NewStart` - `long? OldLines` - `long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaToolSearchToolResultBlockParam` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultErrorParam` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlockParam` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaMcpToolUseBlockParam` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` - `required string ServerName` The name of the MCP server - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestMcpToolResultBlockParam` - `JsonElement Type = "mcp_tool_result"` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `bool IsError` - `class BetaContainerUploadBlockParam` A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory. - `JsonElement Type = "container_upload"` - `required string FileID` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaCompactionBlockParam` A compaction block containing summary of previous context. Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries. When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed. - `JsonElement Type = "compaction"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `string? Content` Summary of previously compacted content, or null if compaction failed - `string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` The block's signature as returned, to be sent back verbatim - `IReadOnlyList? ToolChanges` 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. - `class BetaRequestToolAdditionBlock` 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `JsonElement Type = "tool_reference"` - `required string Name` pattern: ^[a-zA-Z0-9_-]{1,128}$ - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaToolUnion Definition` - `class BetaTool` - `Type? Type` - `required InputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolRemovalBlock` 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` - `class BetaToolChangeToolReference` 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. - `class BetaToolChangeMcpToolReference` Reference to a single MCP tool by its server and remote name; the same `server_name`/`name` pair `mcp_tool_use` carries. - `class BetaToolChangeMcpToolsetReference` Reference to every tool in the named MCP server's toolset. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` The name of the MCP server this listing came from, as `mcp_servers` declares it. minLength: 1, maxLength: 255 - `required IReadOnlyList Tools` The server's tools, exactly as the response listed them. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class BetaFallbackBlockParam` A `fallback` block echoed back from a prior response. Accepted in `messages[].content` and not rendered into the prompt; not validated against the request's `fallbacks` chain or top-level `model`. Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect. - `JsonElement Type = "fallback"` - `required BetaFallbackInfoParam From` Identifies one hop of a fallback transition. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfoParam To` Identifies one hop of a fallback transition. - `JsonElement Trigger` The response block's `trigger`, echoed verbatim. Accepted and ignored by the server; any object or `null` is allowed. - `JsonElement Role = "user"` - `class BetaAssistantMessageParam` - `required BetaMessageContentParam Content` - `JsonElement Role = "assistant"` - `class BetaSystemMessageParam` - `JsonElement Role = "system"` - `ClearAt? ClearAt` 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. - `NextUserMessage("next_user_message")` - `Never("never")` - `Content Content` - `string` - `IReadOnlyList` - `class BetaTextBlockParam` - `class BetaRequestToolAdditionBlock` 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. - `class BetaRequestToolRemovalBlock` 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. - `BetaSystemMessageOutputConfig? OutputConfig` 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? Effort` 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`. - `Low("low")` - `Medium("medium")` - `High("high")` - `Xhigh("xhigh")` - `Max("max")` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `BetaCacheControlEphemeral? CacheControl` Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. - `BetaCompactionConfig? Compaction` 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`. - `JsonElement Type = "summarize"` - `string? Instructions` Replaces the server's default summarization prompt for this request. An empty or whitespace-only value counts as absent. maxLength: 16384 - `Container? Container` Container identifier for reuse across requests. - `class BetaContainerParams` Container parameters with skills to be loaded. - `string? ID` Container id - `IReadOnlyList? Skills` List of skills to load in the container maxItems: 20 - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `string Version` Skill version or 'latest' for most recent version minLength: 1, maxLength: 64 - `string` - `BetaContextManagementConfig? ContextManagement` Context management configuration. This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. - `IReadOnlyList Edits` List of context management edits to apply - `class BetaClearToolUses20250919Edit` - `JsonElement Type = "clear_tool_uses_20250919"` - `BetaInputTokensClearAtLeast? ClearAtLeast` Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. - `JsonElement Type = "input_tokens"` - `required long Value` minimum: 0 - `ClearToolInputs? ClearToolInputs` Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) - `bool` - `IReadOnlyList` - `IReadOnlyList? ExcludeTools` Tool names whose uses are preserved from clearing - `BetaToolUsesKeep Keep` Number of tool uses to retain in the conversation - `JsonElement Type = "tool_uses"` - `required long Value` minimum: 0 - `Trigger Trigger` Condition that triggers the context management strategy - `class BetaInputTokensTrigger` - `JsonElement Type = "input_tokens"` - `required long Value` minimum: 1 - `class BetaToolUsesTrigger` - `JsonElement Type = "tool_uses"` - `required long Value` minimum: 1 - `class BetaClearThinking20251015Edit` - `JsonElement Type = "clear_thinking_20251015"` - `Keep Keep` Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. - `class BetaThinkingTurns` - `JsonElement Type = "thinking_turns"` - `required long Value` minimum: 1 - `class BetaAllThinkingTurns` - `JsonElement Type = "all"` - `class All:` - `class BetaCompact20260112Edit` Automatically compact older context when reaching the configured trigger threshold. - `JsonElement Type = "compact_20260112"` - `string? Instructions` Additional instructions for summarization. - `bool PauseAfterCompaction` Whether to pause after compaction and return the compaction block to the user. - `BetaInputTokensTrigger? Trigger` When to trigger compaction. Defaults to 150000 input tokens. - `BetaDiagnosticsParam? Diagnostics` 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. - `string? PreviousMessageID` The `id` (`msg_...`) from this client's previous /v1/messages response. The server compares that request's prompt fingerprint against this one and returns `diagnostics.cache_miss_reason` when the prompt-cache prefix could not be reused. Pass `null` on the first turn to opt in without a prior message to compare. maxLength: 256 - `FallbackCreditToken? FallbackCreditToken` 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` - `class BetaFallbackCreditTokenParam` Object form of `fallback_credit_token`: the token plus a redemption mode. Requires `anthropic-beta: fallback-credit-2026-07-01`; without that header the field accepts the bare string only. The bare string and the mode-less object are equivalent (both select `strict`), so wrapping an existing token changes nothing by itself. - `required string Token` 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 Mode` 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`. - `Strict("strict")` - `BestEffort("best_effort")` - `BetaFallbacksParam? Fallbacks` 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=csharp#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. - `IReadOnlyList` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `long? MaxTokens` The `max_tokens` for the fallback attempt that uses this `fallbacks` entry's `model`, in place of the request's `max_tokens`. If you leave it out or set it to `null`, the attempt uses the request's `max_tokens`. See the [refusals and fallback guide](https://platform.claude.com/docs/en/build-with-claude/refusals-and-fallback?sdk_languages=csharp#naming-your-own-fallback-models) to learn more about fallback entries. - `BetaOutputConfig? OutputConfig` Output parameters for the fallback attempt that uses this `fallbacks` entry's `model`, combined with the request's `output_config` one field at a time. - `format`: If you leave it out, the attempt uses the request's `format`. If you set it to `null`, the attempt runs without a format. - `effort`: If you leave it out, the attempt uses the request's `effort` when `model` supports that level with the attempt's `thinking`. If the request doesn't set `effort`, if `model` doesn't support the level, or if you set `effort` to `null`, the attempt runs at the default effort of `model`. - `task_budget`: If you leave it out, the attempt uses the request's `task_budget` when `model` accepts a task budget of that size. If the request doesn't set `task_budget`, if `model` doesn't accept it, or if you set `task_budget` to `null`, the attempt runs without a task budget. Set `output_config` to `null` to run the attempt without a format or a task budget, at the default effort of `model`. These rules apply with the `server-side-fallback-2026-07-01` beta header. - `Effort? Effort` 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`. - `Low("low")` - `Medium("medium")` - `High("high")` - `Xhigh("xhigh")` - `Max("max")` - `BetaJsonOutputFormat? Format` 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=csharp) - `JsonElement Type = "json_schema"` - `required IReadOnlyDictionary Schema` The JSON schema of the format - `BetaTokenTaskBudget? TaskBudget` Configuration for token budget tracking across contexts. - `JsonElement Type = "tokens"` The budget type. Currently only 'tokens' is supported. - `required long Total` Total token budget across all contexts in the session. minimum: 1024 - `long? Remaining` 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? Speed` The inference speed mode for the fallback attempt that uses this `fallbacks` entry's `model`. If you leave it out, the attempt runs at `fast` speed only when the request sets `speed` to `fast` and your organization can use fast mode on `model`. Otherwise, or when you set this field to `null`, the attempt runs at `standard` speed. These rules apply with the `server-side-fallback-2026-07-01` beta header. - `Standard("standard")` - `Fast("fast")` - `Thinking? Thinking` The thinking configuration for the fallback attempt that uses this `fallbacks` entry's `model`. If you leave it out, the attempt uses the request's `thinking` when `model` supports that thinking `type`. If you leave it out and the request's thinking `type` is `between_tools` but `model` doesn't support `between_tools`, the attempt uses `disabled` if `model` supports it. Otherwise, if `model` doesn't support the request's thinking `type`, if the request doesn't set `thinking`, or if you set this field to `null`, the attempt uses the thinking `type` that `model` uses when a request leaves out `thinking`. The request's `thinking.display` still applies where `model` allows it. These rules apply with the `server-side-fallback-2026-07-01` beta header. - `class BetaThinkingConfigEnabled` - `JsonElement Type = "enabled"` - `required long BudgetTokens` 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=csharp) for details. minimum: 1024 - `BetaThinkingBlockBinding? BlockBinding` 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. - `BetaThinkingPrefixMismatchBehavior? PrefixMismatchBehavior` "error" (default) | "drop_block". What happens when a thinking block in `messages` fails the conversation check (it was created in a different conversation, or the messages before it have changed since). "error" fails the request with a 400 error. "drop_block" removes the failing blocks and the request proceeds; each removal is reported in `input_transformations`. - `Error("error")` - `DropBlock("drop_block")` - `Display? Display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#controlling-thinking-display). - `Summarized("summarized")` - `Omitted("omitted")` - `Updates("updates")` - `class BetaThinkingConfigDisabled` - `JsonElement Type = "disabled"` - `class BetaThinkingConfigBetweenTools` - `JsonElement Type = "between_tools"` - `class BetaThinkingConfigAdaptive` - `JsonElement Type = "adaptive"` - `BetaThinkingBlockBinding? BlockBinding` 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? Display` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. The default depends on the model; see [Controlling thinking display](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#controlling-thinking-display). - `Summarized("summarized")` - `Omitted("omitted")` - `Updates("updates")` - `JsonElement` - `string? InferenceGeo` Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `IReadOnlyList McpServers` MCP servers to be utilized in this request maxItems: 20 - `JsonElement Type = "url"` - `required string Name` - `required string Url` - `string? AuthorizationToken` - `BetaRequestMcpServerToolConfiguration? ToolConfiguration` - `IReadOnlyList? AllowedTools` - `bool? Enabled` - `BetaMetadata Metadata` An object describing metadata about the request. - `string? UserID` 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 - `BetaOutputConfig OutputConfig` Configuration options for the model's output, such as the output format. - `ServiceTier ServiceTier` 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=csharp) for details. - `Auto("auto")` - `StandardOnly("standard_only")` - `Speed? Speed` 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=csharp) for which models. - `Standard("standard")` - `Fast("fast")` - `IReadOnlyList StopSequences` 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. - `bool Stream` 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=csharp#streaming-with-sdks) for an example in each language. - `System System` 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=csharp#give-claude-a-role). - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required string Text` minLength: 1 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyList? Citations` - `BetaThinkingConfigParam Thinking` Configuration for Claude's thinking. With `{"type": "adaptive"}`, Claude decides when and how much to think. With `{"type": "enabled"}` (manual extended thinking), you set a `budget_tokens` of at least 1,024. Thinking tokens count toward your `max_tokens` limit. Which `type` values are accepted, and what happens when you omit `thinking`, depend on the model. See [thinking](https://platform.claude.com/docs/en/build-with-claude/thinking?sdk_languages=csharp#configuring-thinking) for each model's behavior. - `class BetaThinkingConfigEnabled` - `class BetaThinkingConfigDisabled` - `class BetaThinkingConfigBetweenTools` - `class BetaThinkingConfigAdaptive` - `BetaMessageThreadParam? Thread` Server-held conversation state (a Thread). `{"type": "create"}` asks the server to hold this conversation's state under the response's `id`; `{"type": "continue", "previous_message_id": ...}` resumes from a previous response so only the new turn's messages are sent. The response shape is unchanged. - `class BetaThreadCreateParams` Start holding conversation state under this response's `id`. - `JsonElement Type = "create"` - `class BetaThreadContinueParams` Resume from the response named by `previous_message_id`. - `JsonElement Type = "continue"` - `required string PreviousMessageID` The `id` of the previous response in this Thread. - `BetaToolChoice ToolChoice` 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. - `class BetaToolChoiceAuto` The model will automatically decide whether to use tools. - `JsonElement Type = "auto"` - `bool DisableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `class BetaToolChoiceAny` The model will use any available tools. - `JsonElement Type = "any"` - `bool DisableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `class BetaToolChoiceTool` The model will use the specified tool with `tool_choice.name`. - `JsonElement Type = "tool"` - `required string Name` The name of the tool to use. - `bool DisableParallelToolUse` Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `class BetaToolChoiceNone` The model will not be allowed to use tools. - `JsonElement Type = "none"` - `IReadOnlyList Tools` 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=csharp), 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=csharp)). 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=csharp) for more details. - `class BetaTool` - `class BetaToolBash20241022` - `class BetaToolBash20250124` - `class BetaCodeExecutionTool20250522` - `class BetaCodeExecutionTool20250825` - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `class BetaToolComputerUse20241022` - `class BetaMemoryTool20250818` - `class BetaToolComputerUse20250124` - `class BetaToolTextEditor20241022` - `class BetaToolComputerUse20251124` - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `class BetaToolTextEditor20250124` - `class BetaToolTextEditor20250429` - `class BetaToolTextEditor20250728` - `class BetaWebSearchTool20250305` - `class BetaWebFetchTool20250910` - `class BetaWebSearchTool20260209` - `class BetaWebFetchTool20260209` - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `class BetaWebSearchTool20260318` - `class BetaWebFetchTool20260318` - `class BetaAdvisorTool20260301` - `class BetaToolSearchToolBm25_20251119` - `class BetaToolSearchToolRegex20251119` - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `BetaJsonOutputFormat? OutputFormat` **Deprecated** Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs?sdk_languages=csharp) A schema to specify Claude's output format in responses. This parameter will be removed in a future release. - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string userProfileID` (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. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. - `string workspaceID` (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 - `class BetaMessageBatch` - `JsonElement Type = "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required DateTimeOffset? ArchivedAt` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `required DateTimeOffset? CancelInitiatedAt` 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 - `required DateTimeOffset CreatedAt` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `required DateTimeOffset? EndedAt` 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 - `required DateTimeOffset ExpiresAt` 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 - `required ProcessingStatus ProcessingStatus` Processing status of the Message Batch. - `InProgress("in_progress")` - `Canceling("canceling")` - `Ended("ended")` - `required BetaMessageBatchRequestCounts RequestCounts` 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. - `required long Canceled` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `required long Errored` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `required long Expired` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `required long Processing` Number of requests in the Message Batch that are processing. - `required long Succeeded` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `required string? ResultsUrl` 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 ```csharp using System; using System.Collections.Generic; using System.Text.Json; using Messages = Anthropic.Models.Beta.Messages; using Anthropic.Models.Beta.Messages.Batches; using ModelsMessages = Anthropic.Models.Messages; BatchCreateParams parameters = new() { Requests = [ new() { CustomID = "my-custom-id-1", Params = new() { MaxTokens = 1024, Messages = [ new Messages::BetaUserMessageParam("Hello, world") ], Model = ModelsMessages::Model.ClaudeOpus5_5, CacheControl = new() { Ttl = Messages::Ttl.Ttl5m }, Compaction = new() { Instructions = "instructions" }, Container = new Messages::BetaContainerParams() { ID = "id", Skills = [ new() { SkillID = "pdf", Type = Messages::BetaSkillParamsType.Anthropic, Version = "latest", }, ], }, ContextManagement = new() { Edits = [ new Messages::BetaClearToolUses20250919Edit() { ClearAtLeast = new(0), ClearToolInputs = true, ExcludeTools = [ "string" ], Keep = new(0), Trigger = new Messages::BetaInputTokensTrigger(1), }, ], }, Diagnostics = new() { PreviousMessageID = "previous_message_id" }, FallbackCreditToken = "x", Fallbacks = new Messages::Default(), InferenceGeo = "inference_geo", McpServers = [ new() { Name = "name", Url = "url", AuthorizationToken = "authorization_token", ToolConfiguration = new() { AllowedTools = [ "string" ], Enabled = true, }, }, ], Metadata = new() { UserID = "13803d75-b4b5-4c3e-b2a2-6f21399b021b" }, OutputConfig = new() { Effort = Messages::Effort.Low, Format = new() { Schema = new Dictionary() { { "foo", JsonSerializer.SerializeToElement("bar") } }, }, TaskBudget = new() { Total = 1024, Remaining = 0, }, }, OutputFormat = new() { Schema = new Dictionary() { { "foo", JsonSerializer.SerializeToElement("bar") } }, }, ServiceTier = ServiceTier.Auto, Speed = Speed.Standard, StopSequences = [ "string" ], Stream = false, System = new( [ new Messages::BetaTextBlockParam() { Text = "Today's date is 2024-06-01.", CacheControl = new() { Ttl = Messages::Ttl.Ttl5m }, Citations = [ new Messages::BetaCitationCharLocationParam() { CitedText = "The grass is green. The sky is blue.", DocumentIndex = 0, DocumentTitle = "x", EndCharIndex = 0, StartCharIndex = 0, }, ], }, ] ), Thinking = new Messages::BetaThinkingConfigAdaptive() { BlockBinding = new() { PrefixMismatchBehavior = Messages::BetaThinkingPrefixMismatchBehavior.Error, }, Display = Messages::Display.Summarized, }, Thread = new Messages::BetaThreadCreateParams(), ToolChoice = new Messages::BetaToolChoiceAuto() { DisableParallelToolUse = true }, Tools = [ new Messages::BetaTool() { InputSchema = new() { Properties = new Dictionary() { { "location", JsonSerializer.SerializeToElement("bar") }, { "unit", JsonSerializer.SerializeToElement("bar") }, }, Required = [ "location" ], }, Name = "name", AllowedCallers = [ Messages::BetaToolAllowedCaller.Direct ], CacheControl = new() { Ttl = Messages::Ttl.Ttl5m }, DeferLoading = true, Description = "Get the current weather in a given location", EagerInputStreaming = true, InputExamples = [ new Dictionary() { { "foo", JsonSerializer.SerializeToElement("bar") }, }, ], Strict = true, Type = Messages::BetaToolType.Custom, }, ], }, }, ], }; var betaMessageBatch = await client.Beta.Messages.Batches.Create(parameters); Console.WriteLine(betaMessageBatch); ``` ##### 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 `BetaMessageBatch Beta.Messages.Batches.Retrieve(parameters, cancellationToken = default)` **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=csharp) #### Parameters - `BatchRetrieveParams parameters` - `required string messageBatchID` (path parameter) ID of the Message Batch. - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (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 - `class BetaMessageBatch` - `JsonElement Type = "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required DateTimeOffset? ArchivedAt` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `required DateTimeOffset? CancelInitiatedAt` 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 - `required DateTimeOffset CreatedAt` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `required DateTimeOffset? EndedAt` 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 - `required DateTimeOffset ExpiresAt` 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 - `required ProcessingStatus ProcessingStatus` Processing status of the Message Batch. - `InProgress("in_progress")` - `Canceling("canceling")` - `Ended("ended")` - `required BetaMessageBatchRequestCounts RequestCounts` 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. - `required long Canceled` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `required long Errored` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `required long Expired` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `required long Processing` Number of requests in the Message Batch that are processing. - `required long Succeeded` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `required string? ResultsUrl` 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 ```csharp using System; using Anthropic.Models.Beta.Messages.Batches; BatchRetrieveParams parameters = new() { MessageBatchID = "message_batch_id" }; var betaMessageBatch = await client.Beta.Messages.Batches.Retrieve(parameters); Console.WriteLine(betaMessageBatch); ``` ##### 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 `BatchListPage Beta.Messages.Batches.List(parameters, cancellationToken = default)` **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=csharp) #### Parameters - `BatchListParams parameters` - `string afterID` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object. - `string beforeID` (query parameter) ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object. - `long limit` (query parameter) Number of items to return per page. Defaults to `20`. Ranges from `1` to `1000`. minimum: 1, maximum: 1000 - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (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 - `class BetaMessageBatch` - `JsonElement Type = "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required DateTimeOffset? ArchivedAt` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `required DateTimeOffset? CancelInitiatedAt` 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 - `required DateTimeOffset CreatedAt` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `required DateTimeOffset? EndedAt` 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 - `required DateTimeOffset ExpiresAt` 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 - `required ProcessingStatus ProcessingStatus` Processing status of the Message Batch. - `InProgress("in_progress")` - `Canceling("canceling")` - `Ended("ended")` - `required BetaMessageBatchRequestCounts RequestCounts` 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. - `required long Canceled` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `required long Errored` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `required long Expired` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `required long Processing` Number of requests in the Message Batch that are processing. - `required long Succeeded` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `required string? ResultsUrl` 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 ```csharp using System; using Anthropic.Models.Beta.Messages.Batches; BatchListParams parameters = new(); var page = await client.Beta.Messages.Batches.List(parameters); await foreach (var item in page.Paginate()) { Console.WriteLine(item); } ``` ##### 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 `BetaMessageBatch Beta.Messages.Batches.Cancel(parameters, cancellationToken = default)` **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=csharp) #### Parameters - `BatchCancelParams parameters` - `required string messageBatchID` (path parameter) ID of the Message Batch. - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (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 - `class BetaMessageBatch` - `JsonElement Type = "message_batch"` Object type. For Message Batches, this is always `"message_batch"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required DateTimeOffset? ArchivedAt` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. format: date-time - `required DateTimeOffset? CancelInitiatedAt` 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 - `required DateTimeOffset CreatedAt` RFC 3339 datetime string representing the time at which the Message Batch was created. format: date-time - `required DateTimeOffset? EndedAt` 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 - `required DateTimeOffset ExpiresAt` 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 - `required ProcessingStatus ProcessingStatus` Processing status of the Message Batch. - `InProgress("in_progress")` - `Canceling("canceling")` - `Ended("ended")` - `required BetaMessageBatchRequestCounts RequestCounts` 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. - `required long Canceled` Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `required long Errored` Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `required long Expired` Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `required long Processing` Number of requests in the Message Batch that are processing. - `required long Succeeded` Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `required string? ResultsUrl` 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 ```csharp using System; using Anthropic.Models.Beta.Messages.Batches; BatchCancelParams parameters = new() { MessageBatchID = "message_batch_id" }; var betaMessageBatch = await client.Beta.Messages.Batches.Cancel(parameters); Console.WriteLine(betaMessageBatch); ``` ##### 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 `BetaDeletedMessageBatch Beta.Messages.Batches.Delete(parameters, cancellationToken = default)` **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=csharp) #### Parameters - `BatchDeleteParams parameters` - `required string messageBatchID` (path parameter) ID of the Message Batch. - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (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 - `class BetaDeletedMessageBatch` - `JsonElement Type = "message_batch_deleted"` Deleted object type. For Message Batches, this is always `"message_batch_deleted"`. - `required string ID` ID of the Message Batch. #### Example ```csharp using System; using Anthropic.Models.Beta.Messages.Batches; BatchDeleteParams parameters = new() { MessageBatchID = "message_batch_id" }; var betaDeletedMessageBatch = await client.Beta.Messages.Batches.Delete(parameters); Console.WriteLine(betaDeletedMessageBatch); ``` ##### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "type": "message_batch_deleted" } ``` ### Retrieve Message Batch results `IAsyncEnumerable Beta.Messages.Batches.ResultsStreaming(parameters, cancellationToken = default)` **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=csharp) #### Parameters - `BatchResultsParams parameters` - `required string messageBatchID` (path parameter) ID of the Message Batch. - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (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 - `class BetaMessageBatchIndividualResponse` This is a single line in the response `.jsonl` file and does not represent the response as a whole. - `required string CustomID` 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. - `required BetaMessageBatchResult Result` 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. - `class BetaMessageBatchSucceededResult` - `JsonElement Type = "succeeded"` - `required BetaMessage Message` - `JsonElement Type = "message"` Object type. For Messages, this is always `"message"`. - `required string ID` Unique object identifier. The format and length of IDs may change over time. - `required BetaContainer? Container` Information about the container used in this request. This will be non-null if a container tool (e.g. code execution) was used. - `required string ID` Identifier for the container used in this request - `required DateTimeOffset ExpiresAt` The time at which the container will expire. format: date-time - `required IReadOnlyList? Skills` Skills loaded in the container - `required Type Type` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) - `Anthropic("anthropic")` - `Custom("custom")` - `required string SkillID` Skill ID minLength: 1, maxLength: 64 - `required string Version` The resolved version: a skill version ID for custom skills. minLength: 1, maxLength: 64 - `required IReadOnlyList Content` 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)"}] ``` - `class BetaTextBlock` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` Citations supporting the text block. The type of citation returned will depend on the type of document being cited. Citing a PDF results in `page_location`, plain text results in `char_location`, and content document results in `content_block_location`. - `class BetaCitationCharLocation` - `JsonElement Type = "char_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndCharIndex` - `required string? FileID` - `required long StartCharIndex` minimum: 0 - `class BetaCitationPageLocation` - `JsonElement Type = "page_location"` - `required string CitedText` - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndPageNumber` - `required string? FileID` - `required long StartPageNumber` minimum: 1 - `class BetaCitationContentBlockLocation` - `JsonElement Type = "content_block_location"` - `required string CitedText` 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. - `required long DocumentIndex` minimum: 0 - `required string? DocumentTitle` - `required long EndBlockIndex` 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`. - `required string? FileID` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `class BetaCitationsWebSearchResultLocation` - `JsonElement Type = "web_search_result_location"` - `required string CitedText` - `required string EncryptedIndex` - `required string? Title` maxLength: 512 - `required string Url` - `class BetaCitationSearchResultLocation` - `JsonElement Type = "search_result_location"` - `required string CitedText` 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. - `required long EndBlockIndex` 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`. - `required long SearchResultIndex` 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 - `required string Source` - `required long StartBlockIndex` 0-based index of the first cited block in the source's `content` array. minimum: 0 - `required string? Title` - `required string Text` - `class BetaThinkingBlock` - `JsonElement Type = "thinking"` - `required string Signature` 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=csharp) for details. - `required string Thinking` The text of Claude's thinking process for this block. - `class BetaRedactedThinkingBlock` - `JsonElement Type = "redacted_thinking"` - `required string Data` 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=csharp#redacted-thinking-blocks) for details. - `class BetaToolUseBlock` - `JsonElement Type = "tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` minLength: 1 - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `JsonElement Type = "direct"` - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `JsonElement Type = "code_execution_20250825"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaServerToolCaller20260120` - `JsonElement Type = "code_execution_20260120"` - `required string ToolID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `string? ToolsetName` For a toolset member tool_use, the toolset family. minLength: 1, maxLength: 64, pattern: ^[a-zA-Z0-9_-]+$ - `class BetaServerToolUseBlock` - `JsonElement Type = "server_tool_use"` - `required string ID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `required IReadOnlyDictionary Input` - `required Name Name` - `Advisor("advisor")` - `WebSearch("web_search")` - `WebFetch("web_fetch")` - `CodeExecution("code_execution")` - `BashCodeExecution("bash_code_execution")` - `TextEditorCodeExecution("text_editor_code_execution")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebSearchToolResultBlock` - `JsonElement Type = "web_search_tool_result"` - `required BetaWebSearchToolResultBlockContent Content` - `class BetaWebSearchToolResultError` - `JsonElement Type = "web_search_tool_result_error"` - `required BetaWebSearchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `MaxUsesExceeded("max_uses_exceeded")` - `TooManyRequests("too_many_requests")` - `QueryTooLong("query_too_long")` - `RequestTooLarge("request_too_large")` - `IReadOnlyList` - `JsonElement Type = "web_search_result"` - `required string EncryptedContent` - `required string? PageAge` - `required string Title` - `required string Url` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaWebFetchToolResultBlock` - `JsonElement Type = "web_fetch_tool_result"` - `required Content Content` - `class BetaWebFetchToolResultErrorBlock` - `JsonElement Type = "web_fetch_tool_result_error"` - `required BetaWebFetchToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `UrlTooLong("url_too_long")` - `UrlNotAllowed("url_not_allowed")` - `UrlNotInPriorContext("url_not_in_prior_context")` - `UrlNotAccessible("url_not_accessible")` - `UnsupportedContentType("unsupported_content_type")` - `TooManyRequests("too_many_requests")` - `MaxUsesExceeded("max_uses_exceeded")` - `Unavailable("unavailable")` - `ContentTooLarge("content_too_large")` - `class BetaWebFetchBlock` - `JsonElement Type = "web_fetch_result"` - `required BetaDocumentBlock Content` - `JsonElement Type = "document"` - `required BetaCitationConfig? Citations` Citation configuration for the document - `required bool Enabled` - `required Source Source` - `class BetaBase64PdfSource` - `JsonElement Type = "base64"` - `required string Data` format: byte - `JsonElement MediaType = "application/pdf"` - `class BetaPlainTextSource` - `JsonElement Type = "text"` - `required string Data` - `JsonElement MediaType = "text/plain"` - `required string? Title` The title of the document - `required string? RetrievedAt` ISO 8601 timestamp when the content was retrieved - `required string Url` Fetched content URL - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `Caller Caller` - `class BetaDirectCaller` Tool invocation directly from the model. - `class BetaServerToolCaller` Tool invocation generated by a server-side tool. - `class BetaServerToolCaller20260120` - `class BetaAdvisorToolResultBlock` - `JsonElement Type = "advisor_tool_result"` - `required Content Content` - `class BetaAdvisorToolResultError` - `JsonElement Type = "advisor_tool_result_error"` - `required ErrorCode ErrorCode` - `MaxUsesExceeded("max_uses_exceeded")` - `PromptTooLong("prompt_too_long")` - `TooManyRequests("too_many_requests")` - `Overloaded("overloaded")` - `Unavailable("unavailable")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `ModelNotFound("model_not_found")` - `class BetaAdvisorResultBlock` - `JsonElement Type = "advisor_result"` - `required string? StopReason` 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. - `required string Text` - `class BetaAdvisorRedactedResultBlock` - `JsonElement Type = "advisor_redacted_result"` - `required string EncryptedContent` Opaque blob containing the advisor's output. Round-trip verbatim; do not inspect or modify. - `required string? StopReason` The advisor sub-inference's stop reason (same values as the top-level message `stop_reason`). - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaCodeExecutionToolResultBlock` - `JsonElement Type = "code_execution_tool_result"` - `required BetaCodeExecutionToolResultBlockContent Content` - `class BetaCodeExecutionToolResultError` - `JsonElement Type = "code_execution_tool_result_error"` - `required BetaCodeExecutionToolResultErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `class BetaCodeExecutionResultBlock` - `JsonElement Type = "code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `class BetaEncryptedCodeExecutionResultBlock` The output and exit code of Python code that Claude ran with the code execution tool, with standard output in encrypted form. The API returns this block in place of `code_execution_result` when the code called the web search tool. See the [programmatic tool calling guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/programmatic-tool-calling?sdk_languages=csharp) to learn more about programmatic tool calling. - `JsonElement Type = "encrypted_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "code_execution_output"` - `required string FileID` - `required string EncryptedStdout` - `required long ReturnCode` - `required string Stderr` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaBashCodeExecutionToolResultBlock` - `JsonElement Type = "bash_code_execution_tool_result"` - `required Content Content` - `class BetaBashCodeExecutionToolResultError` - `JsonElement Type = "bash_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `OutputFileTooLarge("output_file_too_large")` - `class BetaBashCodeExecutionResultBlock` - `JsonElement Type = "bash_code_execution_result"` - `required IReadOnlyList Content` - `JsonElement Type = "bash_code_execution_output"` - `required string FileID` - `required long ReturnCode` - `required string Stderr` - `required string Stdout` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaTextEditorCodeExecutionToolResultBlock` - `JsonElement Type = "text_editor_code_execution_tool_result"` - `required Content Content` - `class BetaTextEditorCodeExecutionToolResultError` - `JsonElement Type = "text_editor_code_execution_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `FileNotFound("file_not_found")` - `required string? ErrorMessage` - `class BetaTextEditorCodeExecutionViewResultBlock` - `JsonElement Type = "text_editor_code_execution_view_result"` - `required string Content` - `required FileType FileType` - `Text("text")` - `Image("image")` - `Pdf("pdf")` - `required long? NumLines` - `required long? StartLine` - `required long? TotalLines` - `class BetaTextEditorCodeExecutionCreateResultBlock` - `JsonElement Type = "text_editor_code_execution_create_result"` - `required bool IsFileUpdate` - `class BetaTextEditorCodeExecutionStrReplaceResultBlock` - `JsonElement Type = "text_editor_code_execution_str_replace_result"` - `required IReadOnlyList? Lines` - `required long? NewLines` - `required long? NewStart` - `required long? OldLines` - `required long? OldStart` - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaToolSearchToolResultBlock` - `JsonElement Type = "tool_search_tool_result"` - `required Content Content` - `class BetaToolSearchToolResultError` - `JsonElement Type = "tool_search_tool_result_error"` - `required ErrorCode ErrorCode` - `InvalidToolInput("invalid_tool_input")` - `Unavailable("unavailable")` - `TooManyRequests("too_many_requests")` - `ExecutionTimeExceeded("execution_time_exceeded")` - `required string? ErrorMessage` - `class BetaToolSearchToolSearchResultBlock` - `JsonElement Type = "tool_search_tool_search_result"` - `required IReadOnlyList ToolReferences` - `JsonElement Type = "tool_reference"` - `required string ToolName` minLength: 1, maxLength: 256, pattern: ^[a-zA-Z0-9_-]{1,256}$ - `required string ToolUseID` pattern: ^srvtoolu_[a-zA-Z0-9_]+$ - `class BetaMcpToolUseBlock` - `JsonElement Type = "mcp_tool_use"` - `required string ID` pattern: ^[a-zA-Z0-9_-]+$ - `required IReadOnlyDictionary Input` - `required string Name` The name of the MCP tool - `required string ServerName` The name of the MCP server - `class BetaMcpToolResultBlock` - `JsonElement Type = "mcp_tool_result"` - `required Content Content` - `string` - `IReadOnlyList` - `JsonElement Type = "text"` - `required IReadOnlyList? Citations` 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`. - `required string Text` - `required bool IsError` - `required string ToolUseID` pattern: ^[a-zA-Z0-9_-]+$ - `class BetaContainerUploadBlock` Response model for a file uploaded to the container. - `JsonElement Type = "container_upload"` - `required string FileID` - `class BetaCompactionBlock` A compaction block returned when autocompact is triggered. When content is None, it indicates the compaction failed to produce a valid summary (e.g., malformed output from the model). Clients may round-trip compaction blocks with null content; the server treats them as no-ops. - `JsonElement Type = "compaction"` - `required string? Content` Summary of compacted content, or null if compaction failed - `required string? EncryptedContent` Opaque metadata from prior compaction, to be round-tripped verbatim - `string? Signature` Signature over the summary, to be sent back with the block verbatim - `IReadOnlyList? ToolChanges` 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. - `class 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. - `JsonElement Type = "tool_addition"` - `required Tool Tool` The tool made available: a reference to a `tools` entry or MCP toolset, or a `tool_definition` carrying the definition by value. - `class 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. - `JsonElement Type = "tool_reference"` - `required string Name` - `class 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. - `JsonElement Type = "mcp_tool_reference"` - `required string Name` - `required string ServerName` - `class 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. - `JsonElement Type = "mcp_toolset_reference"` - `required string ServerName` - `class 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. - `JsonElement Type = "tool_definition"` - `required BetaResponseToolUnion Definition` - `class BetaResponseTool` A custom tool definition, as sent. - `Type? Type` - `required BetaResponseToolInputSchema InputSchema` [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. - `JsonElement Type = "object"` - `IReadOnlyDictionary? Properties` - `IReadOnlyList? Required` - `required string Name` 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}$ - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `string Description` 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. - `bool? EagerInputStreaming` 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. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20241022` - `JsonElement Type = "bash_20241022"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `JsonElement Type = "ephemeral"` - `Ttl Ttl` 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=csharp) for details. - `Ttl5m("5m")` - `Ttl1h("1h")` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolBash20250124` - `JsonElement Type = "bash_20250124"` - `JsonElement Name = "bash"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250522` - `JsonElement Type = "code_execution_20250522"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20250825` - `JsonElement Type = "code_execution_20250825"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260120` A `tools` entry for the code execution tool, version `code_execution_20260120`. It adds REPL state persistence to version `code_execution_20250825`. REPL state persistence applies with programmatic tool calling. With it, the Python interpreter state, such as variable bindings, persists across requests that reuse the container. See the [code execution tool guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/code-execution-tool?sdk_languages=csharp#tool-versions) to learn what each tool version adds. - `JsonElement Type = "code_execution_20260120"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaCodeExecutionTool20260521` Code execution tool with REPL state persistence. - `JsonElement Type = "code_execution_20260521"` - `JsonElement Name = "code_execution"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaBrowserToolset20260801` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. - `JsonElement Type = "browser_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaBrowserToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaBrowserTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserCloseTabConfig? CloseTab` `close_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFileUploadConfig? FileUpload` `file_upload`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFindConfig? Find` `find`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserFormInputConfig? FormInput` `form_input`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserGetPageTextConfig? GetPageText` `get_page_text`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserHoverConfig? Hover` `hover`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserJavascriptExecConfig? JavascriptExec` `javascript_exec`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserListTabsConfig? ListTabs` `list_tabs`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNavigateConfig? Navigate` `navigate`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserNewTabConfig? NewTab` `new_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadConsoleConfig? ReadConsole` `read_console`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadNetworkConfig? ReadNetwork` `read_network`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserReadPageConfig? ReadPage` `read_page`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserScrollToConfig? ScrollTo` `scroll_to`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserSwitchTabConfig? SwitchTab` `switch_tab`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaBrowserZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolComputerUse20241022` - `JsonElement Type = "computer_20241022"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMemoryTool20250818` - `JsonElement Type = "memory_20250818"` - `JsonElement Name = "memory"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20250124` - `JsonElement Type = "computer_20250124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20241022` - `JsonElement Type = "text_editor_20241022"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolComputerUse20251124` - `JsonElement Type = "computer_20251124"` - `required long DisplayHeightPx` The height of the display in pixels. minimum: 1 - `required long DisplayWidthPx` The width of the display in pixels. minimum: 1 - `JsonElement Name = "computer"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? DisplayNumber` The X11 display number (e.g. 0, 1) for the display. minimum: 0 - `bool EnableZoom` Whether to enable an action to take a zoomed-in screenshot of the screen. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaComputerToolset20260801` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is served the family's tool with any members disabled via `configs` removed from its schema. Every member is enabled by default, zoom included. The single-tool options `display_number` and `enable_zoom` are not fields of a toolset entry — it carries only `type`, `configs`, and `cache_control`; zoom is controlled via `configs.zoom.enabled`. - `JsonElement Type = "computer_toolset_20260801"` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaComputerToolsetConfigs? Configs` Sparse per-member overrides, keyed by member name. Absent, null, and {} are equivalent; a member's defaults apply wherever its key is absent. - `BetaComputerTypeConfig? Type` `type`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerCursorPositionConfig? CursorPosition` `cursor_position`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerDoubleClickConfig? DoubleClick` `double_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerHoldKeyConfig? HoldKey` `hold_key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerKeyConfig? Key` `key`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickConfig? LeftClick` `left_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftClickDragConfig? LeftClickDrag` `left_click_drag`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseDownConfig? LeftMouseDown` `left_mouse_down`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerLeftMouseUpConfig? LeftMouseUp` `left_mouse_up`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMiddleClickConfig? MiddleClick` `middle_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerMouseMoveConfig? MouseMove` `mouse_move`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerRightClickConfig? RightClick` `right_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScreenshotConfig? Screenshot` `screenshot`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerScrollConfig? Scroll` `scroll`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerTripleClickConfig? TripleClick` `triple_click`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerWaitConfig? Wait` `wait`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `BetaComputerZoomConfig? Zoom` `zoom`'s config overrides. - `bool? DeferLoading` Defer loading for this member. Must resolve to the same value on every enabled member of the toolset. - `bool? Enabled` Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - `class BetaToolTextEditor20250124` - `JsonElement Type = "text_editor_20250124"` - `JsonElement Name = "str_replace_editor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250429` - `JsonElement Type = "text_editor_20250429"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolTextEditor20250728` - `JsonElement Type = "text_editor_20250728"` - `JsonElement Name = "str_replace_based_edit_tool"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `IReadOnlyList> InputExamples` - `long? MaxCharacters` Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaWebSearchTool20250305` - `JsonElement Type = "web_search_20250305"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `JsonElement Type = "approximate"` - `string? City` The city of the user. minLength: 1, maxLength: 255 - `string? Country` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. minLength: 2, maxLength: 2 - `string? Region` The region of the user. minLength: 1, maxLength: 255 - `string? Timezone` The [IANA timezone](https://nodatime.org/TimeZones) of the user. minLength: 1, maxLength: 255 - `class BetaWebFetchTool20250910` - `JsonElement Type = "web_fetch_20250910"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool Enabled` - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `ClientToolResults ClientToolResults` Which client tools' results contribute fetchable URLs: "all", "none", or an only or except list of client tool names from tools[]. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `JsonElement Type = "all"` - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `JsonElement Type = "none"` - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `JsonElement Type = "only"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `JsonElement Type = "except"` - `required IReadOnlyList Tools` - `JsonElement Type = "tool_reference"` - `required string Name` - `ServerToolResults ServerToolResults` 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. - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebFetchUrlSourceOnly` The tool filter variant under which only the named tools' results contribute. - `class BetaWebFetchUrlSourceExcept` The tool filter variant under which every result but the named tools' contributes. - `UserInput UserInput` Whether URLs in user messages are fetchable: "all" or "none". - `class BetaWebFetchUrlSourceAll` The `url_sources` variant under which a source contributes in full: every result of the tool filter's source, or all user input. - `class BetaWebFetchUrlSourceNone` The `url_sources` variant under which a source contributes nothing: no result of the tool filter's source, or no user input. - `class BetaWebSearchTool20260209` - `JsonElement Type = "web_search_20260209"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260209` - `JsonElement Type = "web_fetch_20260209"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `class BetaWebFetchTool20260309` Web fetch tool with use_cache parameter for bypassing cached content. - `JsonElement Type = "web_fetch_20260309"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaWebSearchTool20260318` - `JsonElement Type = "web_search_20260318"` - `JsonElement Name = "web_search"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `IReadOnlyList? BlockedDomains` If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaUserLocation? UserLocation` Parameters for the user's location. Used to provide more relevant search results. - `class BetaWebFetchTool20260318` - `JsonElement Type = "web_fetch_20260318"` - `JsonElement Name = "web_fetch"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `IReadOnlyList? AllowedDomains` List of domains to allow fetching from - `IReadOnlyList? BlockedDomains` List of domains to block fetching from - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCitationsConfigParam? Citations` Citations configuration for fetched documents. Citations are disabled by default. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxContentTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `ResponseInclusion ResponseInclusion` 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. - `Full("full")` - `Excluded("excluded")` - `bool Strict` When true, guarantees schema validation on tool names and inputs - `BetaWebFetchUrlSources? UrlSources` Which sources contribute to the set of URLs the tool may fetch. Omitted means every source. - `bool UseCache` 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. - `class BetaAdvisorTool20260301` - `JsonElement Type = "advisor_20260301"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `ClaudeHaiku5_5("claude-haiku-5-5")` Fastest model for high-volume, real-time tasks - `ClaudeSonnet5_5("claude-sonnet-5-5")` Efficient model for coding and agents - `ClaudeFable5_1("claude-fable-5-1")` Frontier intelligence for ambitious tasks across coding, scientific discovery, and enterprise workflows - `ClaudeOpus5_5("claude-opus-5-5")` Powerful intelligence for coding, knowledge work, and long-running agents - `ClaudeMythos5_1("claude-mythos-5-1")` Our most capable model for cybersecurity and biology research, available through trusted access programs - `ClaudeSonnet5("claude-sonnet-5")` Efficient model for coding and agents - `ClaudeFable5("claude-fable-5")` Next generation of intelligence for the hardest knowledge work and coding problems - `ClaudeMythos5("claude-mythos-5")` Most capable model for cybersecurity and biology research - `ClaudeOpus5("claude-opus-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_8("claude-opus-4-8")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_7("claude-opus-4-7")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_6("claude-opus-4-6")` Powerful intelligence for long-running agents and coding - `ClaudeSonnet4_6("claude-sonnet-4-6")` Best combination of speed and intelligence - `ClaudeHaiku4_5("claude-haiku-4-5")` - `ClaudeHaiku4_5_20251001("claude-haiku-4-5-20251001")` - `ClaudeOpus4_5("claude-opus-4-5")` Powerful intelligence for long-running agents and coding - `ClaudeOpus4_5_20251101("claude-opus-4-5-20251101")` Powerful intelligence for long-running agents and coding - `ClaudeMythosPreview("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 - `ClaudeSonnet4_5("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 - `ClaudeSonnet4_5_20250929("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 - `JsonElement Name = "advisor"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `BetaCacheControlEphemeral? Caching` 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. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `long? MaxTokens` 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 - `long? MaxUses` Maximum number of times the tool can be used in the API request. minimum: 1 - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolBm25_20251119` - `required Type Type` - `ToolSearchToolBm25_20251119("tool_search_tool_bm25_20251119")` - `ToolSearchToolBm25("tool_search_tool_bm25")` - `JsonElement Name = "tool_search_tool_bm25"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaToolSearchToolRegex20251119` - `required Type Type` - `ToolSearchToolRegex20251119("tool_search_tool_regex_20251119")` - `ToolSearchToolRegex("tool_search_tool_regex")` - `JsonElement Name = "tool_search_tool_regex"` Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `IReadOnlyList AllowedCallers` - `Direct("direct")` - `CodeExecution20250825("code_execution_20250825")` - `CodeExecution20260120("code_execution_20260120")` - `CodeExecution20260521("code_execution_20260521")` - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `bool DeferLoading` If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `bool Strict` When true, guarantees schema validation on tool names and inputs - `class BetaMcpToolset` Configuration for a group of tools from an MCP server. Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides. - `JsonElement Type = "mcp_toolset"` - `required string McpServerName` Name of the MCP server to configure tools for minLength: 1, maxLength: 255 - `BetaCacheControlEphemeral? CacheControl` Create a cache control breakpoint at this content block. - `IReadOnlyDictionary? Configs` Configuration overrides for specific tools, keyed by tool name - `bool DeferLoading` - `bool Enabled` - `BetaMcpToolDefaultConfig DefaultConfig` Default configuration applied to all tools from this server - `bool DeferLoading` - `bool Enabled` - `IReadOnlyList? Tools` 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. - `required IReadOnlyDictionary InputSchema` The tool's input schema as the MCP server lists it, verbatim. - `required string Name` The tool's name as the MCP server lists it (not prefixed with the server name). minLength: 1 - `string? Description` The tool's description as the MCP server lists it. - `class 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. - `JsonElement Type = "tool_removal"` - `required Tool Tool` A reference to the withdrawn `tools` entry, MCP tool or MCP toolset. - `class 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. - `class 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. - `class 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. - `class BetaFallbackBlock` Marks the point in `content` where one model's output gives way to the next. One block appears per hop where a preceding model actually ran this turn and declined. A turn where no preceding model ran and declined has no such boundary and carries no block — the signal for whether a fallback model served the response is the presence of a `fallback_message` entry in `usage.iterations`, not this block. The block is treated like a server-tool content block for streaming: it arrives via the standard `content_block_start` / `content_block_stop` pair and carries no deltas. - `JsonElement Type = "fallback"` - `required BetaFallbackInfo From` 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. - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required BetaFallbackInfo To` The fallback model producing the content that follows this block. Its `model` is always the canonical id. - `required BetaFallbackRefusalTrigger Trigger` What caused the `from` model to hand over at this hop. - `JsonElement Type = "refusal"` - `required BetaFallbackRefusalTriggerCategory? Category` The policy category that triggered the `from` model's refusal at this hop. `null` when the refusal doesn't map to a named category. Same vocabulary as `stop_details.category`. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `class 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. - `JsonElement Type = "mcp_tool_listing"` - `required string McpServerName` - `required IReadOnlyList Tools` - `required IReadOnlyDictionary InputSchema` - `required string Name` - `string Description` - `required BetaContextManagementResponse? ContextManagement` Context management response. Information about context management strategies applied during the request. - `required IReadOnlyList AppliedEdits` List of context management edits that were applied. - `class BetaClearToolUses20250919EditResponse` - `JsonElement Type = "clear_tool_uses_20250919"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedToolUses` Number of tool uses that were cleared. minimum: 0 - `class BetaClearThinking20251015EditResponse` - `JsonElement Type = "clear_thinking_20251015"` The type of context management edit applied. - `required long ClearedInputTokens` Number of input tokens cleared by this edit. minimum: 0 - `required long ClearedThinkingTurns` Number of thinking turns that were cleared. minimum: 0 - `required BetaDiagnostics? Diagnostics` Request-level diagnostics. `null` when the request did not supply `diagnostics`, or when it did and no prompt-cache divergence was detected. - `required BetaCacheMissReason? CacheMissReason` Explains why the prompt cache could not fully reuse the prefix from the request identified by `diagnostics.previous_message_id`. `null` means diagnosis is still pending — the response was serialized before the background comparison completed. - `class BetaCacheMissModelChanged` A `cache_miss_reason` for a request whose `model` or `speed` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "model_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissSystemChanged` A `cache_miss_reason` for a request whose `system` differs from the previous request's. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "system_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissToolsChanged` A `cache_miss_reason` for a request whose `tools` differ from the previous request's, for example because tools were added, removed, or reordered. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "tools_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissMessagesChanged` A `cache_miss_reason` for a request whose `messages` differ from the previous request's in an earlier entry, instead of only having entries appended. The `model`, `system`, and `tools` match. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "messages_changed"` - `required long CacheMissedInputTokens` Approximate number of input tokens that would have been read from cache had the prefix matched the previous request. - `class BetaCacheMissPreviousMessageNotFound` A `cache_miss_reason` for when the API doesn't have a stored record of the request that `diagnostics.previous_message_id` references. This doesn't mean that this request changed. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "previous_message_not_found"` - `class BetaCacheMissUnavailable` A `cache_miss_reason` for when the API can't give a diagnosis. The request itself was processed normally. This includes a request whose `model`, `system`, and `tools` match the previous request's but whose other prompt-affecting parameters, such as `thinking` or `tool_choice`, differ. See the [cache diagnostics guide](https://platform.claude.com/docs/en/build-with-claude/cache-diagnostics?sdk_languages=csharp#cache-miss-reason-types) to learn what to change for each reason. - `JsonElement Type = "unavailable"` - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `JsonElement Role = "assistant"` Conversational role of the generated message. This will always be `"assistant"`. - `required BetaRefusalStopDetails? StopDetails` Structured information about why model output stopped. This is `null` when the `stop_reason` has no additional detail to report. - `JsonElement Type = "refusal"` - `required Category? Category` The policy category that triggered the refusal. `null` when the refusal doesn't map to a named category. - `Cyber("cyber")` The request could enable cyber harm, such as malware or exploit development. Benign cybersecurity work can also trigger this category. - `Bio("bio")` The request could enable biological harm, such as dangerous lab methods. Beneficial life sciences work can also trigger this category. - `FrontierLlm("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. - `ReasoningExtraction("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=csharp). - `GeneralHarms("general_harms")` The request could be related to an area that was determined as harmful. Benign work might sometimes trigger this category. - `required string? Explanation` Human-readable explanation of the refusal. This text is not guaranteed to be stable. `null` when no explanation is available for the category. - `required string? FallbackCreditToken` 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. - `required bool? FallbackHasPrefillClaim` 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. - `required string? RecommendedModel` 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. - `required BetaStopReason? StopReason` 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. - `EndTurn("end_turn")` - `MaxTokens("max_tokens")` - `StopSequence("stop_sequence")` - `ToolUse("tool_use")` - `PauseTurn("pause_turn")` - `Compaction("compaction")` - `Refusal("refusal")` - `ModelContextWindowExceeded("model_context_window_exceeded")` - `required string? StopSequence` 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. - `required BetaUsage Usage` Billing and rate-limit usage. Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. For example, `output_tokens` will be non-zero, even for an empty string response from Claude. Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long Ephemeral1hInputTokens` The number of input tokens used to create the 1 hour cache entry. minimum: 0 - `required long Ephemeral5mInputTokens` The number of input tokens used to create the 5 minute cache entry. minimum: 0 - `required long? CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long? CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required BetaFallbackCreditUsage? FallbackCredit` 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). - `required Status Status` Whether the fallback-credit reprice was applied to this response's billing. A union discriminated on `type`. `redeemed`: the retry is billed as if the conversation had been on the retry model all along — including when the resulting shift is zero because there was nothing to move. `not_applied`: no reprice was applied; the arm's `reason` says why. - `class BetaFallbackCreditRedeemed` The reprice was applied: the retry is billed as if the conversation had been on the retry model all along. - `JsonElement Type = "redeemed"` - `class BetaFallbackCreditNotApplied` No reprice was applied; `reason` says why. - `JsonElement Type = "not_applied"` - `required Reason Reason` Why the reprice was not applied. A closed enum; additions to the redemption-check vocabulary arrive as deliberate schema updates. - `BodyMismatch("body_mismatch")` - `ContinuationExcluded("continuation_excluded")` - `ContinuationOnly("continuation_only")` - `Expired("expired")` - `InvalidTargetModel("invalid_target_model")` - `NotEnabled("not_enabled")` - `RepriceUnavailable("reprice_unavailable")` - `TemporarilyUnavailable("temporarily_unavailable")` - `VariantFieldsPresent("variant_fields_present")` - `WrongOrganization("wrong_organization")` - `WrongPlatform("wrong_platform")` - `WrongWorkspace("wrong_workspace")` - `IReadOnlyList? RemoveToRedeem` 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. - `required string? InferenceGeo` The geographic region where inference was performed for this request. - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required IReadOnlyList? Iterations` 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. - `class BetaMessageIterationUsage` Token usage for a sampling iteration. - `JsonElement Type = "message"` Usage for a sampling iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model? Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaCompactionIterationUsage` Token usage for a compaction iteration. - `JsonElement Type = "compaction"` Usage for a compaction iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class BetaAdvisorMessageIterationUsage` Token usage for an advisor sub-inference iteration. - `JsonElement Type = "advisor_message"` Usage for an advisor sub-inference iteration - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `class 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`. - `JsonElement Type = "fallback_message"` Usage for the fallback-model attempt that served the response - `required BetaCacheCreation? CacheCreation` Breakdown of cached tokens by TTL - `required long CacheCreationInputTokens` The number of input tokens used to create the cache entry. minimum: 0 - `required long CacheReadInputTokens` The number of input tokens read from the cache. minimum: 0 - `required long InputTokens` The number of input tokens which were used. minimum: 0 - `required Model Model` The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required long OutputTokens` The number of output tokens which were used. minimum: 0 - `required BetaOutputTokensDetails? OutputTokensDetails` 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. - `required long ThinkingTokens` 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. minimum: 0 - `required BetaServerToolUsage? ServerToolUse` The number of server tool requests. - `required long WebFetchRequests` The number of web fetch tool requests. minimum: 0 - `required long WebSearchRequests` The number of web search tool requests. minimum: 0 - `required ServiceTier? ServiceTier` If the request used the priority, standard, or batch tier. - `Standard("standard")` - `Priority("priority")` - `Batch("batch")` - `required Speed? Speed` The inference speed mode used for this request. - `Standard("standard")` - `Fast("fast")` - `IReadOnlyList? InputTransformations` 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`. - `class BetaThinkingDroppedInputTransformation` - `JsonElement Type = "thinking_dropped"` Always `thinking_dropped` for this entry type. - `required string Path` 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. - `required Reason Reason` 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`. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` - `class BetaThinkingMismatchAllowedInputTransformation` - `JsonElement Type = "thinking_mismatch_allowed"` Always `thinking_mismatch_allowed` for this entry type. - `required string Path` 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. - `required Reason Reason` 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. - `ModelBindingMismatch("model_binding_mismatch")` - `PrefixBindingMismatch("prefix_binding_mismatch")` - `OrganizationBindingMismatch("organization_binding_mismatch")` - `EndUserBindingMismatch("end_user_binding_mismatch")` - `class BetaMessageBatchErroredResult` - `JsonElement Type = "errored"` - `required BetaErrorResponse Error` - `JsonElement Type = "error"` - `required BetaError Error` - `class BetaInvalidRequestError` - `JsonElement Type = "invalid_request_error"` - `required string Message` - `class BetaAuthenticationError` - `JsonElement Type = "authentication_error"` - `required string Message` - `class BetaBillingError` - `JsonElement Type = "billing_error"` - `required string Message` - `class BetaPermissionError` - `JsonElement Type = "permission_error"` - `required string Message` - `class BetaNotFoundError` - `JsonElement Type = "not_found_error"` - `required string Message` - `class BetaRateLimitError` - `JsonElement Type = "rate_limit_error"` - `required string Message` - `class BetaGatewayTimeoutError` - `JsonElement Type = "timeout_error"` - `required string Message` - `class BetaApiError` - `JsonElement Type = "api_error"` - `required string Message` - `class BetaOverloadedError` - `JsonElement Type = "overloaded_error"` - `required string Message` - `required string? RequestID` - `class BetaMessageBatchCanceledResult` - `JsonElement Type = "canceled"` - `class BetaMessageBatchExpiredResult` - `JsonElement Type = "expired"` #### Example ```csharp using System; using Anthropic.Models.Beta.Messages.Batches; BatchResultsParams parameters = new() { MessageBatchID = "message_batch_id" }; await foreach (var betaMessageBatchIndividualResponse in client.Beta.Messages.Batches.ResultsStreaming(parameters)) { Console.WriteLine(betaMessageBatchIndividualResponse); } ```