Messages

Create a Message

client.messages.create(, ?): Message { id, container, content, 6 more } | Stream<RawMessageStreamEvent>

POST/v1/messages

Count tokens in a Message

client.messages.countTokens(, ?): MessageTokensCount { input_tokens }

POST/v1/messages/count_tokens

ModelsExpand Collapse

Base64ImageSource { data, media_type, type }

data: string

media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"

Accepts one of the following:

"image/jpeg"

"image/png"

"image/gif"

"image/webp"

type: "base64"

Base64PDFSource { data, media_type, type }

data: string

media_type: "application/pdf"

type: "base64"

BashCodeExecutionOutputBlock { file_id, type }

file_id: string

type: "bash_code_execution_output"

BashCodeExecutionOutputBlockParam { file_id, type }

file_id: string

type: "bash_code_execution_output"

BashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array<BashCodeExecutionOutputBlock { file_id, type } >

file_id: string

type: "bash_code_execution_output"

return_code: number

stderr: string

stdout: string

type: "bash_code_execution_result"

BashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array<BashCodeExecutionOutputBlockParam { file_id, type } >

file_id: string

type: "bash_code_execution_output"

return_code: number

stderr: string

stdout: string

type: "bash_code_execution_result"

BashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BashCodeExecutionToolResultError { error_code, type } | BashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

BashCodeExecutionToolResultError { error_code, type }

error_code: BashCodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"output_file_too_large"

type: "bash_code_execution_tool_result_error"

BashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array<BashCodeExecutionOutputBlock { file_id, type } >

file_id: string

type: "bash_code_execution_output"

return_code: number

stderr: string

stdout: string

type: "bash_code_execution_result"

tool_use_id: string

type: "bash_code_execution_tool_result"

BashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BashCodeExecutionToolResultErrorParam { error_code, type } | BashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

Accepts one of the following:

BashCodeExecutionToolResultErrorParam { error_code, type }

error_code: BashCodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"output_file_too_large"

type: "bash_code_execution_tool_result_error"

BashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array<BashCodeExecutionOutputBlockParam { file_id, type } >

file_id: string

type: "bash_code_execution_output"

return_code: number

stderr: string

stdout: string

type: "bash_code_execution_result"

tool_use_id: string

type: "bash_code_execution_tool_result"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

BashCodeExecutionToolResultError { error_code, type }

error_code: BashCodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"output_file_too_large"

type: "bash_code_execution_tool_result_error"

BashCodeExecutionToolResultErrorCode = "invalid_tool_input" | "unavailable" | "too_many_requests" | 2 more

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"output_file_too_large"

BashCodeExecutionToolResultErrorParam { error_code, type }

error_code: BashCodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"output_file_too_large"

type: "bash_code_execution_tool_result_error"

CacheControlEphemeral { type, ttl }

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

CacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

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.

CitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

file_id: string | null

start_char_index: number

type: "char_location"

CitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

start_char_index: number

type: "char_location"

CitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

file_id: string | null

start_block_index: number

type: "content_block_location"

CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

start_block_index: number

type: "content_block_location"

CitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

file_id: string | null

start_page_number: number

type: "page_location"

CitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

start_page_number: number

type: "page_location"

CitationSearchResultLocationParam { 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 | null

type: "search_result_location"

CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationsConfig { enabled }

enabled: boolean

CitationsConfigParam { enabled }

enabled?: boolean

CitationsDelta { citation, type }

citation: CitationCharLocation { cited_text, document_index, document_title, 4 more } | CitationPageLocation { cited_text, document_index, document_title, 4 more } | CitationContentBlockLocation { cited_text, document_index, document_title, 4 more } | 2 more

Accepts one of the following:

CitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

file_id: string | null

start_char_index: number

type: "char_location"

CitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

file_id: string | null

start_page_number: number

type: "page_location"

CitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

file_id: string | null

start_block_index: number

type: "content_block_location"

CitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationsSearchResultLocation { 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 | null

type: "search_result_location"

type: "citations_delta"

CitationsSearchResultLocation { 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 | null

type: "search_result_location"

CitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CodeExecutionOutputBlock { file_id, type }

file_id: string

type: "code_execution_output"

CodeExecutionOutputBlockParam { file_id, type }

file_id: string

type: "code_execution_output"

CodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array<CodeExecutionOutputBlock { file_id, type } >

file_id: string

type: "code_execution_output"

return_code: number

stderr: string

stdout: string

type: "code_execution_result"

CodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array<CodeExecutionOutputBlockParam { file_id, type } >

file_id: string

type: "code_execution_output"

return_code: number

stderr: string

stdout: string

type: "code_execution_result"

CodeExecutionTool20250522 { name, type, allowed_callers, 3 more }

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

type: "code_execution_20250522"

allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">

Accepts one of the following:

"direct"

"code_execution_20250825"

"code_execution_20260120"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

defer_loading?: boolean

If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

strict?: boolean

When true, guarantees schema validation on tool names and inputs

CodeExecutionTool20250825 { name, type, allowed_callers, 3 more }

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

type: "code_execution_20250825"

allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">

Accepts one of the following:

"direct"

"code_execution_20250825"

"code_execution_20260120"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

defer_loading?: boolean

If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

strict?: boolean

When true, guarantees schema validation on tool names and inputs

CodeExecutionTool20260120 { name, type, allowed_callers, 3 more }

Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint).

Name of the tool.

This is how the tool will be called by the model and in tool_use blocks.

type: "code_execution_20260120"

allowed_callers?: Array<"direct" | "code_execution_20250825" | "code_execution_20260120">

Accepts one of the following:

"direct"

"code_execution_20250825"

"code_execution_20260120"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

defer_loading?: boolean

If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search.

strict?: boolean

When true, guarantees schema validation on tool names and inputs

CodeExecutionToolResultBlock { content, tool_use_id, type }

content: CodeExecutionToolResultBlockContent

Code execution result with encrypted stdout for PFC + web_search results.

Accepts one of the following:

CodeExecutionToolResultError { error_code, type }

error_code: CodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

type: "code_execution_tool_result_error"

CodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array<CodeExecutionOutputBlock { file_id, type } >

file_id: string

type: "code_execution_output"

return_code: number

stderr: string

stdout: string

type: "code_execution_result"

EncryptedCodeExecutionResultBlock { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

content: Array<CodeExecutionOutputBlock { file_id, type } >

file_id: string

type: "code_execution_output"

encrypted_stdout: string

return_code: number

stderr: string

type: "encrypted_code_execution_result"

tool_use_id: string

type: "code_execution_tool_result"

CodeExecutionToolResultBlockContent = CodeExecutionToolResultError { error_code, type } | CodeExecutionResultBlock { content, return_code, stderr, 2 more } | EncryptedCodeExecutionResultBlock { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

Accepts one of the following:

CodeExecutionToolResultError { error_code, type }

error_code: CodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

type: "code_execution_tool_result_error"

CodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array<CodeExecutionOutputBlock { file_id, type } >

file_id: string

type: "code_execution_output"

return_code: number

stderr: string

stdout: string

type: "code_execution_result"

EncryptedCodeExecutionResultBlock { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

content: Array<CodeExecutionOutputBlock { file_id, type } >

file_id: string

type: "code_execution_output"

encrypted_stdout: string

return_code: number

stderr: string

type: "encrypted_code_execution_result"

CodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: CodeExecutionToolResultBlockParamContent

Code execution result with encrypted stdout for PFC + web_search results.

Accepts one of the following:

CodeExecutionToolResultErrorParam { error_code, type }

error_code: CodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

type: "code_execution_tool_result_error"

CodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array<CodeExecutionOutputBlockParam { file_id, type } >

file_id: string

type: "code_execution_output"

return_code: number

stderr: string

stdout: string

type: "code_execution_result"

EncryptedCodeExecutionResultBlockParam { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

content: Array<CodeExecutionOutputBlockParam { file_id, type } >

file_id: string

type: "code_execution_output"

encrypted_stdout: string

return_code: number

stderr: string

type: "encrypted_code_execution_result"

tool_use_id: string

type: "code_execution_tool_result"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

CodeExecutionToolResultBlockParamContent = CodeExecutionToolResultErrorParam { error_code, type } | CodeExecutionResultBlockParam { content, return_code, stderr, 2 more } | EncryptedCodeExecutionResultBlockParam { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

Accepts one of the following:

CodeExecutionToolResultErrorParam { error_code, type }

error_code: CodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

type: "code_execution_tool_result_error"

CodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array<CodeExecutionOutputBlockParam { file_id, type } >

file_id: string

type: "code_execution_output"

return_code: number

stderr: string

stdout: string

type: "code_execution_result"

EncryptedCodeExecutionResultBlockParam { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

content: Array<CodeExecutionOutputBlockParam { file_id, type } >

file_id: string

type: "code_execution_output"

encrypted_stdout: string

return_code: number

stderr: string

type: "encrypted_code_execution_result"

CodeExecutionToolResultError { error_code, type }

error_code: CodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

type: "code_execution_tool_result_error"

CodeExecutionToolResultErrorCode = "invalid_tool_input" | "unavailable" | "too_many_requests" | "execution_time_exceeded"

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

CodeExecutionToolResultErrorParam { error_code, type }

error_code: CodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

type: "code_execution_tool_result_error"

Container { id, expires_at }

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.

ContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: string

type: "container_upload"

ContainerUploadBlockParam { 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"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

ContentBlock = TextBlock { citations, text, type } | ThinkingBlock { signature, thinking, type } | RedactedThinkingBlock { data, type } | 9 more

Response model for a file uploaded to the container.

Accepts one of the following:

TextBlock { citations, text, type }

citations: Array<TextCitation> | null

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.

Accepts one of the following:

CitationCharLocation { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

file_id: string | null

start_char_index: number

type: "char_location"

CitationPageLocation { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

file_id: string | null

start_page_number: number

type: "page_location"

CitationContentBlockLocation { cited_text, document_index, document_title, 4 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

file_id: string | null

start_block_index: number

type: "content_block_location"

CitationsWebSearchResultLocation { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationsSearchResultLocation { 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 | null

type: "search_result_location"

text: string

type: "text"

ThinkingBlock { signature, thinking, type }

signature: string

thinking: string

type: "thinking"

RedactedThinkingBlock { data, type }

data: string

type: "redacted_thinking"

ToolUseBlock { id, caller, input, 2 more }

id: string

caller: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

DirectCaller { type }

Tool invocation directly from the model.

type: "direct"

ServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: string

type: "code_execution_20250825"

ServerToolCaller20260120 { tool_id, type }

tool_id: string

type: "code_execution_20260120"

input: Record<string, unknown>

type: "tool_use"

ServerToolUseBlock { id, caller, input, 2 more }

id: string

caller: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

DirectCaller { type }

Tool invocation directly from the model.

type: "direct"

ServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: string

type: "code_execution_20250825"

ServerToolCaller20260120 { tool_id, type }

tool_id: string

type: "code_execution_20260120"

input: Record<string, unknown>

Accepts one of the following:

"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"

WebSearchToolResultBlock { caller, content, tool_use_id, type }

caller: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

DirectCaller { type }

Tool invocation directly from the model.

type: "direct"

ServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: string

type: "code_execution_20250825"

ServerToolCaller20260120 { tool_id, type }

tool_id: string

type: "code_execution_20260120"

content: WebSearchToolResultBlockContent

Accepts one of the following:

WebSearchToolResultError { error_code, type }

error_code: WebSearchToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"max_uses_exceeded"

"too_many_requests"

"query_too_long"

"request_too_large"

type: "web_search_tool_result_error"

Array<WebSearchResultBlock { encrypted_content, page_age, title, 2 more } >

encrypted_content: string

page_age: string | null

title: string

type: "web_search_result"

url: string

tool_use_id: string

type: "web_search_tool_result"

WebFetchToolResultBlock { caller, content, tool_use_id, type }

caller: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

DirectCaller { type }

Tool invocation directly from the model.

type: "direct"

ServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: string

type: "code_execution_20250825"

ServerToolCaller20260120 { tool_id, type }

tool_id: string

type: "code_execution_20260120"

content: WebFetchToolResultErrorBlock { error_code, type } | WebFetchBlock { content, retrieved_at, type, url }

Accepts one of the following:

WebFetchToolResultErrorBlock { error_code, type }

error_code: WebFetchToolResultErrorCode

Accepts one of the following:

"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"

WebFetchBlock { content, retrieved_at, type, url }

content: DocumentBlock { citations, source, title, type }

citations: CitationsConfig { enabled } | null

Citation configuration for the document

enabled: boolean

source: Base64PDFSource { data, media_type, type } | PlainTextSource { data, media_type, type }

Accepts one of the following:

Base64PDFSource { data, media_type, type }

data: string

media_type: "application/pdf"

type: "base64"

PlainTextSource { data, media_type, type }

data: string

media_type: "text/plain"

type: "text"

title: string | null

The title of the document

type: "document"

retrieved_at: string | null

ISO 8601 timestamp when the content was retrieved

type: "web_fetch_result"

url: string

Fetched content URL

tool_use_id: string

type: "web_fetch_tool_result"

CodeExecutionToolResultBlock { content, tool_use_id, type }

content: CodeExecutionToolResultBlockContent

Code execution result with encrypted stdout for PFC + web_search results.

Accepts one of the following:

CodeExecutionToolResultError { error_code, type }

error_code: CodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

type: "code_execution_tool_result_error"

CodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array<CodeExecutionOutputBlock { file_id, type } >

file_id: string

type: "code_execution_output"

return_code: number

stderr: string

stdout: string

type: "code_execution_result"

EncryptedCodeExecutionResultBlock { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

content: Array<CodeExecutionOutputBlock { file_id, type } >

file_id: string

type: "code_execution_output"

encrypted_stdout: string

return_code: number

stderr: string

type: "encrypted_code_execution_result"

tool_use_id: string

type: "code_execution_tool_result"

BashCodeExecutionToolResultBlock { content, tool_use_id, type }

content: BashCodeExecutionToolResultError { error_code, type } | BashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

Accepts one of the following:

BashCodeExecutionToolResultError { error_code, type }

error_code: BashCodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"output_file_too_large"

type: "bash_code_execution_tool_result_error"

BashCodeExecutionResultBlock { content, return_code, stderr, 2 more }

content: Array<BashCodeExecutionOutputBlock { file_id, type } >

file_id: string

type: "bash_code_execution_output"

return_code: number

stderr: string

stdout: string

type: "bash_code_execution_result"

tool_use_id: string

type: "bash_code_execution_tool_result"

TextEditorCodeExecutionToolResultBlock { content, tool_use_id, type }

content: TextEditorCodeExecutionToolResultError { error_code, error_message, type } | TextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more } | TextEditorCodeExecutionCreateResultBlock { is_file_update, type } | TextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

Accepts one of the following:

TextEditorCodeExecutionToolResultError { error_code, error_message, type }

error_code: TextEditorCodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"file_not_found"

error_message: string | null

type: "text_editor_code_execution_tool_result_error"

TextEditorCodeExecutionViewResultBlock { content, file_type, num_lines, 3 more }

content: string

file_type: "text" | "image" | "pdf"

Accepts one of the following:

"text"

"image"

"pdf"

num_lines: number | null

start_line: number | null

total_lines: number | null

type: "text_editor_code_execution_view_result"

TextEditorCodeExecutionCreateResultBlock { is_file_update, type }

is_file_update: boolean

type: "text_editor_code_execution_create_result"

TextEditorCodeExecutionStrReplaceResultBlock { lines, new_lines, new_start, 3 more }

lines: Array<string> | null

new_lines: number | null

new_start: number | null

old_lines: number | null

old_start: number | null

type: "text_editor_code_execution_str_replace_result"

tool_use_id: string

type: "text_editor_code_execution_tool_result"

ToolSearchToolResultBlock { content, tool_use_id, type }

content: ToolSearchToolResultError { error_code, error_message, type } | ToolSearchToolSearchResultBlock { tool_references, type }

Accepts one of the following:

ToolSearchToolResultError { error_code, error_message, type }

error_code: ToolSearchToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

error_message: string | null

type: "tool_search_tool_result_error"

ToolSearchToolSearchResultBlock { tool_references, type }

tool_references: Array<ToolReferenceBlock { tool_name, type } >

tool_name: string

type: "tool_reference"

type: "tool_search_tool_search_result"

tool_use_id: string

type: "tool_search_tool_result"

ContainerUploadBlock { file_id, type }

Response model for a file uploaded to the container.

file_id: string

type: "container_upload"

ContentBlockParam = TextBlockParam { text, type, cache_control, citations } | ImageBlockParam { source, type, cache_control } | DocumentBlockParam { source, type, cache_control, 3 more } | 13 more

Regular text content.

Accepts one of the following:

TextBlockParam { text, type, cache_control, citations }

text: string

type: "text"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: Array<TextCitationParam> | null

Accepts one of the following:

CitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

start_char_index: number

type: "char_location"

CitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

start_page_number: number

type: "page_location"

CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

start_block_index: number

type: "content_block_location"

CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationSearchResultLocationParam { 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 | null

type: "search_result_location"

ImageBlockParam { source, type, cache_control }

source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }

Accepts one of the following:

Base64ImageSource { data, media_type, type }

data: string

media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"

Accepts one of the following:

"image/jpeg"

"image/png"

"image/gif"

"image/webp"

type: "base64"

URLImageSource { type, url }

type: "url"

url: string

type: "image"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

DocumentBlockParam { source, type, cache_control, 3 more }

source: Base64PDFSource { data, media_type, type } | PlainTextSource { data, media_type, type } | ContentBlockSource { content, type } | URLPDFSource { type, url }

Accepts one of the following:

Base64PDFSource { data, media_type, type }

data: string

media_type: "application/pdf"

type: "base64"

PlainTextSource { data, media_type, type }

data: string

media_type: "text/plain"

type: "text"

ContentBlockSource { content, type }

content: string | Array<ContentBlockSourceContent>

Accepts one of the following:

string

Array<ContentBlockSourceContent>

TextBlockParam { text, type, cache_control, citations }

text: string

type: "text"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: Array<TextCitationParam> | null

Accepts one of the following:

CitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

start_char_index: number

type: "char_location"

CitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

start_page_number: number

type: "page_location"

CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

start_block_index: number

type: "content_block_location"

CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationSearchResultLocationParam { 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 | null

type: "search_result_location"

ImageBlockParam { source, type, cache_control }

source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }

Accepts one of the following:

Base64ImageSource { data, media_type, type }

data: string

media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"

Accepts one of the following:

"image/jpeg"

"image/png"

"image/gif"

"image/webp"

type: "base64"

URLImageSource { type, url }

type: "url"

url: string

type: "image"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

type: "content"

URLPDFSource { type, url }

type: "url"

url: string

type: "document"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: CitationsConfigParam { enabled } | null

enabled?: boolean

context?: string | null

title?: string | null

SearchResultBlockParam { content, source, title, 3 more }

content: Array<TextBlockParam { text, type, cache_control, citations } >

text: string

type: "text"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: Array<TextCitationParam> | null

Accepts one of the following:

CitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

start_char_index: number

type: "char_location"

CitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

start_page_number: number

type: "page_location"

CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

start_block_index: number

type: "content_block_location"

CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationSearchResultLocationParam { 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 | null

type: "search_result_location"

source: string

title: string

type: "search_result"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: CitationsConfigParam { enabled }

enabled?: boolean

ThinkingBlockParam { signature, thinking, type }

signature: string

thinking: string

type: "thinking"

RedactedThinkingBlockParam { data, type }

data: string

type: "redacted_thinking"

ToolUseBlockParam { id, input, name, 3 more }

id: string

input: Record<string, unknown>

type: "tool_use"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

caller?: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

DirectCaller { type }

Tool invocation directly from the model.

type: "direct"

ServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: string

type: "code_execution_20250825"

ServerToolCaller20260120 { tool_id, type }

tool_id: string

type: "code_execution_20260120"

ToolResultBlockParam { tool_use_id, type, cache_control, 2 more }

tool_use_id: string

type: "tool_result"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

content?: string | Array<TextBlockParam { text, type, cache_control, citations } | ImageBlockParam { source, type, cache_control } | SearchResultBlockParam { content, source, title, 3 more } | 2 more>

Accepts one of the following:

string

Array<TextBlockParam { text, type, cache_control, citations } | ImageBlockParam { source, type, cache_control } | SearchResultBlockParam { content, source, title, 3 more } | 2 more>

TextBlockParam { text, type, cache_control, citations }

text: string

type: "text"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: Array<TextCitationParam> | null

Accepts one of the following:

CitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

start_char_index: number

type: "char_location"

CitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

start_page_number: number

type: "page_location"

CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

start_block_index: number

type: "content_block_location"

CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationSearchResultLocationParam { 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 | null

type: "search_result_location"

ImageBlockParam { source, type, cache_control }

source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }

Accepts one of the following:

Base64ImageSource { data, media_type, type }

data: string

media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"

Accepts one of the following:

"image/jpeg"

"image/png"

"image/gif"

"image/webp"

type: "base64"

URLImageSource { type, url }

type: "url"

url: string

type: "image"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

SearchResultBlockParam { content, source, title, 3 more }

content: Array<TextBlockParam { text, type, cache_control, citations } >

text: string

type: "text"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: Array<TextCitationParam> | null

Accepts one of the following:

CitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

start_char_index: number

type: "char_location"

CitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

start_page_number: number

type: "page_location"

CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

start_block_index: number

type: "content_block_location"

CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationSearchResultLocationParam { 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 | null

type: "search_result_location"

source: string

title: string

type: "search_result"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: CitationsConfigParam { enabled }

enabled?: boolean

DocumentBlockParam { source, type, cache_control, 3 more }

source: Base64PDFSource { data, media_type, type } | PlainTextSource { data, media_type, type } | ContentBlockSource { content, type } | URLPDFSource { type, url }

Accepts one of the following:

Base64PDFSource { data, media_type, type }

data: string

media_type: "application/pdf"

type: "base64"

PlainTextSource { data, media_type, type }

data: string

media_type: "text/plain"

type: "text"

ContentBlockSource { content, type }

content: string | Array<ContentBlockSourceContent>

Accepts one of the following:

string

Array<ContentBlockSourceContent>

TextBlockParam { text, type, cache_control, citations }

text: string

type: "text"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: Array<TextCitationParam> | null

Accepts one of the following:

CitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

start_char_index: number

type: "char_location"

CitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

start_page_number: number

type: "page_location"

CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

start_block_index: number

type: "content_block_location"

CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationSearchResultLocationParam { 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 | null

type: "search_result_location"

ImageBlockParam { source, type, cache_control }

source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }

Accepts one of the following:

Base64ImageSource { data, media_type, type }

data: string

media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"

Accepts one of the following:

"image/jpeg"

"image/png"

"image/gif"

"image/webp"

type: "base64"

URLImageSource { type, url }

type: "url"

url: string

type: "image"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

type: "content"

URLPDFSource { type, url }

type: "url"

url: string

type: "document"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: CitationsConfigParam { enabled } | null

enabled?: boolean

context?: string | null

title?: string | null

ToolReferenceBlockParam { tool_name, type, cache_control }

Tool reference block that can be included in tool_result content.

tool_name: string

type: "tool_reference"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

is_error?: boolean

ServerToolUseBlockParam { id, input, name, 3 more }

id: string

input: Record<string, unknown>

Accepts one of the following:

"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"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

caller?: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

DirectCaller { type }

Tool invocation directly from the model.

type: "direct"

ServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: string

type: "code_execution_20250825"

ServerToolCaller20260120 { tool_id, type }

tool_id: string

type: "code_execution_20260120"

WebSearchToolResultBlockParam { content, tool_use_id, type, 2 more }

content: WebSearchToolResultBlockParamContent

Accepts one of the following:

Array<WebSearchResultBlockParam { encrypted_content, title, type, 2 more } >

encrypted_content: string

title: string

type: "web_search_result"

url: string

page_age?: string | null

WebSearchToolRequestError { error_code, type }

error_code: WebSearchToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"max_uses_exceeded"

"too_many_requests"

"query_too_long"

"request_too_large"

type: "web_search_tool_result_error"

tool_use_id: string

type: "web_search_tool_result"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

caller?: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

DirectCaller { type }

Tool invocation directly from the model.

type: "direct"

ServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: string

type: "code_execution_20250825"

ServerToolCaller20260120 { tool_id, type }

tool_id: string

type: "code_execution_20260120"

WebFetchToolResultBlockParam { content, tool_use_id, type, 2 more }

content: WebFetchToolResultErrorBlockParam { error_code, type } | WebFetchBlockParam { content, type, url, retrieved_at }

Accepts one of the following:

WebFetchToolResultErrorBlockParam { error_code, type }

error_code: WebFetchToolResultErrorCode

Accepts one of the following:

"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"

WebFetchBlockParam { content, type, url, retrieved_at }

content: DocumentBlockParam { source, type, cache_control, 3 more }

source: Base64PDFSource { data, media_type, type } | PlainTextSource { data, media_type, type } | ContentBlockSource { content, type } | URLPDFSource { type, url }

Accepts one of the following:

Base64PDFSource { data, media_type, type }

data: string

media_type: "application/pdf"

type: "base64"

PlainTextSource { data, media_type, type }

data: string

media_type: "text/plain"

type: "text"

ContentBlockSource { content, type }

content: string | Array<ContentBlockSourceContent>

Accepts one of the following:

string

Array<ContentBlockSourceContent>

TextBlockParam { text, type, cache_control, citations }

text: string

type: "text"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: Array<TextCitationParam> | null

Accepts one of the following:

CitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

start_char_index: number

type: "char_location"

CitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

start_page_number: number

type: "page_location"

CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

start_block_index: number

type: "content_block_location"

CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationSearchResultLocationParam { 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 | null

type: "search_result_location"

ImageBlockParam { source, type, cache_control }

source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }

Accepts one of the following:

Base64ImageSource { data, media_type, type }

data: string

media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"

Accepts one of the following:

"image/jpeg"

"image/png"

"image/gif"

"image/webp"

type: "base64"

URLImageSource { type, url }

type: "url"

url: string

type: "image"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

type: "content"

URLPDFSource { type, url }

type: "url"

url: string

type: "document"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: CitationsConfigParam { enabled } | null

enabled?: boolean

context?: string | null

title?: string | null

type: "web_fetch_result"

url: string

Fetched content URL

retrieved_at?: string | null

ISO 8601 timestamp when the content was retrieved

tool_use_id: string

type: "web_fetch_tool_result"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

caller?: DirectCaller { type } | ServerToolCaller { tool_id, type } | ServerToolCaller20260120 { tool_id, type }

Tool invocation directly from the model.

Accepts one of the following:

DirectCaller { type }

Tool invocation directly from the model.

type: "direct"

ServerToolCaller { tool_id, type }

Tool invocation generated by a server-side tool.

tool_id: string

type: "code_execution_20250825"

ServerToolCaller20260120 { tool_id, type }

tool_id: string

type: "code_execution_20260120"

CodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: CodeExecutionToolResultBlockParamContent

Code execution result with encrypted stdout for PFC + web_search results.

Accepts one of the following:

CodeExecutionToolResultErrorParam { error_code, type }

error_code: CodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

type: "code_execution_tool_result_error"

CodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array<CodeExecutionOutputBlockParam { file_id, type } >

file_id: string

type: "code_execution_output"

return_code: number

stderr: string

stdout: string

type: "code_execution_result"

EncryptedCodeExecutionResultBlockParam { content, encrypted_stdout, return_code, 2 more }

Code execution result with encrypted stdout for PFC + web_search results.

content: Array<CodeExecutionOutputBlockParam { file_id, type } >

file_id: string

type: "code_execution_output"

encrypted_stdout: string

return_code: number

stderr: string

type: "encrypted_code_execution_result"

tool_use_id: string

type: "code_execution_tool_result"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

BashCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: BashCodeExecutionToolResultErrorParam { error_code, type } | BashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

Accepts one of the following:

BashCodeExecutionToolResultErrorParam { error_code, type }

error_code: BashCodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"output_file_too_large"

type: "bash_code_execution_tool_result_error"

BashCodeExecutionResultBlockParam { content, return_code, stderr, 2 more }

content: Array<BashCodeExecutionOutputBlockParam { file_id, type } >

file_id: string

type: "bash_code_execution_output"

return_code: number

stderr: string

stdout: string

type: "bash_code_execution_result"

tool_use_id: string

type: "bash_code_execution_tool_result"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

TextEditorCodeExecutionToolResultBlockParam { content, tool_use_id, type, cache_control }

content: TextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message } | TextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more } | TextEditorCodeExecutionCreateResultBlockParam { is_file_update, type } | TextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }

Accepts one of the following:

TextEditorCodeExecutionToolResultErrorParam { error_code, type, error_message }

error_code: TextEditorCodeExecutionToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

"file_not_found"

type: "text_editor_code_execution_tool_result_error"

error_message?: string | null

TextEditorCodeExecutionViewResultBlockParam { content, file_type, type, 3 more }

content: string

file_type: "text" | "image" | "pdf"

Accepts one of the following:

"text"

"image"

"pdf"

type: "text_editor_code_execution_view_result"

num_lines?: number | null

start_line?: number | null

total_lines?: number | null

TextEditorCodeExecutionCreateResultBlockParam { is_file_update, type }

is_file_update: boolean

type: "text_editor_code_execution_create_result"

TextEditorCodeExecutionStrReplaceResultBlockParam { type, lines, new_lines, 3 more }

type: "text_editor_code_execution_str_replace_result"

lines?: Array<string> | null

new_lines?: number | null

new_start?: number | null

old_lines?: number | null

old_start?: number | null

tool_use_id: string

type: "text_editor_code_execution_tool_result"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

ToolSearchToolResultBlockParam { content, tool_use_id, type, cache_control }

content: ToolSearchToolResultErrorParam { error_code, type } | ToolSearchToolSearchResultBlockParam { tool_references, type }

Accepts one of the following:

ToolSearchToolResultErrorParam { error_code, type }

error_code: ToolSearchToolResultErrorCode

Accepts one of the following:

"invalid_tool_input"

"unavailable"

"too_many_requests"

"execution_time_exceeded"

type: "tool_search_tool_result_error"

ToolSearchToolSearchResultBlockParam { tool_references, type }

tool_references: Array<ToolReferenceBlockParam { tool_name, type, cache_control } >

tool_name: string

type: "tool_reference"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

type: "tool_search_tool_search_result"

tool_use_id: string

type: "tool_search_tool_result"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

ContainerUploadBlockParam { 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"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

ContentBlockSource { content, type }

content: string | Array<ContentBlockSourceContent>

Accepts one of the following:

string

Array<ContentBlockSourceContent>

TextBlockParam { text, type, cache_control, citations }

text: string

type: "text"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: Array<TextCitationParam> | null

Accepts one of the following:

CitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

start_char_index: number

type: "char_location"

CitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

start_page_number: number

type: "page_location"

CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

start_block_index: number

type: "content_block_location"

CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationSearchResultLocationParam { 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 | null

type: "search_result_location"

ImageBlockParam { source, type, cache_control }

source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }

Accepts one of the following:

Base64ImageSource { data, media_type, type }

data: string

media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"

Accepts one of the following:

"image/jpeg"

"image/png"

"image/gif"

"image/webp"

type: "base64"

URLImageSource { type, url }

type: "url"

url: string

type: "image"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

type: "content"

ContentBlockSourceContent = TextBlockParam { text, type, cache_control, citations } | ImageBlockParam { source, type, cache_control }

Accepts one of the following:

TextBlockParam { text, type, cache_control, citations }

text: string

type: "text"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

citations?: Array<TextCitationParam> | null

Accepts one of the following:

CitationCharLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_char_index: number

start_char_index: number

type: "char_location"

CitationPageLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_page_number: number

start_page_number: number

type: "page_location"

CitationContentBlockLocationParam { cited_text, document_index, document_title, 3 more }

cited_text: string

document_index: number

document_title: string | null

end_block_index: number

start_block_index: number

type: "content_block_location"

CitationWebSearchResultLocationParam { cited_text, encrypted_index, title, 2 more }

cited_text: string

encrypted_index: string

title: string | null

type: "web_search_result_location"

url: string

CitationSearchResultLocationParam { 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 | null

type: "search_result_location"

ImageBlockParam { source, type, cache_control }

source: Base64ImageSource { data, media_type, type } | URLImageSource { type, url }

Accepts one of the following:

Base64ImageSource { data, media_type, type }

data: string

media_type: "image/jpeg" | "image/png" | "image/gif" | "image/webp"

Accepts one of the following:

"image/jpeg"

"image/png"

"image/gif"

"image/webp"

type: "base64"

URLImageSource { type, url }

type: "url"

url: string

type: "image"

cache_control?: CacheControlEphemeral { type, ttl } | null

Create a cache control breakpoint at this content block.

type: "ephemeral"

ttl?: "5m" | "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.

Accepts one of the following:

"5m"

"1h"

DirectCaller { type }

Tool invocation directly from the model.

type: "direct"

DocumentBlock { citations, source, title, type }

citations: CitationsConfig { enabled } | null

Citation configuration for the document

enabled: boolean

source