From 600ddff0921c1d42950027129145bef12d1f7006 Mon Sep 17 00:00:00 2001 From: Ed_ Date: Sat, 21 Feb 2026 15:51:08 -0500 Subject: [PATCH] progress --- ai_client.py | 129 +- config.toml | 6 +- docs/anthropic_api_ref_create_message.md | 4691 +++++++++++++ docs/anthropic_api_ref_create_message_beta.md | 5906 +++++++++++++++++ docs/anthropic_prompt_caching.md | 0 dpg_layout.ini | 83 +- session_logger.py | 125 + 7 files changed, 10891 insertions(+), 49 deletions(-) create mode 100644 docs/anthropic_api_ref_create_message.md create mode 100644 docs/anthropic_api_ref_create_message_beta.md create mode 100644 docs/anthropic_prompt_caching.md create mode 100644 session_logger.py diff --git a/ai_client.py b/ai_client.py index 8d93e28..7f05eed 100644 --- a/ai_client.py +++ b/ai_client.py @@ -14,7 +14,7 @@ _anthropic_client = None _anthropic_history: list[dict] = [] # Injected by gui.py - called when AI wants to run a command. -# Signature: (script: str) -> str | None +# Signature: (script: str, base_dir: str) -> str | None # Returns the output string if approved, None if rejected. confirm_and_run_callback = None @@ -22,8 +22,20 @@ confirm_and_run_callback = None # Signature: (entry: dict) -> None comms_log_callback = None +# Injected by gui.py - called whenever a tool call completes. +# Signature: (script: str, result: str, script_path: str | None) -> None +tool_log_callback = None + MAX_TOOL_ROUNDS = 5 +# Anthropic system prompt - cached as the first turn so it counts toward +# the prompt-cache prefix on every subsequent request. +_ANTHROPIC_SYSTEM = ( + "You are a helpful coding assistant with access to a PowerShell tool. " + "When asked to create or edit files, prefer targeted edits over full rewrites. " + "Always explain what you are doing before invoking the tool." +) + # ------------------------------------------------------------------ comms log _comms_log: list[dict] = [] @@ -142,8 +154,6 @@ def _classify_anthropic_error(exc: Exception) -> ProviderError: def _classify_gemini_error(exc: Exception) -> ProviderError: """Map a google-genai SDK exception to a ProviderError.""" body = str(exc).lower() - # google-genai surfaces HTTP errors as google.api_core exceptions or - # google.genai exceptions; inspect the message text as a reliable fallback. try: from google.api_core import exceptions as gac if isinstance(exc, gac.ResourceExhausted): @@ -156,7 +166,6 @@ def _classify_gemini_error(exc: Exception) -> ProviderError: return ProviderError("network", "gemini", exc) except ImportError: pass - # Fallback: parse status code / message string if "429" in body or "quota" in body or "resource exhausted" in body: return ProviderError("quota", "gemini", exc) if "rate" in body and "limit" in body: @@ -279,12 +288,20 @@ def _run_script(script: str, base_dir: str) -> str: """ Delegate to the GUI confirmation callback. Returns result string (stdout/stderr) or a rejection message. + Also fires tool_log_callback if registered. """ if confirm_and_run_callback is None: return "ERROR: no confirmation handler registered" - result = confirm_and_run_callback(script, base_dir) - if result is None: - return "USER REJECTED: command was not executed" + # confirm_and_run_callback returns (result, script_path) or None + outcome = confirm_and_run_callback(script, base_dir) + if outcome is None: + result = "USER REJECTED: command was not executed" + if tool_log_callback is not None: + tool_log_callback(script, result, None) + return result + result, script_path = outcome + if tool_log_callback is not None: + tool_log_callback(script, result, script_path) return result # ------------------------------------------------------------------ gemini @@ -321,7 +338,6 @@ def _send_gemini(md_content: str, user_message: str, base_dir: str) -> str: response = _gemini_chat.send_message(full_message) for round_idx in range(MAX_TOOL_ROUNDS): - # Log the raw response candidates as text summary text_parts_raw = [ part.text for candidate in response.candidates @@ -383,6 +399,35 @@ def _send_gemini(md_content: str, user_message: str, base_dir: str) -> str: raise _classify_gemini_error(exc) from exc # ------------------------------------------------------------------ anthropic +# +# Caching strategy (Anthropic prompt caching): +# +# The Anthropic API caches a prefix of the input tokens. To maximise hits: +# +# 1. A persistent system prompt is sent on every request with +# cache_control={"type":"ephemeral"} so it is cached after the first call +# and reused on subsequent calls within the 5-minute TTL window. +# +# 2. The context block (aggregated markdown) is placed as the FIRST user +# message in the history and also marked with cache_control. Because the +# system prompt and the context are stable across tool-use rounds within a +# single send() call, the cache hit rate is very high after round 0. +# +# 3. Tool definitions are passed with cache_control on the last tool so the +# entire tools array is also cached. +# +# Token accounting: the response payload contains cache_creation_input_tokens +# and cache_read_input_tokens in addition to the regular input_tokens field. +# These are included in the comms log under "usage". + +def _anthropic_tools_with_cache() -> list[dict]: + """Return the tools list with cache_control on the last entry.""" + import copy + tools = copy.deepcopy(_ANTHROPIC_TOOLS) + # Mark the last tool so the entire prefix (system + tools) gets cached + tools[-1]["cache_control"] = {"type": "ephemeral"} + return tools + def _ensure_anthropic_client(): global _anthropic_client @@ -391,6 +436,7 @@ def _ensure_anthropic_client(): creds = _load_credentials() _anthropic_client = anthropic.Anthropic(api_key=creds["anthropic"]["api_key"]) + def _send_anthropic(md_content: str, user_message: str, base_dir: str) -> str: global _anthropic_history import anthropic @@ -398,19 +444,54 @@ def _send_anthropic(md_content: str, user_message: str, base_dir: str) -> str: try: _ensure_anthropic_client() - full_message = f"\n{md_content}\n\n\n{user_message}" - _anthropic_history.append({"role": "user", "content": full_message}) + # ---------------------------------------------------------------- + # Build the user turn. + # + # Structure the content as two blocks so the large context portion + # can be cached independently of the user question: + # + # [0] context block <- cache_control applied here + # [1] user question <- not cached (changes every turn) + # + # The Anthropic cache anchors at the LAST cache_control marker in + # the prefix, so everything up to and including the context block + # will be served from cache on subsequent rounds. + # ---------------------------------------------------------------- + user_content = [ + { + "type": "text", + "text": f"\n{md_content}\n", + "cache_control": {"type": "ephemeral"}, + }, + { + "type": "text", + "text": user_message, + }, + ] + + _anthropic_history.append({"role": "user", "content": user_content}) _append_comms("OUT", "request", { - "message": full_message, + "message": f"\n{md_content}\n\n\n{user_message}", }) for round_idx in range(MAX_TOOL_ROUNDS): response = _anthropic_client.messages.create( model=_model, max_tokens=8096, - tools=_ANTHROPIC_TOOLS, - messages=_anthropic_history + system=[ + { + "type": "text", + "text": _ANTHROPIC_SYSTEM, + "cache_control": {"type": "ephemeral"}, + } + ], + tools=_anthropic_tools_with_cache(), + messages=_anthropic_history, + # Ask the API to return cache token counts + # betas=["prompt-caching-2024-07-31"], + # TODO(Claude): betas is not a valid field: + # ERROR: Messages.create() got an unexpected keyword argument 'betas' ) _anthropic_history.append({ @@ -418,22 +499,34 @@ def _send_anthropic(md_content: str, user_message: str, base_dir: str) -> str: "content": response.content }) - # Summarise the response content for the log text_blocks = [b.text for b in response.content if hasattr(b, "text") and b.text] tool_use_blocks = [ {"id": b.id, "name": b.name, "input": b.input} for b in response.content if b.type == "tool_use" ] + + # Extended usage includes cache fields when the beta header is set + usage_dict: dict = {} + if response.usage: + usage_dict = { + "input_tokens": response.usage.input_tokens, + "output_tokens": response.usage.output_tokens, + } + # cache fields are present when the beta is active + cache_creation = getattr(response.usage, "cache_creation_input_tokens", None) + cache_read = getattr(response.usage, "cache_read_input_tokens", None) + if cache_creation is not None: + usage_dict["cache_creation_input_tokens"] = cache_creation + if cache_read is not None: + usage_dict["cache_read_input_tokens"] = cache_read + _append_comms("IN", "response", { "round": round_idx, "stop_reason": response.stop_reason, "text": "\n".join(text_blocks), "tool_calls": tool_use_blocks, - "usage": { - "input_tokens": response.usage.input_tokens, - "output_tokens": response.usage.output_tokens, - } if response.usage else {}, + "usage": usage_dict, }) if response.stop_reason != "tool_use": diff --git a/config.toml b/config.toml index 70c151a..2d6a556 100644 --- a/config.toml +++ b/config.toml @@ -13,6 +13,7 @@ paths = [ "pyproject.toml", "MainContext.md", "C:/projects/manual_slop/shell_runner.py", + "C:/projects/manual_slop/session_logger.py", ] [screenshots] @@ -20,7 +21,10 @@ base_dir = "C:/Users/Ed/scoop/apps/sharex/current/ShareX/Screenshots/2026-02" paths = [] [discussion] -history = [] +history = [ + "Make sure we are optimially using the anthropic api for this. \nI want to fully utilize caching if possible and just reduce overall loss of limits. \nAdd a log for comms history thats saved in ./logs and a the same for tool calls (scripts in ./scripts/generated, and their call equence in ./logs) these logs are closed in the next runtime of this gui program. \nOn open they amke new file buffers, each file buffer has a timestamp of when it was first made.", + "Now finish the gui portion: in gui.py or anything left (last made seesion_logger.py it seems). Caching strategy also looks to be updated in ai_client.py", +] [ai] provider = "anthropic" diff --git a/docs/anthropic_api_ref_create_message.md b/docs/anthropic_api_ref_create_message.md new file mode 100644 index 0000000..2be83e4 --- /dev/null +++ b/docs/anthropic_api_ref_create_message.md @@ -0,0 +1,4691 @@ +## Create + +**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://docs.claude.com/en/docs/initial-setup) + +### Body Parameters + +- `max_tokens: number` + + 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. + + Different models have different maximum values for this parameter. See [models](https://docs.claude.com/en/docs/models-overview) for details. + +- `messages: array of MessageParam` + + 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. + + 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: + + ```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://docs.claude.com/en/api/messages-examples). + + Note that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. + + There is a limit of 100,000 messages in a single request. + + - `content: string or array of ContentBlockParam` + + - `UnionMember0 = string` + + - `UnionMember1 = array of ContentBlockParam` + + - `TextBlockParam = object { text, type, cache_control, citations }` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of TextCitationParam` + + - `CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `ImageBlockParam = object { source, type, cache_control }` + + - `source: Base64ImageSource or URLImageSource` + + - `Base64ImageSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` + + - `"image/jpeg"` + + - `"image/png"` + + - `"image/gif"` + + - `"image/webp"` + + - `type: "base64"` + + - `"base64"` + + - `URLImageSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `type: "image"` + + - `"image"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `DocumentBlockParam = object { source, type, cache_control, 3 more }` + + - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or URLPDFSource` + + - `Base64PDFSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "application/pdf"` + + - `"application/pdf"` + + - `type: "base64"` + + - `"base64"` + + - `PlainTextSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "text/plain"` + + - `"text/plain"` + + - `type: "text"` + + - `"text"` + + - `ContentBlockSource = object { content, type }` + + - `content: string or array of ContentBlockSourceContent` + + - `UnionMember0 = string` + + - `ContentBlockSourceContent = array of ContentBlockSourceContent` + + - `TextBlockParam = object { text, type, cache_control, citations }` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of TextCitationParam` + + - `CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `ImageBlockParam = object { source, type, cache_control }` + + - `source: Base64ImageSource or URLImageSource` + + - `Base64ImageSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` + + - `"image/jpeg"` + + - `"image/png"` + + - `"image/gif"` + + - `"image/webp"` + + - `type: "base64"` + + - `"base64"` + + - `URLImageSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `type: "image"` + + - `"image"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `type: "content"` + + - `"content"` + + - `URLPDFSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `type: "document"` + + - `"document"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional CitationsConfigParam` + + - `enabled: optional boolean` + + - `context: optional string` + + - `title: optional string` + + - `SearchResultBlockParam = object { content, source, title, 3 more }` + + - `content: array of TextBlockParam` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of TextCitationParam` + + - `CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `source: string` + + - `title: string` + + - `type: "search_result"` + + - `"search_result"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional CitationsConfigParam` + + - `enabled: optional boolean` + + - `ThinkingBlockParam = object { signature, thinking, type }` + + - `signature: string` + + - `thinking: string` + + - `type: "thinking"` + + - `"thinking"` + + - `RedactedThinkingBlockParam = object { data, type }` + + - `data: string` + + - `type: "redacted_thinking"` + + - `"redacted_thinking"` + + - `ToolUseBlockParam = object { id, input, name, 3 more }` + + - `id: string` + + - `input: map[unknown]` + + - `name: string` + + - `type: "tool_use"` + + - `"tool_use"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120` + + Tool invocation directly from the model. + + - `DirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `ServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `ServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `ToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }` + + - `tool_use_id: string` + + - `type: "tool_result"` + + - `"tool_result"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `content: optional string or array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 2 more` + + - `UnionMember0 = string` + + - `UnionMember1 = array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 2 more` + + - `TextBlockParam = object { text, type, cache_control, citations }` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of TextCitationParam` + + - `CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `ImageBlockParam = object { source, type, cache_control }` + + - `source: Base64ImageSource or URLImageSource` + + - `Base64ImageSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` + + - `"image/jpeg"` + + - `"image/png"` + + - `"image/gif"` + + - `"image/webp"` + + - `type: "base64"` + + - `"base64"` + + - `URLImageSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `type: "image"` + + - `"image"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `SearchResultBlockParam = object { content, source, title, 3 more }` + + - `content: array of TextBlockParam` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of TextCitationParam` + + - `CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `source: string` + + - `title: string` + + - `type: "search_result"` + + - `"search_result"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional CitationsConfigParam` + + - `enabled: optional boolean` + + - `DocumentBlockParam = object { source, type, cache_control, 3 more }` + + - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or URLPDFSource` + + - `Base64PDFSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "application/pdf"` + + - `"application/pdf"` + + - `type: "base64"` + + - `"base64"` + + - `PlainTextSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "text/plain"` + + - `"text/plain"` + + - `type: "text"` + + - `"text"` + + - `ContentBlockSource = object { content, type }` + + - `content: string or array of ContentBlockSourceContent` + + - `UnionMember0 = string` + + - `ContentBlockSourceContent = array of ContentBlockSourceContent` + + - `TextBlockParam = object { text, type, cache_control, citations }` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of TextCitationParam` + + - `CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `ImageBlockParam = object { source, type, cache_control }` + + - `source: Base64ImageSource or URLImageSource` + + - `Base64ImageSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` + + - `"image/jpeg"` + + - `"image/png"` + + - `"image/gif"` + + - `"image/webp"` + + - `type: "base64"` + + - `"base64"` + + - `URLImageSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `type: "image"` + + - `"image"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `type: "content"` + + - `"content"` + + - `URLPDFSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `type: "document"` + + - `"document"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional CitationsConfigParam` + + - `enabled: optional boolean` + + - `context: optional string` + + - `title: optional string` + + - `ToolReferenceBlockParam = object { tool_name, type, cache_control }` + + Tool reference block that can be included in tool_result content. + + - `tool_name: string` + + - `type: "tool_reference"` + + - `"tool_reference"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `is_error: optional boolean` + + - `ServerToolUseBlockParam = object { id, input, name, 3 more }` + + - `id: string` + + - `input: map[unknown]` + + - `name: "web_search" or "web_fetch" or "code_execution" or 4 more` + + - `"web_search"` + + - `"web_fetch"` + + - `"code_execution"` + + - `"bash_code_execution"` + + - `"text_editor_code_execution"` + + - `"tool_search_tool_regex"` + + - `"tool_search_tool_bm25"` + + - `type: "server_tool_use"` + + - `"server_tool_use"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120` + + Tool invocation directly from the model. + + - `DirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `ServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `ServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `WebSearchToolResultBlockParam = object { content, tool_use_id, type, 2 more }` + + - `content: WebSearchToolResultBlockParamContent` + + - `WebSearchToolResultBlockItem = array of WebSearchResultBlockParam` + + - `encrypted_content: string` + + - `title: string` + + - `type: "web_search_result"` + + - `"web_search_result"` + + - `url: string` + + - `page_age: optional string` + + - `WebSearchToolRequestError = object { error_code, type }` + + - `error_code: WebSearchToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"max_uses_exceeded"` + + - `"too_many_requests"` + + - `"query_too_long"` + + - `"request_too_large"` + + - `type: "web_search_tool_result_error"` + + - `"web_search_tool_result_error"` + + - `tool_use_id: string` + + - `type: "web_search_tool_result"` + + - `"web_search_tool_result"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120` + + Tool invocation directly from the model. + + - `DirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `ServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `ServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `WebFetchToolResultBlockParam = object { content, tool_use_id, type, 2 more }` + + - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam` + + - `WebFetchToolResultErrorBlockParam = object { error_code, type }` + + - `error_code: WebFetchToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"url_too_long"` + + - `"url_not_allowed"` + + - `"url_not_accessible"` + + - `"unsupported_content_type"` + + - `"too_many_requests"` + + - `"max_uses_exceeded"` + + - `"unavailable"` + + - `type: "web_fetch_tool_result_error"` + + - `"web_fetch_tool_result_error"` + + - `WebFetchBlockParam = object { content, type, url, retrieved_at }` + + - `content: DocumentBlockParam` + + - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or URLPDFSource` + + - `Base64PDFSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "application/pdf"` + + - `"application/pdf"` + + - `type: "base64"` + + - `"base64"` + + - `PlainTextSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "text/plain"` + + - `"text/plain"` + + - `type: "text"` + + - `"text"` + + - `ContentBlockSource = object { content, type }` + + - `content: string or array of ContentBlockSourceContent` + + - `UnionMember0 = string` + + - `ContentBlockSourceContent = array of ContentBlockSourceContent` + + - `TextBlockParam = object { text, type, cache_control, citations }` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of TextCitationParam` + + - `CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `ImageBlockParam = object { source, type, cache_control }` + + - `source: Base64ImageSource or URLImageSource` + + - `Base64ImageSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` + + - `"image/jpeg"` + + - `"image/png"` + + - `"image/gif"` + + - `"image/webp"` + + - `type: "base64"` + + - `"base64"` + + - `URLImageSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `type: "image"` + + - `"image"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `type: "content"` + + - `"content"` + + - `URLPDFSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `type: "document"` + + - `"document"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional CitationsConfigParam` + + - `enabled: optional boolean` + + - `context: optional string` + + - `title: optional string` + + - `type: "web_fetch_result"` + + - `"web_fetch_result"` + + - `url: string` + + Fetched content URL + + - `retrieved_at: optional string` + + ISO 8601 timestamp when the content was retrieved + + - `tool_use_id: string` + + - `type: "web_fetch_tool_result"` + + - `"web_fetch_tool_result"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `caller: optional DirectCaller or ServerToolCaller or ServerToolCaller20260120` + + Tool invocation directly from the model. + + - `DirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `ServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `ServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `CodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }` + + - `content: CodeExecutionToolResultBlockParamContent` + + Code execution result with encrypted stdout for PFC + web_search results. + + - `CodeExecutionToolResultErrorParam = object { error_code, type }` + + - `error_code: CodeExecutionToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `type: "code_execution_tool_result_error"` + + - `"code_execution_tool_result_error"` + + - `CodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }` + + - `content: array of CodeExecutionOutputBlockParam` + + - `file_id: string` + + - `type: "code_execution_output"` + + - `"code_execution_output"` + + - `return_code: number` + + - `stderr: string` + + - `stdout: string` + + - `type: "code_execution_result"` + + - `"code_execution_result"` + + - `EncryptedCodeExecutionResultBlockParam = object { content, encrypted_stdout, return_code, 2 more }` + + Code execution result with encrypted stdout for PFC + web_search results. + + - `content: array of CodeExecutionOutputBlockParam` + + - `file_id: string` + + - `type: "code_execution_output"` + + - `"code_execution_output"` + + - `encrypted_stdout: string` + + - `return_code: number` + + - `stderr: string` + + - `type: "encrypted_code_execution_result"` + + - `"encrypted_code_execution_result"` + + - `tool_use_id: string` + + - `type: "code_execution_tool_result"` + + - `"code_execution_tool_result"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `BashCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }` + + - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam` + + - `BashCodeExecutionToolResultErrorParam = object { error_code, type }` + + - `error_code: BashCodeExecutionToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `"output_file_too_large"` + + - `type: "bash_code_execution_tool_result_error"` + + - `"bash_code_execution_tool_result_error"` + + - `BashCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }` + + - `content: array of BashCodeExecutionOutputBlockParam` + + - `file_id: string` + + - `type: "bash_code_execution_output"` + + - `"bash_code_execution_output"` + + - `return_code: number` + + - `stderr: string` + + - `stdout: string` + + - `type: "bash_code_execution_result"` + + - `"bash_code_execution_result"` + + - `tool_use_id: string` + + - `type: "bash_code_execution_tool_result"` + + - `"bash_code_execution_tool_result"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `TextEditorCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }` + + - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam` + + - `TextEditorCodeExecutionToolResultErrorParam = object { error_code, type, error_message }` + + - `error_code: TextEditorCodeExecutionToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `"file_not_found"` + + - `type: "text_editor_code_execution_tool_result_error"` + + - `"text_editor_code_execution_tool_result_error"` + + - `error_message: optional string` + + - `TextEditorCodeExecutionViewResultBlockParam = object { content, file_type, type, 3 more }` + + - `content: string` + + - `file_type: "text" or "image" or "pdf"` + + - `"text"` + + - `"image"` + + - `"pdf"` + + - `type: "text_editor_code_execution_view_result"` + + - `"text_editor_code_execution_view_result"` + + - `num_lines: optional number` + + - `start_line: optional number` + + - `total_lines: optional number` + + - `TextEditorCodeExecutionCreateResultBlockParam = object { is_file_update, type }` + + - `is_file_update: boolean` + + - `type: "text_editor_code_execution_create_result"` + + - `"text_editor_code_execution_create_result"` + + - `TextEditorCodeExecutionStrReplaceResultBlockParam = object { type, lines, new_lines, 3 more }` + + - `type: "text_editor_code_execution_str_replace_result"` + + - `"text_editor_code_execution_str_replace_result"` + + - `lines: optional array of string` + + - `new_lines: optional number` + + - `new_start: optional number` + + - `old_lines: optional number` + + - `old_start: optional number` + + - `tool_use_id: string` + + - `type: "text_editor_code_execution_tool_result"` + + - `"text_editor_code_execution_tool_result"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `ToolSearchToolResultBlockParam = object { content, tool_use_id, type, cache_control }` + + - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam` + + - `ToolSearchToolResultErrorParam = object { error_code, type }` + + - `error_code: ToolSearchToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `type: "tool_search_tool_result_error"` + + - `"tool_search_tool_result_error"` + + - `ToolSearchToolSearchResultBlockParam = object { tool_references, type }` + + - `tool_references: array of ToolReferenceBlockParam` + + - `tool_name: string` + + - `type: "tool_reference"` + + - `"tool_reference"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `type: "tool_search_tool_search_result"` + + - `"tool_search_tool_search_result"` + + - `tool_use_id: string` + + - `type: "tool_search_tool_result"` + + - `"tool_search_tool_result"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `ContainerUploadBlockParam = object { file_id, type, cache_control }` + + A content block that represents a file to be uploaded to the container + Files uploaded via this block will be available in the container's input directory. + + - `file_id: string` + + - `type: "container_upload"` + + - `"container_upload"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `role: "user" or "assistant"` + + - `"user"` + + - `"assistant"` + +- `model: Model` + + The model that will complete your prompt. + + See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. + + - `UnionMember0 = "claude-opus-4-6" or "claude-sonnet-4-6" or "claude-opus-4-5-20251101" or 19 more` + + The model that will complete your prompt. + + See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. + + - `"claude-opus-4-6"` + + Most intelligent model for building agents and coding + + - `"claude-sonnet-4-6"` + + Frontier intelligence at scale — built for coding, agents, and enterprise workflows + + - `"claude-opus-4-5-20251101"` + + Premium model combining maximum intelligence with practical performance + + - `"claude-opus-4-5"` + + Premium model combining maximum intelligence with practical performance + + - `"claude-3-7-sonnet-latest"` + + High-performance model with early extended thinking + + - `"claude-3-7-sonnet-20250219"` + + High-performance model with early extended thinking + + - `"claude-3-5-haiku-latest"` + + Fastest and most compact model for near-instant responsiveness + + - `"claude-3-5-haiku-20241022"` + + Our fastest model + + - `"claude-haiku-4-5"` + + Hybrid model, capable of near-instant responses and extended thinking + + - `"claude-haiku-4-5-20251001"` + + Hybrid model, capable of near-instant responses and extended thinking + + - `"claude-sonnet-4-20250514"` + + High-performance model with extended thinking + + - `"claude-sonnet-4-0"` + + High-performance model with extended thinking + + - `"claude-4-sonnet-20250514"` + + High-performance model with extended thinking + + - `"claude-sonnet-4-5"` + + Our best model for real-world agents and coding + + - `"claude-sonnet-4-5-20250929"` + + Our best model for real-world agents and coding + + - `"claude-opus-4-0"` + + Our most capable model + + - `"claude-opus-4-20250514"` + + Our most capable model + + - `"claude-4-opus-20250514"` + + Our most capable model + + - `"claude-opus-4-1-20250805"` + + Our most capable model + + - `"claude-3-opus-latest"` + + Excels at writing and complex tasks + + - `"claude-3-opus-20240229"` + + Excels at writing and complex tasks + + - `"claude-3-haiku-20240307"` + + Our previous most fast and cost-effective + + - `UnionMember1 = string` + +- `cache_control: optional CacheControlEphemeral` + + Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + +- `container: optional string` + + Container identifier for reuse across requests. + +- `inference_geo: optional string` + + Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. + +- `metadata: optional Metadata` + + An object describing metadata about the request. + + - `user_id: optional string` + + 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. + +- `output_config: optional OutputConfig` + + Configuration options for the model's output, such as the output format. + + - `effort: optional "low" or "medium" or "high" or "max"` + + All possible effort levels. + + - `"low"` + + - `"medium"` + + - `"high"` + + - `"max"` + + - `format: optional JSONOutputFormat` + + A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) + + - `schema: map[unknown]` + + The JSON schema of the format + + - `type: "json_schema"` + + - `"json_schema"` + +- `service_tier: optional "auto" or "standard_only"` + + 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://docs.claude.com/en/api/service-tiers) for details. + + - `"auto"` + + - `"standard_only"` + +- `stop_sequences: optional array of string` + + Custom text sequences that will cause the model to stop generating. + + Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. + + If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. + +- `stream: optional boolean` + + Whether to incrementally stream the response using server-sent events. + + See [streaming](https://docs.claude.com/en/api/messages-streaming) for details. + +- `system: optional string or array of TextBlockParam` + + 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://docs.claude.com/en/docs/system-prompts). + + - `UnionMember0 = string` + + - `UnionMember1 = array of TextBlockParam` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of TextCitationParam` + + - `CitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `CitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `CitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `CitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `CitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + +- `temperature: optional number` + + Amount of randomness injected into the response. + + Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. + + Note that even with `temperature` of `0.0`, the results will not be fully deterministic. + +- `thinking: optional ThinkingConfigParam` + + Configuration for enabling Claude's extended thinking. + + When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. + + See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. + + - `ThinkingConfigEnabled = object { budget_tokens, type }` + + - `budget_tokens: number` + + 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://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. + + - `type: "enabled"` + + - `"enabled"` + + - `ThinkingConfigDisabled = object { type }` + + - `type: "disabled"` + + - `"disabled"` + + - `ThinkingConfigAdaptive = object { type }` + + - `type: "adaptive"` + + - `"adaptive"` + +- `tool_choice: optional 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. + + - `ToolChoiceAuto = object { type, disable_parallel_tool_use }` + + The model will automatically decide whether to use tools. + + - `type: "auto"` + + - `"auto"` + + - `disable_parallel_tool_use: optional boolean` + + Whether to disable parallel tool use. + + Defaults to `false`. If set to `true`, the model will output at most one tool use. + + - `ToolChoiceAny = object { type, disable_parallel_tool_use }` + + The model will use any available tools. + + - `type: "any"` + + - `"any"` + + - `disable_parallel_tool_use: optional boolean` + + Whether to disable parallel tool use. + + Defaults to `false`. If set to `true`, the model will output exactly one tool use. + + - `ToolChoiceTool = object { name, type, disable_parallel_tool_use }` + + The model will use the specified tool with `tool_choice.name`. + + - `name: string` + + The name of the tool to use. + + - `type: "tool"` + + - `"tool"` + + - `disable_parallel_tool_use: optional boolean` + + Whether to disable parallel tool use. + + Defaults to `false`. If set to `true`, the model will output exactly one tool use. + + - `ToolChoiceNone = object { type }` + + The model will not be allowed to use tools. + + - `type: "none"` + + - `"none"` + +- `tools: optional array of ToolUnion` + + 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://docs.claude.com/en/docs/agents-and-tools/tool-use/overview#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/agents-and-tools/tool-use/web-search-tool)). + + 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://docs.claude.com/en/docs/tool-use) for more details. + + - `Tool = object { input_schema, name, allowed_callers, 7 more }` + + - `input_schema: object { type, properties, required }` + + [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. + + This defines the shape of the `input` that your tool accepts and that the model will produce. + + - `type: "object"` + + - `"object"` + + - `properties: optional map[unknown]` + + - `required: optional array of string` + + - `name: string` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `description: optional string` + + 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. + + - `eager_input_streaming: optional boolean` + + 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. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `type: optional "custom"` + + - `"custom"` + + - `ToolBash20250124 = object { name, type, allowed_callers, 4 more }` + + - `name: "bash"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"bash"` + + - `type: "bash_20250124"` + + - `"bash_20250124"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `CodeExecutionTool20250522 = object { name, type, allowed_callers, 3 more }` + + - `name: "code_execution"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"code_execution"` + + - `type: "code_execution_20250522"` + + - `"code_execution_20250522"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `CodeExecutionTool20250825 = object { name, type, allowed_callers, 3 more }` + + - `name: "code_execution"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"code_execution"` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `CodeExecutionTool20260120 = object { name, type, allowed_callers, 3 more }` + + Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). + + - `name: "code_execution"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"code_execution"` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `MemoryTool20250818 = object { name, type, allowed_callers, 4 more }` + + - `name: "memory"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"memory"` + + - `type: "memory_20250818"` + + - `"memory_20250818"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `ToolTextEditor20250124 = object { name, type, allowed_callers, 4 more }` + + - `name: "str_replace_editor"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"str_replace_editor"` + + - `type: "text_editor_20250124"` + + - `"text_editor_20250124"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `ToolTextEditor20250429 = object { name, type, allowed_callers, 4 more }` + + - `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. + + - `"str_replace_based_edit_tool"` + + - `type: "text_editor_20250429"` + + - `"text_editor_20250429"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `ToolTextEditor20250728 = object { name, type, allowed_callers, 5 more }` + + - `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. + + - `"str_replace_based_edit_tool"` + + - `type: "text_editor_20250728"` + + - `"text_editor_20250728"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `max_characters: optional number` + + Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `WebSearchTool20250305 = object { name, type, allowed_callers, 7 more }` + + - `name: "web_search"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"web_search"` + + - `type: "web_search_20250305"` + + - `"web_search_20250305"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `allowed_domains: optional array of string` + + If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. + + - `blocked_domains: optional array of string` + + If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `max_uses: optional number` + + Maximum number of times the tool can be used in the API request. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `user_location: optional UserLocation` + + Parameters for the user's location. Used to provide more relevant search results. + + - `type: "approximate"` + + - `"approximate"` + + - `city: optional string` + + The city of the user. + + - `country: optional string` + + The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. + + - `region: optional string` + + The region of the user. + + - `timezone: optional string` + + The [IANA timezone](https://nodatime.org/TimeZones) of the user. + + - `WebFetchTool20250910 = object { name, type, allowed_callers, 8 more }` + + - `name: "web_fetch"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"web_fetch"` + + - `type: "web_fetch_20250910"` + + - `"web_fetch_20250910"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `allowed_domains: optional array of string` + + List of domains to allow fetching from + + - `blocked_domains: optional array of string` + + List of domains to block fetching from + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional CitationsConfigParam` + + Citations configuration for fetched documents. Citations are disabled by default. + + - `enabled: optional boolean` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `max_content_tokens: optional number` + + 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. + + - `max_uses: optional number` + + Maximum number of times the tool can be used in the API request. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `WebSearchTool20260209 = object { name, type, allowed_callers, 7 more }` + + - `name: "web_search"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"web_search"` + + - `type: "web_search_20260209"` + + - `"web_search_20260209"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `allowed_domains: optional array of string` + + If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. + + - `blocked_domains: optional array of string` + + If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `max_uses: optional number` + + Maximum number of times the tool can be used in the API request. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `user_location: optional UserLocation` + + Parameters for the user's location. Used to provide more relevant search results. + + - `type: "approximate"` + + - `"approximate"` + + - `city: optional string` + + The city of the user. + + - `country: optional string` + + The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. + + - `region: optional string` + + The region of the user. + + - `timezone: optional string` + + The [IANA timezone](https://nodatime.org/TimeZones) of the user. + + - `WebFetchTool20260209 = object { name, type, allowed_callers, 8 more }` + + - `name: "web_fetch"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"web_fetch"` + + - `type: "web_fetch_20260209"` + + - `"web_fetch_20260209"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `allowed_domains: optional array of string` + + List of domains to allow fetching from + + - `blocked_domains: optional array of string` + + List of domains to block fetching from + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional CitationsConfigParam` + + Citations configuration for fetched documents. Citations are disabled by default. + + - `enabled: optional boolean` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `max_content_tokens: optional number` + + 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. + + - `max_uses: optional number` + + Maximum number of times the tool can be used in the API request. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `ToolSearchToolBm25_20251119 = object { name, type, allowed_callers, 3 more }` + + - `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. + + - `"tool_search_tool_bm25"` + + - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"` + + - `"tool_search_tool_bm25_20251119"` + + - `"tool_search_tool_bm25"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `ToolSearchToolRegex20251119 = object { name, type, allowed_callers, 3 more }` + + - `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. + + - `"tool_search_tool_regex"` + + - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"` + + - `"tool_search_tool_regex_20251119"` + + - `"tool_search_tool_regex"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional CacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + +- `top_k: optional number` + + Only sample from the top K options for each subsequent token. + + Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). + + Recommended for advanced use cases only. You usually only need to use `temperature`. + +- `top_p: optional number` + + Use nucleus sampling. + + In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. You should either alter `temperature` or `top_p`, but not both. + + Recommended for advanced use cases only. You usually only need to use `temperature`. + +### Returns + +- `Message = object { id, container, content, 6 more }` + + - `id: string` + + Unique object identifier. + + The format and length of IDs may change over time. + + - `container: Container` + + Information about the container used in the request (for the code execution tool) + + - `id: string` + + Identifier for the container used in this request + + - `expires_at: string` + + The time at which the container will expire. + + - `content: array of ContentBlock` + + 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)"}] + ``` + + - `TextBlock = object { citations, text, type }` + + - `citations: array of TextCitation` + + 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`. + + - `CitationCharLocation = object { cited_text, document_index, document_title, 4 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `file_id: string` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `CitationPageLocation = object { cited_text, document_index, document_title, 4 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `file_id: string` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `CitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `file_id: string` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `CitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `CitationsSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `ThinkingBlock = object { signature, thinking, type }` + + - `signature: string` + + - `thinking: string` + + - `type: "thinking"` + + - `"thinking"` + + - `RedactedThinkingBlock = object { data, type }` + + - `data: string` + + - `type: "redacted_thinking"` + + - `"redacted_thinking"` + + - `ToolUseBlock = object { id, caller, input, 2 more }` + + - `id: string` + + - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120` + + Tool invocation directly from the model. + + - `DirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `ServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `ServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `input: map[unknown]` + + - `name: string` + + - `type: "tool_use"` + + - `"tool_use"` + + - `ServerToolUseBlock = object { id, caller, input, 2 more }` + + - `id: string` + + - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120` + + Tool invocation directly from the model. + + - `DirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `ServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `ServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `input: map[unknown]` + + - `name: "web_search" or "web_fetch" or "code_execution" or 4 more` + + - `"web_search"` + + - `"web_fetch"` + + - `"code_execution"` + + - `"bash_code_execution"` + + - `"text_editor_code_execution"` + + - `"tool_search_tool_regex"` + + - `"tool_search_tool_bm25"` + + - `type: "server_tool_use"` + + - `"server_tool_use"` + + - `WebSearchToolResultBlock = object { caller, content, tool_use_id, type }` + + - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120` + + Tool invocation directly from the model. + + - `DirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `ServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `ServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `content: WebSearchToolResultBlockContent` + + - `WebSearchToolResultError = object { error_code, type }` + + - `error_code: WebSearchToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"max_uses_exceeded"` + + - `"too_many_requests"` + + - `"query_too_long"` + + - `"request_too_large"` + + - `type: "web_search_tool_result_error"` + + - `"web_search_tool_result_error"` + + - `UnionMember1 = array of WebSearchResultBlock` + + - `encrypted_content: string` + + - `page_age: string` + + - `title: string` + + - `type: "web_search_result"` + + - `"web_search_result"` + + - `url: string` + + - `tool_use_id: string` + + - `type: "web_search_tool_result"` + + - `"web_search_tool_result"` + + - `WebFetchToolResultBlock = object { caller, content, tool_use_id, type }` + + - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120` + + Tool invocation directly from the model. + + - `DirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `ServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `ServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `content: WebFetchToolResultErrorBlock or WebFetchBlock` + + - `WebFetchToolResultErrorBlock = object { error_code, type }` + + - `error_code: WebFetchToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"url_too_long"` + + - `"url_not_allowed"` + + - `"url_not_accessible"` + + - `"unsupported_content_type"` + + - `"too_many_requests"` + + - `"max_uses_exceeded"` + + - `"unavailable"` + + - `type: "web_fetch_tool_result_error"` + + - `"web_fetch_tool_result_error"` + + - `WebFetchBlock = object { content, retrieved_at, type, url }` + + - `content: DocumentBlock` + + - `citations: CitationsConfig` + + Citation configuration for the document + + - `enabled: boolean` + + - `source: Base64PDFSource or PlainTextSource` + + - `Base64PDFSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "application/pdf"` + + - `"application/pdf"` + + - `type: "base64"` + + - `"base64"` + + - `PlainTextSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "text/plain"` + + - `"text/plain"` + + - `type: "text"` + + - `"text"` + + - `title: string` + + The title of the document + + - `type: "document"` + + - `"document"` + + - `retrieved_at: string` + + ISO 8601 timestamp when the content was retrieved + + - `type: "web_fetch_result"` + + - `"web_fetch_result"` + + - `url: string` + + Fetched content URL + + - `tool_use_id: string` + + - `type: "web_fetch_tool_result"` + + - `"web_fetch_tool_result"` + + - `CodeExecutionToolResultBlock = object { content, tool_use_id, type }` + + - `content: CodeExecutionToolResultBlockContent` + + Code execution result with encrypted stdout for PFC + web_search results. + + - `CodeExecutionToolResultError = object { error_code, type }` + + - `error_code: CodeExecutionToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `type: "code_execution_tool_result_error"` + + - `"code_execution_tool_result_error"` + + - `CodeExecutionResultBlock = object { content, return_code, stderr, 2 more }` + + - `content: array of CodeExecutionOutputBlock` + + - `file_id: string` + + - `type: "code_execution_output"` + + - `"code_execution_output"` + + - `return_code: number` + + - `stderr: string` + + - `stdout: string` + + - `type: "code_execution_result"` + + - `"code_execution_result"` + + - `EncryptedCodeExecutionResultBlock = object { content, encrypted_stdout, return_code, 2 more }` + + Code execution result with encrypted stdout for PFC + web_search results. + + - `content: array of CodeExecutionOutputBlock` + + - `file_id: string` + + - `type: "code_execution_output"` + + - `"code_execution_output"` + + - `encrypted_stdout: string` + + - `return_code: number` + + - `stderr: string` + + - `type: "encrypted_code_execution_result"` + + - `"encrypted_code_execution_result"` + + - `tool_use_id: string` + + - `type: "code_execution_tool_result"` + + - `"code_execution_tool_result"` + + - `BashCodeExecutionToolResultBlock = object { content, tool_use_id, type }` + + - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock` + + - `BashCodeExecutionToolResultError = object { error_code, type }` + + - `error_code: BashCodeExecutionToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `"output_file_too_large"` + + - `type: "bash_code_execution_tool_result_error"` + + - `"bash_code_execution_tool_result_error"` + + - `BashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }` + + - `content: array of BashCodeExecutionOutputBlock` + + - `file_id: string` + + - `type: "bash_code_execution_output"` + + - `"bash_code_execution_output"` + + - `return_code: number` + + - `stderr: string` + + - `stdout: string` + + - `type: "bash_code_execution_result"` + + - `"bash_code_execution_result"` + + - `tool_use_id: string` + + - `type: "bash_code_execution_tool_result"` + + - `"bash_code_execution_tool_result"` + + - `TextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }` + + - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock` + + - `TextEditorCodeExecutionToolResultError = object { error_code, error_message, type }` + + - `error_code: TextEditorCodeExecutionToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `"file_not_found"` + + - `error_message: string` + + - `type: "text_editor_code_execution_tool_result_error"` + + - `"text_editor_code_execution_tool_result_error"` + + - `TextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }` + + - `content: string` + + - `file_type: "text" or "image" or "pdf"` + + - `"text"` + + - `"image"` + + - `"pdf"` + + - `num_lines: number` + + - `start_line: number` + + - `total_lines: number` + + - `type: "text_editor_code_execution_view_result"` + + - `"text_editor_code_execution_view_result"` + + - `TextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }` + + - `is_file_update: boolean` + + - `type: "text_editor_code_execution_create_result"` + + - `"text_editor_code_execution_create_result"` + + - `TextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }` + + - `lines: array of string` + + - `new_lines: number` + + - `new_start: number` + + - `old_lines: number` + + - `old_start: number` + + - `type: "text_editor_code_execution_str_replace_result"` + + - `"text_editor_code_execution_str_replace_result"` + + - `tool_use_id: string` + + - `type: "text_editor_code_execution_tool_result"` + + - `"text_editor_code_execution_tool_result"` + + - `ToolSearchToolResultBlock = object { content, tool_use_id, type }` + + - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock` + + - `ToolSearchToolResultError = object { error_code, error_message, type }` + + - `error_code: ToolSearchToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `error_message: string` + + - `type: "tool_search_tool_result_error"` + + - `"tool_search_tool_result_error"` + + - `ToolSearchToolSearchResultBlock = object { tool_references, type }` + + - `tool_references: array of ToolReferenceBlock` + + - `tool_name: string` + + - `type: "tool_reference"` + + - `"tool_reference"` + + - `type: "tool_search_tool_search_result"` + + - `"tool_search_tool_search_result"` + + - `tool_use_id: string` + + - `type: "tool_search_tool_result"` + + - `"tool_search_tool_result"` + + - `ContainerUploadBlock = object { file_id, type }` + + Response model for a file uploaded to the container. + + - `file_id: string` + + - `type: "container_upload"` + + - `"container_upload"` + + - `model: Model` + + The model that will complete your prompt. + + See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. + + - `UnionMember0 = "claude-opus-4-6" or "claude-sonnet-4-6" or "claude-opus-4-5-20251101" or 19 more` + + The model that will complete your prompt. + + See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. + + - `"claude-opus-4-6"` + + Most intelligent model for building agents and coding + + - `"claude-sonnet-4-6"` + + Frontier intelligence at scale — built for coding, agents, and enterprise workflows + + - `"claude-opus-4-5-20251101"` + + Premium model combining maximum intelligence with practical performance + + - `"claude-opus-4-5"` + + Premium model combining maximum intelligence with practical performance + + - `"claude-3-7-sonnet-latest"` + + High-performance model with early extended thinking + + - `"claude-3-7-sonnet-20250219"` + + High-performance model with early extended thinking + + - `"claude-3-5-haiku-latest"` + + Fastest and most compact model for near-instant responsiveness + + - `"claude-3-5-haiku-20241022"` + + Our fastest model + + - `"claude-haiku-4-5"` + + Hybrid model, capable of near-instant responses and extended thinking + + - `"claude-haiku-4-5-20251001"` + + Hybrid model, capable of near-instant responses and extended thinking + + - `"claude-sonnet-4-20250514"` + + High-performance model with extended thinking + + - `"claude-sonnet-4-0"` + + High-performance model with extended thinking + + - `"claude-4-sonnet-20250514"` + + High-performance model with extended thinking + + - `"claude-sonnet-4-5"` + + Our best model for real-world agents and coding + + - `"claude-sonnet-4-5-20250929"` + + Our best model for real-world agents and coding + + - `"claude-opus-4-0"` + + Our most capable model + + - `"claude-opus-4-20250514"` + + Our most capable model + + - `"claude-4-opus-20250514"` + + Our most capable model + + - `"claude-opus-4-1-20250805"` + + Our most capable model + + - `"claude-3-opus-latest"` + + Excels at writing and complex tasks + + - `"claude-3-opus-20240229"` + + Excels at writing and complex tasks + + - `"claude-3-haiku-20240307"` + + Our previous most fast and cost-effective + + - `UnionMember1 = string` + + - `role: "assistant"` + + Conversational role of the generated message. + + This will always be `"assistant"`. + + - `"assistant"` + + - `stop_reason: 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 + + 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. + + - `"end_turn"` + + - `"max_tokens"` + + - `"stop_sequence"` + + - `"tool_use"` + + - `"pause_turn"` + + - `"refusal"` + + - `stop_sequence: string` + + Which custom stop sequence was generated, if any. + + This value will be a non-null string if one of your custom stop sequences was generated. + + - `type: "message"` + + Object type. + + For Messages, this is always `"message"`. + + - `"message"` + + - `usage: 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`. + + - `cache_creation: CacheCreation` + + Breakdown of cached tokens by TTL + + - `ephemeral_1h_input_tokens: number` + + The number of input tokens used to create the 1 hour cache entry. + + - `ephemeral_5m_input_tokens: number` + + The number of input tokens used to create the 5 minute cache entry. + + - `cache_creation_input_tokens: number` + + The number of input tokens used to create the cache entry. + + - `cache_read_input_tokens: number` + + The number of input tokens read from the cache. + + - `inference_geo: string` + + The geographic region where inference was performed for this request. + + - `input_tokens: number` + + The number of input tokens which were used. + + - `output_tokens: number` + + The number of output tokens which were used. + + - `server_tool_use: ServerToolUsage` + + The number of server tool requests. + + - `web_fetch_requests: number` + + The number of web fetch tool requests. + + - `web_search_requests: number` + + The number of web search tool requests. + + - `service_tier: "standard" or "priority" or "batch"` + + If the request used the priority, standard, or batch tier. + + - `"standard"` + + - `"priority"` + + - `"batch"` + +### Example + +```http +curl https://api.anthropic.com/v1/messages \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + --max-time 600 \ + -d '{ + "max_tokens": 1024, + "messages": [ + { + "content": "Hello, world", + "role": "user" + } + ], + "model": "claude-opus-4-6" + }' +``` \ No newline at end of file diff --git a/docs/anthropic_api_ref_create_message_beta.md b/docs/anthropic_api_ref_create_message_beta.md new file mode 100644 index 0000000..15f2b89 --- /dev/null +++ b/docs/anthropic_api_ref_create_message_beta.md @@ -0,0 +1,5906 @@ +## Create + +**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://docs.claude.com/en/docs/initial-setup) + +### Header Parameters + +- `"anthropic-beta": optional array of AnthropicBeta` + + Optional header to specify the beta version(s) you want to use. + + - `UnionMember0 = string` + + - `UnionMember1 = "message-batches-2024-09-24" or "prompt-caching-2024-07-31" or "computer-use-2024-10-22" or 17 more` + + - `"message-batches-2024-09-24"` + + - `"prompt-caching-2024-07-31"` + + - `"computer-use-2024-10-22"` + + - `"computer-use-2025-01-24"` + + - `"pdfs-2024-09-25"` + + - `"token-counting-2024-11-01"` + + - `"token-efficient-tools-2025-02-19"` + + - `"output-128k-2025-02-19"` + + - `"files-api-2025-04-14"` + + - `"mcp-client-2025-04-04"` + + - `"mcp-client-2025-11-20"` + + - `"dev-full-thinking-2025-05-14"` + + - `"interleaved-thinking-2025-05-14"` + + - `"code-execution-2025-05-22"` + + - `"extended-cache-ttl-2025-04-11"` + + - `"context-1m-2025-08-07"` + + - `"context-management-2025-06-27"` + + - `"model-context-window-exceeded-2025-08-26"` + + - `"skills-2025-10-02"` + + - `"fast-mode-2026-02-01"` + +### Body Parameters + +- `max_tokens: number` + + 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. + + Different models have different maximum values for this parameter. See [models](https://docs.claude.com/en/docs/models-overview) for details. + +- `messages: array of BetaMessageParam` + + Input messages. + + Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. + + Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. + + If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. + + 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: + + ```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://docs.claude.com/en/api/messages-examples). + + Note that if you want to include a [system prompt](https://docs.claude.com/en/docs/system-prompts), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. + + There is a limit of 100,000 messages in a single request. + + - `content: string or array of BetaContentBlockParam` + + - `UnionMember0 = string` + + - `UnionMember1 = array of BetaContentBlockParam` + + - `BetaTextBlockParam = object { text, type, cache_control, citations }` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of BetaTextCitationParam` + + - `BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `BetaImageBlockParam = object { source, type, cache_control }` + + - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` + + - `BetaBase64ImageSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` + + - `"image/jpeg"` + + - `"image/png"` + + - `"image/gif"` + + - `"image/webp"` + + - `type: "base64"` + + - `"base64"` + + - `BetaURLImageSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `BetaFileImageSource = object { file_id, type }` + + - `file_id: string` + + - `type: "file"` + + - `"file"` + + - `type: "image"` + + - `"image"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }` + + - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` + + - `BetaBase64PDFSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "application/pdf"` + + - `"application/pdf"` + + - `type: "base64"` + + - `"base64"` + + - `BetaPlainTextSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "text/plain"` + + - `"text/plain"` + + - `type: "text"` + + - `"text"` + + - `BetaContentBlockSource = object { content, type }` + + - `content: string or array of BetaContentBlockSourceContent` + + - `UnionMember0 = string` + + - `BetaContentBlockSourceContent = array of BetaContentBlockSourceContent` + + - `BetaTextBlockParam = object { text, type, cache_control, citations }` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of BetaTextCitationParam` + + - `BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `BetaImageBlockParam = object { source, type, cache_control }` + + - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` + + - `BetaBase64ImageSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` + + - `"image/jpeg"` + + - `"image/png"` + + - `"image/gif"` + + - `"image/webp"` + + - `type: "base64"` + + - `"base64"` + + - `BetaURLImageSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `BetaFileImageSource = object { file_id, type }` + + - `file_id: string` + + - `type: "file"` + + - `"file"` + + - `type: "image"` + + - `"image"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `type: "content"` + + - `"content"` + + - `BetaURLPDFSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `BetaFileDocumentSource = object { file_id, type }` + + - `file_id: string` + + - `type: "file"` + + - `"file"` + + - `type: "document"` + + - `"document"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional BetaCitationsConfigParam` + + - `enabled: optional boolean` + + - `context: optional string` + + - `title: optional string` + + - `BetaSearchResultBlockParam = object { content, source, title, 3 more }` + + - `content: array of BetaTextBlockParam` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of BetaTextCitationParam` + + - `BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `source: string` + + - `title: string` + + - `type: "search_result"` + + - `"search_result"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional BetaCitationsConfigParam` + + - `enabled: optional boolean` + + - `BetaThinkingBlockParam = object { signature, thinking, type }` + + - `signature: string` + + - `thinking: string` + + - `type: "thinking"` + + - `"thinking"` + + - `BetaRedactedThinkingBlockParam = object { data, type }` + + - `data: string` + + - `type: "redacted_thinking"` + + - `"redacted_thinking"` + + - `BetaToolUseBlockParam = object { id, input, name, 3 more }` + + - `id: string` + + - `input: map[unknown]` + + - `name: string` + + - `type: "tool_use"` + + - `"tool_use"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` + + Tool invocation directly from the model. + + - `BetaDirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `BetaServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `BetaServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `BetaToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }` + + - `tool_use_id: string` + + - `type: "tool_result"` + + - `"tool_result"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `content: optional string or array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 2 more` + + - `UnionMember0 = string` + + - `UnionMember1 = array of BetaTextBlockParam or BetaImageBlockParam or BetaSearchResultBlockParam or 2 more` + + - `BetaTextBlockParam = object { text, type, cache_control, citations }` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of BetaTextCitationParam` + + - `BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `BetaImageBlockParam = object { source, type, cache_control }` + + - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` + + - `BetaBase64ImageSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` + + - `"image/jpeg"` + + - `"image/png"` + + - `"image/gif"` + + - `"image/webp"` + + - `type: "base64"` + + - `"base64"` + + - `BetaURLImageSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `BetaFileImageSource = object { file_id, type }` + + - `file_id: string` + + - `type: "file"` + + - `"file"` + + - `type: "image"` + + - `"image"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `BetaSearchResultBlockParam = object { content, source, title, 3 more }` + + - `content: array of BetaTextBlockParam` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of BetaTextCitationParam` + + - `BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `source: string` + + - `title: string` + + - `type: "search_result"` + + - `"search_result"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional BetaCitationsConfigParam` + + - `enabled: optional boolean` + + - `BetaRequestDocumentBlock = object { source, type, cache_control, 3 more }` + + - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` + + - `BetaBase64PDFSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "application/pdf"` + + - `"application/pdf"` + + - `type: "base64"` + + - `"base64"` + + - `BetaPlainTextSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "text/plain"` + + - `"text/plain"` + + - `type: "text"` + + - `"text"` + + - `BetaContentBlockSource = object { content, type }` + + - `content: string or array of BetaContentBlockSourceContent` + + - `UnionMember0 = string` + + - `BetaContentBlockSourceContent = array of BetaContentBlockSourceContent` + + - `BetaTextBlockParam = object { text, type, cache_control, citations }` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of BetaTextCitationParam` + + - `BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `BetaImageBlockParam = object { source, type, cache_control }` + + - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` + + - `BetaBase64ImageSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` + + - `"image/jpeg"` + + - `"image/png"` + + - `"image/gif"` + + - `"image/webp"` + + - `type: "base64"` + + - `"base64"` + + - `BetaURLImageSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `BetaFileImageSource = object { file_id, type }` + + - `file_id: string` + + - `type: "file"` + + - `"file"` + + - `type: "image"` + + - `"image"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `type: "content"` + + - `"content"` + + - `BetaURLPDFSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `BetaFileDocumentSource = object { file_id, type }` + + - `file_id: string` + + - `type: "file"` + + - `"file"` + + - `type: "document"` + + - `"document"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional BetaCitationsConfigParam` + + - `enabled: optional boolean` + + - `context: optional string` + + - `title: optional string` + + - `BetaToolReferenceBlockParam = object { tool_name, type, cache_control }` + + Tool reference block that can be included in tool_result content. + + - `tool_name: string` + + - `type: "tool_reference"` + + - `"tool_reference"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `is_error: optional boolean` + + - `BetaServerToolUseBlockParam = object { id, input, name, 3 more }` + + - `id: string` + + - `input: map[unknown]` + + - `name: "web_search" or "web_fetch" or "code_execution" or 4 more` + + - `"web_search"` + + - `"web_fetch"` + + - `"code_execution"` + + - `"bash_code_execution"` + + - `"text_editor_code_execution"` + + - `"tool_search_tool_regex"` + + - `"tool_search_tool_bm25"` + + - `type: "server_tool_use"` + + - `"server_tool_use"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` + + Tool invocation directly from the model. + + - `BetaDirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `BetaServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `BetaServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `BetaWebSearchToolResultBlockParam = object { content, tool_use_id, type, 2 more }` + + - `content: BetaWebSearchToolResultBlockParamContent` + + - `ResultBlock = array of BetaWebSearchResultBlockParam` + + - `encrypted_content: string` + + - `title: string` + + - `type: "web_search_result"` + + - `"web_search_result"` + + - `url: string` + + - `page_age: optional string` + + - `BetaWebSearchToolRequestError = object { error_code, type }` + + - `error_code: BetaWebSearchToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"max_uses_exceeded"` + + - `"too_many_requests"` + + - `"query_too_long"` + + - `"request_too_large"` + + - `type: "web_search_tool_result_error"` + + - `"web_search_tool_result_error"` + + - `tool_use_id: string` + + - `type: "web_search_tool_result"` + + - `"web_search_tool_result"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` + + Tool invocation directly from the model. + + - `BetaDirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `BetaServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `BetaServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `BetaWebFetchToolResultBlockParam = object { content, tool_use_id, type, 2 more }` + + - `content: BetaWebFetchToolResultErrorBlockParam or BetaWebFetchBlockParam` + + - `BetaWebFetchToolResultErrorBlockParam = object { error_code, type }` + + - `error_code: BetaWebFetchToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"url_too_long"` + + - `"url_not_allowed"` + + - `"url_not_accessible"` + + - `"unsupported_content_type"` + + - `"too_many_requests"` + + - `"max_uses_exceeded"` + + - `"unavailable"` + + - `type: "web_fetch_tool_result_error"` + + - `"web_fetch_tool_result_error"` + + - `BetaWebFetchBlockParam = object { content, type, url, retrieved_at }` + + - `content: BetaRequestDocumentBlock` + + - `source: BetaBase64PDFSource or BetaPlainTextSource or BetaContentBlockSource or 2 more` + + - `BetaBase64PDFSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "application/pdf"` + + - `"application/pdf"` + + - `type: "base64"` + + - `"base64"` + + - `BetaPlainTextSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "text/plain"` + + - `"text/plain"` + + - `type: "text"` + + - `"text"` + + - `BetaContentBlockSource = object { content, type }` + + - `content: string or array of BetaContentBlockSourceContent` + + - `UnionMember0 = string` + + - `BetaContentBlockSourceContent = array of BetaContentBlockSourceContent` + + - `BetaTextBlockParam = object { text, type, cache_control, citations }` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of BetaTextCitationParam` + + - `BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `BetaImageBlockParam = object { source, type, cache_control }` + + - `source: BetaBase64ImageSource or BetaURLImageSource or BetaFileImageSource` + + - `BetaBase64ImageSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` + + - `"image/jpeg"` + + - `"image/png"` + + - `"image/gif"` + + - `"image/webp"` + + - `type: "base64"` + + - `"base64"` + + - `BetaURLImageSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `BetaFileImageSource = object { file_id, type }` + + - `file_id: string` + + - `type: "file"` + + - `"file"` + + - `type: "image"` + + - `"image"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `type: "content"` + + - `"content"` + + - `BetaURLPDFSource = object { type, url }` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `BetaFileDocumentSource = object { file_id, type }` + + - `file_id: string` + + - `type: "file"` + + - `"file"` + + - `type: "document"` + + - `"document"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional BetaCitationsConfigParam` + + - `enabled: optional boolean` + + - `context: optional string` + + - `title: optional string` + + - `type: "web_fetch_result"` + + - `"web_fetch_result"` + + - `url: string` + + Fetched content URL + + - `retrieved_at: optional string` + + ISO 8601 timestamp when the content was retrieved + + - `tool_use_id: string` + + - `type: "web_fetch_tool_result"` + + - `"web_fetch_tool_result"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` + + Tool invocation directly from the model. + + - `BetaDirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `BetaServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `BetaServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `BetaCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }` + + - `content: BetaCodeExecutionToolResultBlockParamContent` + + Code execution result with encrypted stdout for PFC + web_search results. + + - `BetaCodeExecutionToolResultErrorParam = object { error_code, type }` + + - `error_code: BetaCodeExecutionToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `type: "code_execution_tool_result_error"` + + - `"code_execution_tool_result_error"` + + - `BetaCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }` + + - `content: array of BetaCodeExecutionOutputBlockParam` + + - `file_id: string` + + - `type: "code_execution_output"` + + - `"code_execution_output"` + + - `return_code: number` + + - `stderr: string` + + - `stdout: string` + + - `type: "code_execution_result"` + + - `"code_execution_result"` + + - `BetaEncryptedCodeExecutionResultBlockParam = object { content, encrypted_stdout, return_code, 2 more }` + + Code execution result with encrypted stdout for PFC + web_search results. + + - `content: array of BetaCodeExecutionOutputBlockParam` + + - `file_id: string` + + - `type: "code_execution_output"` + + - `"code_execution_output"` + + - `encrypted_stdout: string` + + - `return_code: number` + + - `stderr: string` + + - `type: "encrypted_code_execution_result"` + + - `"encrypted_code_execution_result"` + + - `tool_use_id: string` + + - `type: "code_execution_tool_result"` + + - `"code_execution_tool_result"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `BetaBashCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }` + + - `content: BetaBashCodeExecutionToolResultErrorParam or BetaBashCodeExecutionResultBlockParam` + + - `BetaBashCodeExecutionToolResultErrorParam = object { error_code, type }` + + - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `"output_file_too_large"` + + - `type: "bash_code_execution_tool_result_error"` + + - `"bash_code_execution_tool_result_error"` + + - `BetaBashCodeExecutionResultBlockParam = object { content, return_code, stderr, 2 more }` + + - `content: array of BetaBashCodeExecutionOutputBlockParam` + + - `file_id: string` + + - `type: "bash_code_execution_output"` + + - `"bash_code_execution_output"` + + - `return_code: number` + + - `stderr: string` + + - `stdout: string` + + - `type: "bash_code_execution_result"` + + - `"bash_code_execution_result"` + + - `tool_use_id: string` + + - `type: "bash_code_execution_tool_result"` + + - `"bash_code_execution_tool_result"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `BetaTextEditorCodeExecutionToolResultBlockParam = object { content, tool_use_id, type, cache_control }` + + - `content: BetaTextEditorCodeExecutionToolResultErrorParam or BetaTextEditorCodeExecutionViewResultBlockParam or BetaTextEditorCodeExecutionCreateResultBlockParam or BetaTextEditorCodeExecutionStrReplaceResultBlockParam` + + - `BetaTextEditorCodeExecutionToolResultErrorParam = object { error_code, type, error_message }` + + - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `"file_not_found"` + + - `type: "text_editor_code_execution_tool_result_error"` + + - `"text_editor_code_execution_tool_result_error"` + + - `error_message: optional string` + + - `BetaTextEditorCodeExecutionViewResultBlockParam = object { content, file_type, type, 3 more }` + + - `content: string` + + - `file_type: "text" or "image" or "pdf"` + + - `"text"` + + - `"image"` + + - `"pdf"` + + - `type: "text_editor_code_execution_view_result"` + + - `"text_editor_code_execution_view_result"` + + - `num_lines: optional number` + + - `start_line: optional number` + + - `total_lines: optional number` + + - `BetaTextEditorCodeExecutionCreateResultBlockParam = object { is_file_update, type }` + + - `is_file_update: boolean` + + - `type: "text_editor_code_execution_create_result"` + + - `"text_editor_code_execution_create_result"` + + - `BetaTextEditorCodeExecutionStrReplaceResultBlockParam = object { type, lines, new_lines, 3 more }` + + - `type: "text_editor_code_execution_str_replace_result"` + + - `"text_editor_code_execution_str_replace_result"` + + - `lines: optional array of string` + + - `new_lines: optional number` + + - `new_start: optional number` + + - `old_lines: optional number` + + - `old_start: optional number` + + - `tool_use_id: string` + + - `type: "text_editor_code_execution_tool_result"` + + - `"text_editor_code_execution_tool_result"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `BetaToolSearchToolResultBlockParam = object { content, tool_use_id, type, cache_control }` + + - `content: BetaToolSearchToolResultErrorParam or BetaToolSearchToolSearchResultBlockParam` + + - `BetaToolSearchToolResultErrorParam = object { error_code, type }` + + - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `type: "tool_search_tool_result_error"` + + - `"tool_search_tool_result_error"` + + - `BetaToolSearchToolSearchResultBlockParam = object { tool_references, type }` + + - `tool_references: array of BetaToolReferenceBlockParam` + + - `tool_name: string` + + - `type: "tool_reference"` + + - `"tool_reference"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `type: "tool_search_tool_search_result"` + + - `"tool_search_tool_search_result"` + + - `tool_use_id: string` + + - `type: "tool_search_tool_result"` + + - `"tool_search_tool_result"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `BetaMCPToolUseBlockParam = object { id, input, name, 3 more }` + + - `id: string` + + - `input: map[unknown]` + + - `name: string` + + - `server_name: string` + + The name of the MCP server + + - `type: "mcp_tool_use"` + + - `"mcp_tool_use"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `BetaRequestMCPToolResultBlockParam = object { tool_use_id, type, cache_control, 2 more }` + + - `tool_use_id: string` + + - `type: "mcp_tool_result"` + + - `"mcp_tool_result"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `content: optional string or array of BetaTextBlockParam` + + - `UnionMember0 = string` + + - `BetaMCPToolResultBlockParamContent = array of BetaTextBlockParam` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of BetaTextCitationParam` + + - `BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `is_error: optional boolean` + + - `BetaContainerUploadBlockParam = object { file_id, type, cache_control }` + + A content block that represents a file to be uploaded to the container + Files uploaded via this block will be available in the container's input directory. + + - `file_id: string` + + - `type: "container_upload"` + + - `"container_upload"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `BetaCompactionBlockParam = object { content, type, cache_control }` + + 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. + + - `content: string` + + Summary of previously compacted content, or null if compaction failed + + - `type: "compaction"` + + - `"compaction"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `role: "user" or "assistant"` + + - `"user"` + + - `"assistant"` + +- `model: Model` + + The model that will complete your prompt. + + See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. + + - `UnionMember0 = "claude-opus-4-6" or "claude-sonnet-4-6" or "claude-opus-4-5-20251101" or 19 more` + + The model that will complete your prompt. + + See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. + + - `"claude-opus-4-6"` + + Most intelligent model for building agents and coding + + - `"claude-sonnet-4-6"` + + Frontier intelligence at scale — built for coding, agents, and enterprise workflows + + - `"claude-opus-4-5-20251101"` + + Premium model combining maximum intelligence with practical performance + + - `"claude-opus-4-5"` + + Premium model combining maximum intelligence with practical performance + + - `"claude-3-7-sonnet-latest"` + + High-performance model with early extended thinking + + - `"claude-3-7-sonnet-20250219"` + + High-performance model with early extended thinking + + - `"claude-3-5-haiku-latest"` + + Fastest and most compact model for near-instant responsiveness + + - `"claude-3-5-haiku-20241022"` + + Our fastest model + + - `"claude-haiku-4-5"` + + Hybrid model, capable of near-instant responses and extended thinking + + - `"claude-haiku-4-5-20251001"` + + Hybrid model, capable of near-instant responses and extended thinking + + - `"claude-sonnet-4-20250514"` + + High-performance model with extended thinking + + - `"claude-sonnet-4-0"` + + High-performance model with extended thinking + + - `"claude-4-sonnet-20250514"` + + High-performance model with extended thinking + + - `"claude-sonnet-4-5"` + + Our best model for real-world agents and coding + + - `"claude-sonnet-4-5-20250929"` + + Our best model for real-world agents and coding + + - `"claude-opus-4-0"` + + Our most capable model + + - `"claude-opus-4-20250514"` + + Our most capable model + + - `"claude-4-opus-20250514"` + + Our most capable model + + - `"claude-opus-4-1-20250805"` + + Our most capable model + + - `"claude-3-opus-latest"` + + Excels at writing and complex tasks + + - `"claude-3-opus-20240229"` + + Excels at writing and complex tasks + + - `"claude-3-haiku-20240307"` + + Our previous most fast and cost-effective + + - `UnionMember1 = string` + +- `cache_control: optional BetaCacheControlEphemeral` + + Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + +- `container: optional BetaContainerParams or string` + + Container identifier for reuse across requests. + + - `BetaContainerParams = object { id, skills }` + + Container parameters with skills to be loaded. + + - `id: optional string` + + Container id + + - `skills: optional array of BetaSkillParams` + + List of skills to load in the container + + - `skill_id: string` + + Skill ID + + - `type: "anthropic" or "custom"` + + Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) + + - `"anthropic"` + + - `"custom"` + + - `version: optional string` + + Skill version or 'latest' for most recent version + + - `UnionMember1 = string` + +- `context_management: optional BetaContextManagementConfig` + + Context management configuration. + + This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not. + + - `edits: optional array of BetaClearToolUses20250919Edit or BetaClearThinking20251015Edit or BetaCompact20260112Edit` + + List of context management edits to apply + + - `BetaClearToolUses20250919Edit = object { type, clear_at_least, clear_tool_inputs, 3 more }` + + - `type: "clear_tool_uses_20250919"` + + - `"clear_tool_uses_20250919"` + + - `clear_at_least: optional BetaInputTokensClearAtLeast` + + Minimum number of tokens that must be cleared when triggered. Context will only be modified if at least this many tokens can be removed. + + - `type: "input_tokens"` + + - `"input_tokens"` + + - `value: number` + + - `clear_tool_inputs: optional boolean or array of string` + + Whether to clear all tool inputs (bool) or specific tool inputs to clear (list) + + - `UnionMember0 = boolean` + + - `UnionMember1 = array of string` + + - `exclude_tools: optional array of string` + + Tool names whose uses are preserved from clearing + + - `keep: optional BetaToolUsesKeep` + + Number of tool uses to retain in the conversation + + - `type: "tool_uses"` + + - `"tool_uses"` + + - `value: number` + + - `trigger: optional BetaInputTokensTrigger or BetaToolUsesTrigger` + + Condition that triggers the context management strategy + + - `BetaInputTokensTrigger = object { type, value }` + + - `type: "input_tokens"` + + - `"input_tokens"` + + - `value: number` + + - `BetaToolUsesTrigger = object { type, value }` + + - `type: "tool_uses"` + + - `"tool_uses"` + + - `value: number` + + - `BetaClearThinking20251015Edit = object { type, keep }` + + - `type: "clear_thinking_20251015"` + + - `"clear_thinking_20251015"` + + - `keep: optional BetaThinkingTurns or BetaAllThinkingTurns or "all"` + + Number of most recent assistant turns to keep thinking blocks for. Older turns will have their thinking blocks removed. + + - `BetaThinkingTurns = object { type, value }` + + - `type: "thinking_turns"` + + - `"thinking_turns"` + + - `value: number` + + - `BetaAllThinkingTurns = object { type }` + + - `type: "all"` + + - `"all"` + + - `UnionMember2 = "all"` + + - `"all"` + + - `BetaCompact20260112Edit = object { type, instructions, pause_after_compaction, trigger }` + + Automatically compact older context when reaching the configured trigger threshold. + + - `type: "compact_20260112"` + + - `"compact_20260112"` + + - `instructions: optional string` + + Additional instructions for summarization. + + - `pause_after_compaction: optional boolean` + + Whether to pause after compaction and return the compaction block to the user. + + - `trigger: optional BetaInputTokensTrigger` + + When to trigger compaction. Defaults to 150000 input tokens. + + - `type: "input_tokens"` + + - `"input_tokens"` + + - `value: number` + +- `inference_geo: optional string` + + Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. + +- `mcp_servers: optional array of BetaRequestMCPServerURLDefinition` + + MCP servers to be utilized in this request + + - `name: string` + + - `type: "url"` + + - `"url"` + + - `url: string` + + - `authorization_token: optional string` + + - `tool_configuration: optional BetaRequestMCPServerToolConfiguration` + + - `allowed_tools: optional array of string` + + - `enabled: optional boolean` + +- `metadata: optional BetaMetadata` + + An object describing metadata about the request. + + - `user_id: optional string` + + 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. + +- `output_config: optional BetaOutputConfig` + + Configuration options for the model's output, such as the output format. + + - `effort: optional "low" or "medium" or "high" or "max"` + + All possible effort levels. + + - `"low"` + + - `"medium"` + + - `"high"` + + - `"max"` + + - `format: optional BetaJSONOutputFormat` + + A schema to specify Claude's output format in responses. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) + + - `schema: map[unknown]` + + The JSON schema of the format + + - `type: "json_schema"` + + - `"json_schema"` + +- `output_format: optional BetaJSONOutputFormat` + + Deprecated: Use `output_config.format` instead. See [structured outputs](https://platform.claude.com/docs/en/build-with-claude/structured-outputs) + + A schema to specify Claude's output format in responses. This parameter will be removed in a future release. + + - `schema: map[unknown]` + + The JSON schema of the format + + - `type: "json_schema"` + + - `"json_schema"` + +- `service_tier: optional "auto" or "standard_only"` + + 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://docs.claude.com/en/api/service-tiers) for details. + + - `"auto"` + + - `"standard_only"` + +- `speed: optional "standard" or "fast"` + + The inference speed mode for this request. `"fast"` enables high output-tokens-per-second inference. + + - `"standard"` + + - `"fast"` + +- `stop_sequences: optional array of string` + + Custom text sequences that will cause the model to stop generating. + + Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. + + If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. + +- `stream: optional boolean` + + Whether to incrementally stream the response using server-sent events. + + See [streaming](https://docs.claude.com/en/api/messages-streaming) for details. + +- `system: optional string or array of BetaTextBlockParam` + + 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://docs.claude.com/en/docs/system-prompts). + + - `UnionMember0 = string` + + - `UnionMember1 = array of BetaTextBlockParam` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional array of BetaTextCitationParam` + + - `BetaCitationCharLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `BetaCitationPageLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `BetaCitationContentBlockLocationParam = object { cited_text, document_index, document_title, 3 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `BetaCitationWebSearchResultLocationParam = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `BetaCitationSearchResultLocationParam = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + +- `temperature: optional number` + + Amount of randomness injected into the response. + + Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. + + Note that even with `temperature` of `0.0`, the results will not be fully deterministic. + +- `thinking: optional BetaThinkingConfigParam` + + Configuration for enabling Claude's extended thinking. + + When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. + + See [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. + + - `BetaThinkingConfigEnabled = object { budget_tokens, type }` + + - `budget_tokens: number` + + 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://docs.claude.com/en/docs/build-with-claude/extended-thinking) for details. + + - `type: "enabled"` + + - `"enabled"` + + - `BetaThinkingConfigDisabled = object { type }` + + - `type: "disabled"` + + - `"disabled"` + + - `BetaThinkingConfigAdaptive = object { type }` + + - `type: "adaptive"` + + - `"adaptive"` + +- `tool_choice: optional BetaToolChoice` + + 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. + + - `BetaToolChoiceAuto = object { type, disable_parallel_tool_use }` + + The model will automatically decide whether to use tools. + + - `type: "auto"` + + - `"auto"` + + - `disable_parallel_tool_use: optional boolean` + + Whether to disable parallel tool use. + + Defaults to `false`. If set to `true`, the model will output at most one tool use. + + - `BetaToolChoiceAny = object { type, disable_parallel_tool_use }` + + The model will use any available tools. + + - `type: "any"` + + - `"any"` + + - `disable_parallel_tool_use: optional boolean` + + Whether to disable parallel tool use. + + Defaults to `false`. If set to `true`, the model will output exactly one tool use. + + - `BetaToolChoiceTool = object { name, type, disable_parallel_tool_use }` + + The model will use the specified tool with `tool_choice.name`. + + - `name: string` + + The name of the tool to use. + + - `type: "tool"` + + - `"tool"` + + - `disable_parallel_tool_use: optional boolean` + + Whether to disable parallel tool use. + + Defaults to `false`. If set to `true`, the model will output exactly one tool use. + + - `BetaToolChoiceNone = object { type }` + + The model will not be allowed to use tools. + + - `type: "none"` + + - `"none"` + +- `tools: optional array of BetaToolUnion` + + 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://docs.claude.com/en/docs/agents-and-tools/tool-use/overview#server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://docs.claude.com/en/docs/agents-and-tools/tool-use/web-search-tool)). + + 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://docs.claude.com/en/docs/tool-use) for more details. + + - `BetaTool = object { input_schema, name, allowed_callers, 7 more }` + + - `input_schema: object { type, properties, required }` + + [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input. + + This defines the shape of the `input` that your tool accepts and that the model will produce. + + - `type: "object"` + + - `"object"` + + - `properties: optional map[unknown]` + + - `required: optional array of string` + + - `name: string` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `description: optional string` + + 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. + + - `eager_input_streaming: optional boolean` + + 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. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `type: optional "custom"` + + - `"custom"` + + - `BetaToolBash20241022 = object { name, type, allowed_callers, 4 more }` + + - `name: "bash"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"bash"` + + - `type: "bash_20241022"` + + - `"bash_20241022"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaToolBash20250124 = object { name, type, allowed_callers, 4 more }` + + - `name: "bash"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"bash"` + + - `type: "bash_20250124"` + + - `"bash_20250124"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaCodeExecutionTool20250522 = object { name, type, allowed_callers, 3 more }` + + - `name: "code_execution"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"code_execution"` + + - `type: "code_execution_20250522"` + + - `"code_execution_20250522"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaCodeExecutionTool20250825 = object { name, type, allowed_callers, 3 more }` + + - `name: "code_execution"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"code_execution"` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaCodeExecutionTool20260120 = object { name, type, allowed_callers, 3 more }` + + Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). + + - `name: "code_execution"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"code_execution"` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaToolComputerUse20241022 = object { display_height_px, display_width_px, name, 7 more }` + + - `display_height_px: number` + + The height of the display in pixels. + + - `display_width_px: number` + + The width of the display in pixels. + + - `name: "computer"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"computer"` + + - `type: "computer_20241022"` + + - `"computer_20241022"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `display_number: optional number` + + The X11 display number (e.g. 0, 1) for the display. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaMemoryTool20250818 = object { name, type, allowed_callers, 4 more }` + + - `name: "memory"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"memory"` + + - `type: "memory_20250818"` + + - `"memory_20250818"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaToolComputerUse20250124 = object { display_height_px, display_width_px, name, 7 more }` + + - `display_height_px: number` + + The height of the display in pixels. + + - `display_width_px: number` + + The width of the display in pixels. + + - `name: "computer"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"computer"` + + - `type: "computer_20250124"` + + - `"computer_20250124"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `display_number: optional number` + + The X11 display number (e.g. 0, 1) for the display. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaToolTextEditor20241022 = object { name, type, allowed_callers, 4 more }` + + - `name: "str_replace_editor"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"str_replace_editor"` + + - `type: "text_editor_20241022"` + + - `"text_editor_20241022"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaToolComputerUse20251124 = object { display_height_px, display_width_px, name, 8 more }` + + - `display_height_px: number` + + The height of the display in pixels. + + - `display_width_px: number` + + The width of the display in pixels. + + - `name: "computer"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"computer"` + + - `type: "computer_20251124"` + + - `"computer_20251124"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `display_number: optional number` + + The X11 display number (e.g. 0, 1) for the display. + + - `enable_zoom: optional boolean` + + Whether to enable an action to take a zoomed-in screenshot of the screen. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaToolTextEditor20250124 = object { name, type, allowed_callers, 4 more }` + + - `name: "str_replace_editor"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"str_replace_editor"` + + - `type: "text_editor_20250124"` + + - `"text_editor_20250124"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaToolTextEditor20250429 = object { name, type, allowed_callers, 4 more }` + + - `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. + + - `"str_replace_based_edit_tool"` + + - `type: "text_editor_20250429"` + + - `"text_editor_20250429"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaToolTextEditor20250728 = object { name, type, allowed_callers, 5 more }` + + - `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. + + - `"str_replace_based_edit_tool"` + + - `type: "text_editor_20250728"` + + - `"text_editor_20250728"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `input_examples: optional array of map[unknown]` + + - `max_characters: optional number` + + Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaWebSearchTool20250305 = object { name, type, allowed_callers, 7 more }` + + - `name: "web_search"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"web_search"` + + - `type: "web_search_20250305"` + + - `"web_search_20250305"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `allowed_domains: optional array of string` + + If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. + + - `blocked_domains: optional array of string` + + If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `max_uses: optional number` + + Maximum number of times the tool can be used in the API request. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `user_location: optional BetaUserLocation` + + Parameters for the user's location. Used to provide more relevant search results. + + - `type: "approximate"` + + - `"approximate"` + + - `city: optional string` + + The city of the user. + + - `country: optional string` + + The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. + + - `region: optional string` + + The region of the user. + + - `timezone: optional string` + + The [IANA timezone](https://nodatime.org/TimeZones) of the user. + + - `BetaWebFetchTool20250910 = object { name, type, allowed_callers, 8 more }` + + - `name: "web_fetch"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"web_fetch"` + + - `type: "web_fetch_20250910"` + + - `"web_fetch_20250910"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `allowed_domains: optional array of string` + + List of domains to allow fetching from + + - `blocked_domains: optional array of string` + + List of domains to block fetching from + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional BetaCitationsConfigParam` + + Citations configuration for fetched documents. Citations are disabled by default. + + - `enabled: optional boolean` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `max_content_tokens: optional number` + + 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. + + - `max_uses: optional number` + + Maximum number of times the tool can be used in the API request. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaWebSearchTool20260209 = object { name, type, allowed_callers, 7 more }` + + - `name: "web_search"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"web_search"` + + - `type: "web_search_20260209"` + + - `"web_search_20260209"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `allowed_domains: optional array of string` + + If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. + + - `blocked_domains: optional array of string` + + If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `max_uses: optional number` + + Maximum number of times the tool can be used in the API request. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `user_location: optional BetaUserLocation` + + Parameters for the user's location. Used to provide more relevant search results. + + - `type: "approximate"` + + - `"approximate"` + + - `city: optional string` + + The city of the user. + + - `country: optional string` + + The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. + + - `region: optional string` + + The region of the user. + + - `timezone: optional string` + + The [IANA timezone](https://nodatime.org/TimeZones) of the user. + + - `BetaWebFetchTool20260209 = object { name, type, allowed_callers, 8 more }` + + - `name: "web_fetch"` + + Name of the tool. + + This is how the tool will be called by the model and in `tool_use` blocks. + + - `"web_fetch"` + + - `type: "web_fetch_20260209"` + + - `"web_fetch_20260209"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `allowed_domains: optional array of string` + + List of domains to allow fetching from + + - `blocked_domains: optional array of string` + + List of domains to block fetching from + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `citations: optional BetaCitationsConfigParam` + + Citations configuration for fetched documents. Citations are disabled by default. + + - `enabled: optional boolean` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `max_content_tokens: optional number` + + 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. + + - `max_uses: optional number` + + Maximum number of times the tool can be used in the API request. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaToolSearchToolBm25_20251119 = object { name, type, allowed_callers, 3 more }` + + - `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. + + - `"tool_search_tool_bm25"` + + - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"` + + - `"tool_search_tool_bm25_20251119"` + + - `"tool_search_tool_bm25"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaToolSearchToolRegex20251119 = object { name, type, allowed_callers, 3 more }` + + - `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. + + - `"tool_search_tool_regex"` + + - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"` + + - `"tool_search_tool_regex_20251119"` + + - `"tool_search_tool_regex"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120"` + + - `"direct"` + + - `"code_execution_20250825"` + + - `"code_execution_20260120"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `defer_loading: optional boolean` + + If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. + + - `strict: optional boolean` + + When true, guarantees schema validation on tool names and inputs + + - `BetaMCPToolset = object { mcp_server_name, type, cache_control, 2 more }` + + 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. + + - `mcp_server_name: string` + + Name of the MCP server to configure tools for + + - `type: "mcp_toolset"` + + - `"mcp_toolset"` + + - `cache_control: optional BetaCacheControlEphemeral` + + Create a cache control breakpoint at this content block. + + - `type: "ephemeral"` + + - `"ephemeral"` + + - `ttl: optional "5m" or "1h"` + + The time-to-live for the cache control breakpoint. + + This may be one the following values: + + - `5m`: 5 minutes + - `1h`: 1 hour + + Defaults to `5m`. + + - `"5m"` + + - `"1h"` + + - `configs: optional map[BetaMCPToolConfig]` + + Configuration overrides for specific tools, keyed by tool name + + - `defer_loading: optional boolean` + + - `enabled: optional boolean` + + - `default_config: optional BetaMCPToolDefaultConfig` + + Default configuration applied to all tools from this server + + - `defer_loading: optional boolean` + + - `enabled: optional boolean` + +- `top_k: optional number` + + Only sample from the top K options for each subsequent token. + + Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). + + Recommended for advanced use cases only. You usually only need to use `temperature`. + +- `top_p: optional number` + + Use nucleus sampling. + + In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. You should either alter `temperature` or `top_p`, but not both. + + Recommended for advanced use cases only. You usually only need to use `temperature`. + +### Returns + +- `BetaMessage = object { id, container, content, 7 more }` + + - `id: string` + + Unique object identifier. + + The format and length of IDs may change over time. + + - `container: BetaContainer` + + Information about the container used in the request (for the code execution tool) + + - `id: string` + + Identifier for the container used in this request + + - `expires_at: string` + + The time at which the container will expire. + + - `skills: array of BetaSkill` + + Skills loaded in the container + + - `skill_id: string` + + Skill ID + + - `type: "anthropic" or "custom"` + + Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined) + + - `"anthropic"` + + - `"custom"` + + - `version: string` + + Skill version or 'latest' for most recent version + + - `content: array of BetaContentBlock` + + 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)"}] + ``` + + - `BetaTextBlock = object { citations, text, type }` + + - `citations: array of BetaTextCitation` + + 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`. + + - `BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `file_id: string` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `file_id: string` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `file_id: string` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `BetaThinkingBlock = object { signature, thinking, type }` + + - `signature: string` + + - `thinking: string` + + - `type: "thinking"` + + - `"thinking"` + + - `BetaRedactedThinkingBlock = object { data, type }` + + - `data: string` + + - `type: "redacted_thinking"` + + - `"redacted_thinking"` + + - `BetaToolUseBlock = object { id, input, name, 2 more }` + + - `id: string` + + - `input: map[unknown]` + + - `name: string` + + - `type: "tool_use"` + + - `"tool_use"` + + - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` + + Tool invocation directly from the model. + + - `BetaDirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `BetaServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `BetaServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `BetaServerToolUseBlock = object { id, input, name, 2 more }` + + - `id: string` + + - `input: map[unknown]` + + - `name: "web_search" or "web_fetch" or "code_execution" or 4 more` + + - `"web_search"` + + - `"web_fetch"` + + - `"code_execution"` + + - `"bash_code_execution"` + + - `"text_editor_code_execution"` + + - `"tool_search_tool_regex"` + + - `"tool_search_tool_bm25"` + + - `type: "server_tool_use"` + + - `"server_tool_use"` + + - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` + + Tool invocation directly from the model. + + - `BetaDirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `BetaServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `BetaServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `BetaWebSearchToolResultBlock = object { content, tool_use_id, type, caller }` + + - `content: BetaWebSearchToolResultBlockContent` + + - `BetaWebSearchToolResultError = object { error_code, type }` + + - `error_code: BetaWebSearchToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"max_uses_exceeded"` + + - `"too_many_requests"` + + - `"query_too_long"` + + - `"request_too_large"` + + - `type: "web_search_tool_result_error"` + + - `"web_search_tool_result_error"` + + - `UnionMember1 = array of BetaWebSearchResultBlock` + + - `encrypted_content: string` + + - `page_age: string` + + - `title: string` + + - `type: "web_search_result"` + + - `"web_search_result"` + + - `url: string` + + - `tool_use_id: string` + + - `type: "web_search_tool_result"` + + - `"web_search_tool_result"` + + - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` + + Tool invocation directly from the model. + + - `BetaDirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `BetaServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `BetaServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `BetaWebFetchToolResultBlock = object { content, tool_use_id, type, caller }` + + - `content: BetaWebFetchToolResultErrorBlock or BetaWebFetchBlock` + + - `BetaWebFetchToolResultErrorBlock = object { error_code, type }` + + - `error_code: BetaWebFetchToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"url_too_long"` + + - `"url_not_allowed"` + + - `"url_not_accessible"` + + - `"unsupported_content_type"` + + - `"too_many_requests"` + + - `"max_uses_exceeded"` + + - `"unavailable"` + + - `type: "web_fetch_tool_result_error"` + + - `"web_fetch_tool_result_error"` + + - `BetaWebFetchBlock = object { content, retrieved_at, type, url }` + + - `content: BetaDocumentBlock` + + - `citations: BetaCitationConfig` + + Citation configuration for the document + + - `enabled: boolean` + + - `source: BetaBase64PDFSource or BetaPlainTextSource` + + - `BetaBase64PDFSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "application/pdf"` + + - `"application/pdf"` + + - `type: "base64"` + + - `"base64"` + + - `BetaPlainTextSource = object { data, media_type, type }` + + - `data: string` + + - `media_type: "text/plain"` + + - `"text/plain"` + + - `type: "text"` + + - `"text"` + + - `title: string` + + The title of the document + + - `type: "document"` + + - `"document"` + + - `retrieved_at: string` + + ISO 8601 timestamp when the content was retrieved + + - `type: "web_fetch_result"` + + - `"web_fetch_result"` + + - `url: string` + + Fetched content URL + + - `tool_use_id: string` + + - `type: "web_fetch_tool_result"` + + - `"web_fetch_tool_result"` + + - `caller: optional BetaDirectCaller or BetaServerToolCaller or BetaServerToolCaller20260120` + + Tool invocation directly from the model. + + - `BetaDirectCaller = object { type }` + + Tool invocation directly from the model. + + - `type: "direct"` + + - `"direct"` + + - `BetaServerToolCaller = object { tool_id, type }` + + Tool invocation generated by a server-side tool. + + - `tool_id: string` + + - `type: "code_execution_20250825"` + + - `"code_execution_20250825"` + + - `BetaServerToolCaller20260120 = object { tool_id, type }` + + - `tool_id: string` + + - `type: "code_execution_20260120"` + + - `"code_execution_20260120"` + + - `BetaCodeExecutionToolResultBlock = object { content, tool_use_id, type }` + + - `content: BetaCodeExecutionToolResultBlockContent` + + Code execution result with encrypted stdout for PFC + web_search results. + + - `BetaCodeExecutionToolResultError = object { error_code, type }` + + - `error_code: BetaCodeExecutionToolResultErrorCode` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `type: "code_execution_tool_result_error"` + + - `"code_execution_tool_result_error"` + + - `BetaCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }` + + - `content: array of BetaCodeExecutionOutputBlock` + + - `file_id: string` + + - `type: "code_execution_output"` + + - `"code_execution_output"` + + - `return_code: number` + + - `stderr: string` + + - `stdout: string` + + - `type: "code_execution_result"` + + - `"code_execution_result"` + + - `BetaEncryptedCodeExecutionResultBlock = object { content, encrypted_stdout, return_code, 2 more }` + + Code execution result with encrypted stdout for PFC + web_search results. + + - `content: array of BetaCodeExecutionOutputBlock` + + - `file_id: string` + + - `type: "code_execution_output"` + + - `"code_execution_output"` + + - `encrypted_stdout: string` + + - `return_code: number` + + - `stderr: string` + + - `type: "encrypted_code_execution_result"` + + - `"encrypted_code_execution_result"` + + - `tool_use_id: string` + + - `type: "code_execution_tool_result"` + + - `"code_execution_tool_result"` + + - `BetaBashCodeExecutionToolResultBlock = object { content, tool_use_id, type }` + + - `content: BetaBashCodeExecutionToolResultError or BetaBashCodeExecutionResultBlock` + + - `BetaBashCodeExecutionToolResultError = object { error_code, type }` + + - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `"output_file_too_large"` + + - `type: "bash_code_execution_tool_result_error"` + + - `"bash_code_execution_tool_result_error"` + + - `BetaBashCodeExecutionResultBlock = object { content, return_code, stderr, 2 more }` + + - `content: array of BetaBashCodeExecutionOutputBlock` + + - `file_id: string` + + - `type: "bash_code_execution_output"` + + - `"bash_code_execution_output"` + + - `return_code: number` + + - `stderr: string` + + - `stdout: string` + + - `type: "bash_code_execution_result"` + + - `"bash_code_execution_result"` + + - `tool_use_id: string` + + - `type: "bash_code_execution_tool_result"` + + - `"bash_code_execution_tool_result"` + + - `BetaTextEditorCodeExecutionToolResultBlock = object { content, tool_use_id, type }` + + - `content: BetaTextEditorCodeExecutionToolResultError or BetaTextEditorCodeExecutionViewResultBlock or BetaTextEditorCodeExecutionCreateResultBlock or BetaTextEditorCodeExecutionStrReplaceResultBlock` + + - `BetaTextEditorCodeExecutionToolResultError = object { error_code, error_message, type }` + + - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or 2 more` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `"file_not_found"` + + - `error_message: string` + + - `type: "text_editor_code_execution_tool_result_error"` + + - `"text_editor_code_execution_tool_result_error"` + + - `BetaTextEditorCodeExecutionViewResultBlock = object { content, file_type, num_lines, 3 more }` + + - `content: string` + + - `file_type: "text" or "image" or "pdf"` + + - `"text"` + + - `"image"` + + - `"pdf"` + + - `num_lines: number` + + - `start_line: number` + + - `total_lines: number` + + - `type: "text_editor_code_execution_view_result"` + + - `"text_editor_code_execution_view_result"` + + - `BetaTextEditorCodeExecutionCreateResultBlock = object { is_file_update, type }` + + - `is_file_update: boolean` + + - `type: "text_editor_code_execution_create_result"` + + - `"text_editor_code_execution_create_result"` + + - `BetaTextEditorCodeExecutionStrReplaceResultBlock = object { lines, new_lines, new_start, 3 more }` + + - `lines: array of string` + + - `new_lines: number` + + - `new_start: number` + + - `old_lines: number` + + - `old_start: number` + + - `type: "text_editor_code_execution_str_replace_result"` + + - `"text_editor_code_execution_str_replace_result"` + + - `tool_use_id: string` + + - `type: "text_editor_code_execution_tool_result"` + + - `"text_editor_code_execution_tool_result"` + + - `BetaToolSearchToolResultBlock = object { content, tool_use_id, type }` + + - `content: BetaToolSearchToolResultError or BetaToolSearchToolSearchResultBlock` + + - `BetaToolSearchToolResultError = object { error_code, error_message, type }` + + - `error_code: "invalid_tool_input" or "unavailable" or "too_many_requests" or "execution_time_exceeded"` + + - `"invalid_tool_input"` + + - `"unavailable"` + + - `"too_many_requests"` + + - `"execution_time_exceeded"` + + - `error_message: string` + + - `type: "tool_search_tool_result_error"` + + - `"tool_search_tool_result_error"` + + - `BetaToolSearchToolSearchResultBlock = object { tool_references, type }` + + - `tool_references: array of BetaToolReferenceBlock` + + - `tool_name: string` + + - `type: "tool_reference"` + + - `"tool_reference"` + + - `type: "tool_search_tool_search_result"` + + - `"tool_search_tool_search_result"` + + - `tool_use_id: string` + + - `type: "tool_search_tool_result"` + + - `"tool_search_tool_result"` + + - `BetaMCPToolUseBlock = object { id, input, name, 2 more }` + + - `id: string` + + - `input: map[unknown]` + + - `name: string` + + The name of the MCP tool + + - `server_name: string` + + The name of the MCP server + + - `type: "mcp_tool_use"` + + - `"mcp_tool_use"` + + - `BetaMCPToolResultBlock = object { content, is_error, tool_use_id, type }` + + - `content: string or array of BetaTextBlock` + + - `UnionMember0 = string` + + - `BetaMCPToolResultBlockContent = array of BetaTextBlock` + + - `citations: array of BetaTextCitation` + + 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`. + + - `BetaCitationCharLocation = object { cited_text, document_index, document_title, 4 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_char_index: number` + + - `file_id: string` + + - `start_char_index: number` + + - `type: "char_location"` + + - `"char_location"` + + - `BetaCitationPageLocation = object { cited_text, document_index, document_title, 4 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_page_number: number` + + - `file_id: string` + + - `start_page_number: number` + + - `type: "page_location"` + + - `"page_location"` + + - `BetaCitationContentBlockLocation = object { cited_text, document_index, document_title, 4 more }` + + - `cited_text: string` + + - `document_index: number` + + - `document_title: string` + + - `end_block_index: number` + + - `file_id: string` + + - `start_block_index: number` + + - `type: "content_block_location"` + + - `"content_block_location"` + + - `BetaCitationsWebSearchResultLocation = object { cited_text, encrypted_index, title, 2 more }` + + - `cited_text: string` + + - `encrypted_index: string` + + - `title: string` + + - `type: "web_search_result_location"` + + - `"web_search_result_location"` + + - `url: string` + + - `BetaCitationSearchResultLocation = object { cited_text, end_block_index, search_result_index, 4 more }` + + - `cited_text: string` + + - `end_block_index: number` + + - `search_result_index: number` + + - `source: string` + + - `start_block_index: number` + + - `title: string` + + - `type: "search_result_location"` + + - `"search_result_location"` + + - `text: string` + + - `type: "text"` + + - `"text"` + + - `is_error: boolean` + + - `tool_use_id: string` + + - `type: "mcp_tool_result"` + + - `"mcp_tool_result"` + + - `BetaContainerUploadBlock = object { file_id, type }` + + Response model for a file uploaded to the container. + + - `file_id: string` + + - `type: "container_upload"` + + - `"container_upload"` + + - `BetaCompactionBlock = object { content, type }` + + A compaction block returned when autocompact is triggered. + + When content is None, it indicates the compaction failed to produce a valid + summary (e.g., malformed output from the model). Clients may round-trip + compaction blocks with null content; the server treats them as no-ops. + + - `content: string` + + Summary of compacted content, or null if compaction failed + + - `type: "compaction"` + + - `"compaction"` + + - `context_management: BetaContextManagementResponse` + + Context management response. + + Information about context management strategies applied during the request. + + - `applied_edits: array of BetaClearToolUses20250919EditResponse or BetaClearThinking20251015EditResponse` + + List of context management edits that were applied. + + - `BetaClearToolUses20250919EditResponse = object { cleared_input_tokens, cleared_tool_uses, type }` + + - `cleared_input_tokens: number` + + Number of input tokens cleared by this edit. + + - `cleared_tool_uses: number` + + Number of tool uses that were cleared. + + - `type: "clear_tool_uses_20250919"` + + The type of context management edit applied. + + - `"clear_tool_uses_20250919"` + + - `BetaClearThinking20251015EditResponse = object { cleared_input_tokens, cleared_thinking_turns, type }` + + - `cleared_input_tokens: number` + + Number of input tokens cleared by this edit. + + - `cleared_thinking_turns: number` + + Number of thinking turns that were cleared. + + - `type: "clear_thinking_20251015"` + + The type of context management edit applied. + + - `"clear_thinking_20251015"` + + - `model: Model` + + The model that will complete your prompt. + + See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. + + - `UnionMember0 = "claude-opus-4-6" or "claude-sonnet-4-6" or "claude-opus-4-5-20251101" or 19 more` + + The model that will complete your prompt. + + See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. + + - `"claude-opus-4-6"` + + Most intelligent model for building agents and coding + + - `"claude-sonnet-4-6"` + + Frontier intelligence at scale — built for coding, agents, and enterprise workflows + + - `"claude-opus-4-5-20251101"` + + Premium model combining maximum intelligence with practical performance + + - `"claude-opus-4-5"` + + Premium model combining maximum intelligence with practical performance + + - `"claude-3-7-sonnet-latest"` + + High-performance model with early extended thinking + + - `"claude-3-7-sonnet-20250219"` + + High-performance model with early extended thinking + + - `"claude-3-5-haiku-latest"` + + Fastest and most compact model for near-instant responsiveness + + - `"claude-3-5-haiku-20241022"` + + Our fastest model + + - `"claude-haiku-4-5"` + + Hybrid model, capable of near-instant responses and extended thinking + + - `"claude-haiku-4-5-20251001"` + + Hybrid model, capable of near-instant responses and extended thinking + + - `"claude-sonnet-4-20250514"` + + High-performance model with extended thinking + + - `"claude-sonnet-4-0"` + + High-performance model with extended thinking + + - `"claude-4-sonnet-20250514"` + + High-performance model with extended thinking + + - `"claude-sonnet-4-5"` + + Our best model for real-world agents and coding + + - `"claude-sonnet-4-5-20250929"` + + Our best model for real-world agents and coding + + - `"claude-opus-4-0"` + + Our most capable model + + - `"claude-opus-4-20250514"` + + Our most capable model + + - `"claude-4-opus-20250514"` + + Our most capable model + + - `"claude-opus-4-1-20250805"` + + Our most capable model + + - `"claude-3-opus-latest"` + + Excels at writing and complex tasks + + - `"claude-3-opus-20240229"` + + Excels at writing and complex tasks + + - `"claude-3-haiku-20240307"` + + Our previous most fast and cost-effective + + - `UnionMember1 = string` + + - `role: "assistant"` + + Conversational role of the generated message. + + This will always be `"assistant"`. + + - `"assistant"` + + - `stop_reason: BetaStopReason` + + The reason that we stopped. + + This may be one the following values: + + * `"end_turn"`: the model reached a natural stopping point + * `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum + * `"stop_sequence"`: one of your provided custom `stop_sequences` was generated + * `"tool_use"`: the model invoked one or more tools + * `"pause_turn"`: we paused a long-running turn. You may provide the response back as-is in a subsequent request to let the model continue. + * `"refusal"`: when streaming classifiers intervene to handle potential policy violations + + 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. + + - `"end_turn"` + + - `"max_tokens"` + + - `"stop_sequence"` + + - `"tool_use"` + + - `"pause_turn"` + + - `"compaction"` + + - `"refusal"` + + - `"model_context_window_exceeded"` + + - `stop_sequence: string` + + Which custom stop sequence was generated, if any. + + This value will be a non-null string if one of your custom stop sequences was generated. + + - `type: "message"` + + Object type. + + For Messages, this is always `"message"`. + + - `"message"` + + - `usage: BetaUsage` + + Billing and rate-limit usage. + + Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems. + + Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in `usage` will not match one-to-one with the exact visible content of an API request or response. + + For example, `output_tokens` will be non-zero, even for an empty string response from Claude. + + Total input tokens in a request is the summation of `input_tokens`, `cache_creation_input_tokens`, and `cache_read_input_tokens`. + + - `cache_creation: BetaCacheCreation` + + Breakdown of cached tokens by TTL + + - `ephemeral_1h_input_tokens: number` + + The number of input tokens used to create the 1 hour cache entry. + + - `ephemeral_5m_input_tokens: number` + + The number of input tokens used to create the 5 minute cache entry. + + - `cache_creation_input_tokens: number` + + The number of input tokens used to create the cache entry. + + - `cache_read_input_tokens: number` + + The number of input tokens read from the cache. + + - `inference_geo: string` + + The geographic region where inference was performed for this request. + + - `input_tokens: number` + + The number of input tokens which were used. + + - `iterations: BetaIterationsUsage` + + Per-iteration token usage breakdown. + + Each entry represents one sampling iteration, with its own input/output token counts and cache statistics. This allows you to: + + - Determine which iterations exceeded long context thresholds (>=200k tokens) + - Calculate the true context window size from the last iteration + - Understand token accumulation across server-side tool use loops + + - `BetaMessageIterationUsage = object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` + + Token usage for a sampling iteration. + + - `cache_creation: BetaCacheCreation` + + Breakdown of cached tokens by TTL + + - `ephemeral_1h_input_tokens: number` + + The number of input tokens used to create the 1 hour cache entry. + + - `ephemeral_5m_input_tokens: number` + + The number of input tokens used to create the 5 minute cache entry. + + - `cache_creation_input_tokens: number` + + The number of input tokens used to create the cache entry. + + - `cache_read_input_tokens: number` + + The number of input tokens read from the cache. + + - `input_tokens: number` + + The number of input tokens which were used. + + - `output_tokens: number` + + The number of output tokens which were used. + + - `type: "message"` + + Usage for a sampling iteration + + - `"message"` + + - `BetaCompactionIterationUsage = object { cache_creation, cache_creation_input_tokens, cache_read_input_tokens, 3 more }` + + Token usage for a compaction iteration. + + - `cache_creation: BetaCacheCreation` + + Breakdown of cached tokens by TTL + + - `ephemeral_1h_input_tokens: number` + + The number of input tokens used to create the 1 hour cache entry. + + - `ephemeral_5m_input_tokens: number` + + The number of input tokens used to create the 5 minute cache entry. + + - `cache_creation_input_tokens: number` + + The number of input tokens used to create the cache entry. + + - `cache_read_input_tokens: number` + + The number of input tokens read from the cache. + + - `input_tokens: number` + + The number of input tokens which were used. + + - `output_tokens: number` + + The number of output tokens which were used. + + - `type: "compaction"` + + Usage for a compaction iteration + + - `"compaction"` + + - `output_tokens: number` + + The number of output tokens which were used. + + - `server_tool_use: BetaServerToolUsage` + + The number of server tool requests. + + - `web_fetch_requests: number` + + The number of web fetch tool requests. + + - `web_search_requests: number` + + The number of web search tool requests. + + - `service_tier: "standard" or "priority" or "batch"` + + If the request used the priority, standard, or batch tier. + + - `"standard"` + + - `"priority"` + + - `"batch"` + + - `speed: "standard" or "fast"` + + The inference speed mode used for this request. + + - `"standard"` + + - `"fast"` + +### Example + +```http +curl https://api.anthropic.com/v1/messages?beta=true \ + -H 'Content-Type: application/json' \ + -H 'anthropic-version: 2023-06-01' \ + -H "X-Api-Key: $ANTHROPIC_API_KEY" \ + --max-time 600 \ + -d '{ + "max_tokens": 1024, + "messages": [ + { + "content": "Hello, world", + "role": "user" + } + ], + "model": "claude-opus-4-6" + }' +``` \ No newline at end of file diff --git a/docs/anthropic_prompt_caching.md b/docs/anthropic_prompt_caching.md new file mode 100644 index 0000000..e69de29 diff --git a/dpg_layout.ini b/dpg_layout.ini index e0b91b8..e5b4d92 100644 --- a/dpg_layout.ini +++ b/dpg_layout.ini @@ -10,19 +10,19 @@ Collapsed=0 [Window][###22] Pos=0,0 -Size=376,652 +Size=364,652 Collapsed=0 DockId=0x00000005,0 [Window][###30] Pos=0,654 -Size=376,835 +Size=364,835 Collapsed=0 DockId=0x00000009,0 [Window][###66] Pos=0,1491 -Size=376,646 +Size=364,646 Collapsed=0 DockId=0x0000000A,0 @@ -83,61 +83,84 @@ Collapsed=0 [Window][###76] Pos=1215,0 -Size=868,1749 +Size=1314,1690 Collapsed=0 DockId=0x00000017,0 [Window][###83] -Pos=378,0 -Size=835,266 +Pos=366,0 +Size=847,425 Collapsed=0 -DockId=0x00000015,0 +DockId=0x00000011,0 [Window][###91] -Pos=1215,1751 -Size=2625,386 +Pos=1215,1692 +Size=2625,445 Collapsed=0 DockId=0x00000014,0 [Window][###98] -Pos=2085,0 -Size=1755,1749 +Pos=2531,0 +Size=1309,1690 Collapsed=0 DockId=0x00000018,0 [Window][###106] -Pos=378,268 -Size=835,1068 -Collapsed=0 -DockId=0x00000016,0 - -[Window][###100] -Pos=378,1338 -Size=835,799 +Pos=366,427 +Size=847,1710 Collapsed=0 DockId=0x00000012,0 +[Window][###100] +Pos=366,427 +Size=847,1710 +Collapsed=0 +DockId=0x00000012,1 + +[Window][###133] +Pos=1306,785 +Size=700,440 +Collapsed=0 + +[Window][###216] +Pos=1578,868 +Size=700,440 +Collapsed=0 + +[Window][###305] +Pos=1578,868 +Size=700,440 +Collapsed=0 + +[Window][###400] +Pos=1578,868 +Size=700,440 +Collapsed=0 + +[Window][###501] +Pos=1578,868 +Size=700,440 +Collapsed=0 + [Docking][Data] DockSpace ID=0x7C6B3D9B Window=0xA87D555D Pos=0,0 Size=3840,2137 Split=X Selected=0x40484D8F - DockNode ID=0x00000003 Parent=0x7C6B3D9B SizeRef=376,1161 Split=Y Selected=0xEE087978 + DockNode ID=0x00000003 Parent=0x7C6B3D9B SizeRef=364,1161 Split=Y Selected=0xEE087978 DockNode ID=0x00000005 Parent=0x00000003 SizeRef=235,354 Selected=0xEE087978 DockNode ID=0x00000006 Parent=0x00000003 SizeRef=235,805 Split=Y Selected=0x5F94F9BD DockNode ID=0x00000009 Parent=0x00000006 SizeRef=235,453 Selected=0x5F94F9BD DockNode ID=0x0000000A Parent=0x00000006 SizeRef=235,350 Selected=0x80199DAE - DockNode ID=0x00000004 Parent=0x7C6B3D9B SizeRef=1286,1161 Split=X + DockNode ID=0x00000004 Parent=0x7C6B3D9B SizeRef=3474,1161 Split=X DockNode ID=0x00000001 Parent=0x00000004 SizeRef=829,1161 Split=Y Selected=0x40484D8F DockNode ID=0x00000007 Parent=0x00000001 SizeRef=595,492 Selected=0xBA13FCDE DockNode ID=0x00000008 Parent=0x00000001 SizeRef=595,1643 Split=X Selected=0x40484D8F - DockNode ID=0x0000000F Parent=0x00000008 SizeRef=835,2137 Split=Y Selected=0x07E8375F - DockNode ID=0x00000011 Parent=0x0000000F SizeRef=600,1336 Split=Y Selected=0x07E8375F - DockNode ID=0x00000015 Parent=0x00000011 SizeRef=995,266 Selected=0x72F373AE - DockNode ID=0x00000016 Parent=0x00000011 SizeRef=995,1068 Selected=0x07E8375F - DockNode ID=0x00000012 Parent=0x0000000F SizeRef=600,799 Selected=0x88A8C2FF + DockNode ID=0x0000000F Parent=0x00000008 SizeRef=847,2137 Split=Y Selected=0x07E8375F + DockNode ID=0x00000011 Parent=0x0000000F SizeRef=835,425 Selected=0x72F373AE + DockNode ID=0x00000012 Parent=0x0000000F SizeRef=835,1710 Selected=0x07E8375F DockNode ID=0x00000010 Parent=0x00000008 SizeRef=2625,2137 Split=Y Selected=0xCE7F911A - DockNode ID=0x00000013 Parent=0x00000010 SizeRef=1967,1749 Split=X Selected=0xCE7F911A - DockNode ID=0x00000017 Parent=0x00000013 SizeRef=868,1749 Selected=0x4B454E0B - DockNode ID=0x00000018 Parent=0x00000013 SizeRef=1755,1749 CentralNode=1 Selected=0xCE7F911A - DockNode ID=0x00000014 Parent=0x00000010 SizeRef=1967,386 Selected=0xC36FF36B + DockNode ID=0x00000013 Parent=0x00000010 SizeRef=1967,1690 Split=X Selected=0xCE7F911A + DockNode ID=0x00000017 Parent=0x00000013 SizeRef=1314,1749 Selected=0x4B454E0B + DockNode ID=0x00000018 Parent=0x00000013 SizeRef=1309,1749 CentralNode=1 Selected=0xCE7F911A + DockNode ID=0x00000014 Parent=0x00000010 SizeRef=1967,445 Selected=0xC36FF36B DockNode ID=0x00000002 Parent=0x00000004 SizeRef=2631,1161 Split=X Selected=0x714F2F7B DockNode ID=0x0000000B Parent=0x00000002 SizeRef=968,1161 Selected=0xC915D9DA DockNode ID=0x0000000C Parent=0x00000002 SizeRef=1661,1161 Split=Y Selected=0x714F2F7B diff --git a/session_logger.py b/session_logger.py new file mode 100644 index 0000000..246b41f --- /dev/null +++ b/session_logger.py @@ -0,0 +1,125 @@ +# session_logger.py +""" +Opens timestamped log/script files at startup and keeps them open for the +lifetime of the process. The next run of the GUI creates new files; the +previous run's files are simply closed when the process exits. + +File layout +----------- +logs/ + comms_.log - every comms entry (direction/kind/payload) as JSON-L + toolcalls_.log - sequential record of every tool invocation +scripts/generated/ + _.ps1 - each PowerShell script the AI generated, in order + +Where = YYYYMMDD_HHMMSS of when this session was started. +""" + +import datetime +import json +import threading +from pathlib import Path + +_LOG_DIR = Path("./logs") +_SCRIPTS_DIR = Path("./scripts/generated") + +_ts: str = "" # session timestamp string e.g. "20260301_142233" +_seq: int = 0 # monotonic counter for script files this session +_seq_lock = threading.Lock() + +_comms_fh = None # file handle: logs/comms_.log +_tool_fh = None # file handle: logs/toolcalls_.log + + +def _now_ts() -> str: + return datetime.datetime.now().strftime("%Y%m%d_%H%M%S") + + +def open_session(): + """ + Called once at GUI startup. Creates the log directories if needed and + opens the two log files for this session. Idempotent - a second call is + ignored. + """ + global _ts, _comms_fh, _tool_fh, _seq + + if _comms_fh is not None: + return # already open + + _LOG_DIR.mkdir(parents=True, exist_ok=True) + _SCRIPTS_DIR.mkdir(parents=True, exist_ok=True) + + _ts = _now_ts() + _seq = 0 + + _comms_fh = open(_LOG_DIR / f"comms_{_ts}.log", "w", encoding="utf-8", buffering=1) + _tool_fh = open(_LOG_DIR / f"toolcalls_{_ts}.log", "w", encoding="utf-8", buffering=1) + + _tool_fh.write(f"# Tool-call log — session {_ts}\n\n") + _tool_fh.flush() + + +def close_session(): + """Flush and close both log files. Called on clean exit (optional).""" + global _comms_fh, _tool_fh + if _comms_fh: + _comms_fh.close() + _comms_fh = None + if _tool_fh: + _tool_fh.close() + _tool_fh = None + + +def log_comms(entry: dict): + """ + Append one comms entry to the comms log file as a JSON-L line. + Thread-safe (GIL + line-buffered file). + """ + if _comms_fh is None: + return + try: + _comms_fh.write(json.dumps(entry, ensure_ascii=False, default=str) + "\n") + except Exception: + pass + + +def log_tool_call(script: str, result: str, script_path: str | None): + """ + Append a tool-call record to the toolcalls log and write the PS1 script to + scripts/generated/. Returns the path of the written script file. + """ + global _seq + + if _tool_fh is None: + return script_path # logger not open yet + + with _seq_lock: + _seq += 1 + seq = _seq + + ts_entry = datetime.datetime.now().strftime("%H:%M:%S") + + # Write the .ps1 file + ps1_name = f"{_ts}_{seq:04d}.ps1" + ps1_path = _SCRIPTS_DIR / ps1_name + try: + ps1_path.write_text(script, encoding="utf-8") + except Exception as exc: + ps1_path = None + ps1_name = f"(write error: {exc})" + + # Append to the tool-call sequence log + try: + _tool_fh.write( + f"## Call #{seq} [{ts_entry}]\n" + f"Script file: {ps1_path}\n\n" + f"```powershell\n{script}\n```\n\n" + f"### Result\n\n" + f"```\n{result}\n```\n\n" + f"---\n\n" + ) + _tool_fh.flush() + except Exception: + pass + + return str(ps1_path) if ps1_path else None