One change
Create a Message
api/messages/create
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/messages/create Changed · +716 / -508 lines
# Create a Message ## Headers ## Body parameters ## Returns ## Example ### Response (200) ## Create a Message ### Header Parameters ### Body Parameters ### Returns ### Example #### Response
The two sides of this change are too far apart to line up, so this is the differ's own diff of it.
from line 1
---- -title: Create a Message -url: https://platform.claude.com/docs/en/api/messages/create ---- - -## Create a Message - -**post** `/v1/messages` +# Create a Message + +**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.
from line 8
Learn more about the Messages API in our [user guide](https://platform.claude.com/docs/en/get-started) -### Header Parameters +## Headers - `"anthropic-user-profile-id": optional string` The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. -### Body Parameters +## Body parameters - `max_tokens: number`
from line 25
Set to `0` to populate the [prompt cache](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#pre-warming-the-cache) without generating a response. Different models have different maximum values for this parameter. See [models](https://platform.claude.com/docs/en/about-claude/models/overview) for details. + + minimum: 0 - `messages: array of MessageParam`
from line 85
- `array of ContentBlockParam` - - `TextBlockParam object { text, type, cache_control, citations }` + - `TextBlockParam object` - `text: string` + minLength: 1 + - `type: "text"` - - `"text"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `type: "ephemeral"` - - - `"ephemeral"` - `ttl: optional "5m" or "1h"`
from line 116
- `citations: optional array of TextCitationParam or null` - - `CitationCharLocationParam object { cited_text, document_index, document_title, 3 more }` + - `CitationCharLocationParam object` - `cited_text: string` - `document_index: number` + minimum: 0 + - `document_title: string or null` + maxLength: 500, minLength: 1 + - `end_char_index: number` - `start_char_index: number` + minimum: 0 + - `type: "char_location"` - - `"char_location"` - - - `CitationPageLocationParam object { cited_text, document_index, document_title, 3 more }` + - `CitationPageLocationParam object` - `cited_text: string` - `document_index: number` + minimum: 0 + - `document_title: string or null` + maxLength: 500, minLength: 1 + - `end_page_number: number` - `start_page_number: number` + minimum: 1 + - `type: "page_location"` - - `"page_location"` - - - `CitationContentBlockLocationParam object { cited_text, document_index, document_title, 3 more }` + - `CitationContentBlockLocationParam object` - `cited_text: string`
from line 166
- `document_index: number` + minimum: 0 + - `document_title: string or null` + maxLength: 500, minLength: 1 + - `end_block_index: number` Exclusive 0-based end index of the cited block range in the source's `content` array.
from line 182
0-based index of the first cited block in the source's `content` array. + minimum: 0 + - `type: "content_block_location"` - - `"content_block_location"` - - - `CitationWebSearchResultLocationParam object { cited_text, encrypted_index, title, 2 more }` + - `CitationWebSearchResultLocationParam object` - `cited_text: string`
from line 194
- `title: string or null` + maxLength: 512, minLength: 1 + - `type: "web_search_result_location"` - - `"web_search_result_location"` - - `url: string` - - `CitationSearchResultLocationParam object { cited_text, end_block_index, search_result_index, 4 more }` + minLength: 1 + + - `CitationSearchResultLocationParam object` - `cited_text: string`
from line 222
Counted separately from `document_index`; server-side web search results are not included in this count. + minimum: 0 + - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. + minimum: 0 + - `title: string or null` - `type: "search_result_location"` - - `"search_result_location"` - - - `ImageBlockParam object { source, type, cache_control, transformations }` + - `ImageBlockParam object` - `source: Base64ImageSource or URLImageSource or FileImageSource` - - `Base64ImageSource object { data, media_type, type }` + - `Base64ImageSource object` - `data: string` + format: byte + - `media_type: "image/jpeg" or "image/png" or "image/gif" or "image/webp"` - `"image/jpeg"`
from line 258
- `type: "base64"` - - `"base64"` - - - `URLImageSource object { type, url }` + - `URLImageSource object` - `type: "url"` - - `"url"` - - `url: string` - - `FileImageSource object { file_id, type }` + - `FileImageSource object` - `file_id: string` - `type: "file"` - - `"file"` - - `type: "image"` - - `"image"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block.
from line 288
- `"error"` - - `DocumentBlockParam object { source, type, cache_control, 3 more }` + - `DocumentBlockParam object` - `source: Base64PDFSource or PlainTextSource or ContentBlockSource or 2 more` - - `Base64PDFSource object { data, media_type, type }` + - `Base64PDFSource object` - `data: string` + format: byte + - `media_type: "application/pdf"` - - `"application/pdf"` - - `type: "base64"` - - `"base64"` - - - `PlainTextSource object { data, media_type, type }` + - `PlainTextSource object` - `data: string` - `media_type: "text/plain"` - - `"text/plain"` - - `type: "text"` - - `"text"` - - - `ContentBlockSource object { content, type }` + - `ContentBlockSource object` - `content: string or array of ContentBlockSourceContent`
from line 318
- `ContentBlockSourceContent = array of ContentBlockSourceContent` - - `TextBlockParam object { text, type, cache_control, citations }` - - - `ImageBlockParam object { source, type, cache_control, transformations }` + - `TextBlockParam object` + + - `ImageBlockParam object` - `type: "content"` - - `"content"` - - - `URLPDFSource object { type, url }` + - `URLPDFSource object` - `type: "url"` - - `"url"` - - `url: string` - - `FileDocumentSource object { file_id, type }` + - `FileDocumentSource object` - `file_id: string` - `type: "file"` - - `"file"` - - `type: "document"` - - `"document"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block.
from line 348
- `context: optional string or null` + minLength: 1 + - `title: optional string or null` - - `SearchResultBlockParam object { content, source, title, 3 more }` + maxLength: 500, minLength: 1 + + - `SearchResultBlockParam object` - `content: array of TextBlockParam` - `text: string` + minLength: 1 + - `type: "text"` - `cache_control: optional CacheControlEphemeral or null`
from line 376
- `type: "search_result"` - - `"search_result"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block. - `citations: optional CitationsConfigParam` - - `ThinkingBlockParam object { signature, thinking, type }` + - `ThinkingBlockParam object` - `signature: string`
from line 396
- `type: "thinking"` - - `"thinking"` - - - `RedactedThinkingBlockParam object { data, type }` + - `RedactedThinkingBlockParam object` - `data: string`
from line 404
- `type: "redacted_thinking"` - - `"redacted_thinking"` - - - `ToolUseBlockParam object { id, input, name, 4 more }` + - `ToolUseBlockParam object` - `id: string` + pattern: ^[a-zA-Z0-9_-]+$ + - `input: map[unknown]` - `name: string` + maxLength: 200, minLength: 1 + - `type: "tool_use"` - - `"tool_use"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block.
from line 426
Tool invocation directly from the model. - - `DirectCaller object { type }` + - `DirectCaller object` Tool invocation directly from the model. - `type: "direct"` - - `"direct"` - - - `ServerToolCaller object { tool_id, type }` + - `ServerToolCaller object` Tool invocation generated by a server-side tool. - `tool_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "code_execution_20250825"` - - `"code_execution_20250825"` - - - `ServerToolCaller20260120 object { tool_id, type }` + - `ServerToolCaller20260120 object` - `tool_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "code_execution_20260120"` - - `"code_execution_20260120"` - - `toolset_name: optional string or null` For a toolset member tool_use, the toolset family this member belongs to. - - `ToolResultBlockParam object { tool_use_id, type, cache_control, 3 more }` + maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$ + + - `ToolResultBlockParam object` - `tool_use_id: string` + pattern: ^[a-zA-Z0-9_-]+$ + - `type: "tool_result"` - - `"tool_result"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block.
from line 474
- `array of TextBlockParam or ImageBlockParam or SearchResultBlockParam or 3 more` - - `TextBlockParam object { text, type, cache_control, citations }` - - - `ImageBlockParam object { source, type, cache_control, transformations }` - - - `SearchResultBlockParam object { content, source, title, 3 more }` - - - `DocumentBlockParam object { source, type, cache_control, 3 more }` - - - `ToolReferenceBlockParam object { tool_name, type, cache_control }` + - `TextBlockParam object` + + - `ImageBlockParam object` + + - `SearchResultBlockParam object` + + - `DocumentBlockParam object` + + - `ToolReferenceBlockParam object` Tool reference block that can be included in tool_result content. - `tool_name: string` + maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$ + - `type: "tool_reference"` - - `"tool_reference"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block. - - `BrowserStateBlockParam object { tabs, type, cache_control, state_changes }` + - `BrowserStateBlockParam object` The caller's browser state after a browser toolset member call — the full inventory of open tabs, which tab is active, and any side
from line 510
All tabs open in the browser after this call — the full inventory, not a delta. May be empty. Whenever non-empty, exactly one entry carries `active: true`. + maxItems: 100 + - `tab_id: string` The caller-assigned identifier for this tab, unique within the inventory. + maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + - `title: string` The title of the page the tab is showing. May be empty. + maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + - `url: string` The URL of the page the tab is showing. May be empty. + maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + - `active: optional boolean` Whether this tab is the active tab after this call. Whenever `tabs` is non-empty, exactly one entry is marked `active: true`. - `type: "browser_state"` - - `"browser_state"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block.
from line 544
Tabs opened and download state changes during this call. "Nothing to report" is expressed by omitting the field, never by an empty list. - - `BrowserStateChangeTabOpened object { tab_id, type }` + maxItems: 200, minItems: 1 + + - `BrowserStateChangeTabOpened object` A tab this call's execution opened that remains open at its end — the creation delta of the `tabs` inventory, not an event log.
from line 560
The `tab_id` of the opened tab, present in `tabs`. + maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + - `type: "tab_opened"` - - `"tab_opened"` - - - `BrowserStateChangeDownloadStarted object { download_id, type, url }` + - `BrowserStateChangeDownloadStarted object` A file download that started during this call.
from line 572
The caller-assigned identifier for this download, stable across the state changes reporting it. + maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + - `type: "download_started"` - - `"download_started"` - - `url: string` The final post-redirect URL the download was served from. - - `BrowserStateChangeDownloadCompleted object { download_id, type, url, 2 more }` + maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + + - `BrowserStateChangeDownloadCompleted object` A file download that finished during this call, reported with the same `download_id` as its `download_started` — or without a prior
from line 593
The caller-assigned identifier for this download, stable across the state changes reporting it. + maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + - `type: "download_completed"` - - `"download_completed"` - - `url: string` The final post-redirect URL the download was served from. + maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + - `path: optional string or null` Where the executor saved the file, on the executor's filesystem. Only included when another tool in the same environment can read the file at that path. + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096 + - `size_bytes: optional number or null` The completed download's size. - - `BrowserStateChangeDownloadFailed object { download_id, type, url, error }` + minimum: 0 + + - `BrowserStateChangeDownloadFailed object` A file download that failed — or was cancelled — during this call.
from line 623
The caller-assigned identifier for this download, stable across the state changes reporting it. + maxLength: 4096, minLength: 1, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + - `type: "download_failed"` - - `"download_failed"` - - `url: string` The final post-redirect URL the download was served from. + maxLength: 4096, pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$ + - `error: optional string or null` The failure or cancellation detail, when known. + pattern: ^[^\x00-\x1f\x7f-\x9f\u2028\u2029]*$, maxLength: 4096 + - `is_error: optional boolean` - `toolset_name: optional string or null` For a toolset member tool_result, the toolset family of the paired tool_use. - - `ServerToolUseBlockParam object { id, input, name, 3 more }` + maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$ + + - `ServerToolUseBlockParam object` - `id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `input: map[unknown]` - `name: "web_search" or "web_fetch" or "code_execution" or 4 more`
from line 673
- `type: "server_tool_use"` - - `"server_tool_use"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block.
from line 681
Tool invocation directly from the model. - - `DirectCaller object { type }` + - `DirectCaller object` Tool invocation directly from the model. - - `ServerToolCaller object { tool_id, type }` + - `ServerToolCaller object` Tool invocation generated by a server-side tool. - - `ServerToolCaller20260120 object { tool_id, type }` - - - `WebSearchToolResultBlockParam object { content, tool_use_id, type, 2 more }` + - `ServerToolCaller20260120 object` + + - `WebSearchToolResultBlockParam object` - `content: WebSearchToolResultBlockParamContent`
from line 703
- `type: "web_search_result"` - - `"web_search_result"` - - `url: string` - `page_age: optional string or null` - - `WebSearchToolRequestError object { error_code, type }` + - `WebSearchToolRequestError object` - `error_code: WebSearchToolResultErrorCode`
from line 725
- `type: "web_search_tool_result_error"` - - `"web_search_tool_result_error"` - - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "web_search_tool_result"` - - `"web_search_tool_result"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block.
from line 739
Tool invocation directly from the model. - - `DirectCaller object { type }` + - `DirectCaller object` Tool invocation directly from the model. - - `ServerToolCaller object { tool_id, type }` + - `ServerToolCaller object` Tool invocation generated by a server-side tool. - - `ServerToolCaller20260120 object { tool_id, type }` - - - `WebFetchToolResultBlockParam object { content, tool_use_id, type, 2 more }` + - `ServerToolCaller20260120 object` + + - `WebFetchToolResultBlockParam object` - `content: WebFetchToolResultErrorBlockParam or WebFetchBlockParam` - - `WebFetchToolResultErrorBlockParam object { error_code, type }` + - `WebFetchToolResultErrorBlockParam object` - `error_code: WebFetchToolResultErrorCode`
from line 777
- `type: "web_fetch_tool_result_error"` - - `"web_fetch_tool_result_error"` - - - `WebFetchBlockParam object { content, type, url, retrieved_at }` + - `WebFetchBlockParam object` - `content: DocumentBlockParam` - `type: "web_fetch_result"` - - `"web_fetch_result"` - - `url: string` Fetched content URL
from line 793
- `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "web_fetch_tool_result"` - - `"web_fetch_tool_result"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block.
from line 805
Tool invocation directly from the model. - - `DirectCaller object { type }` + - `DirectCaller object` Tool invocation directly from the model. - - `ServerToolCaller object { tool_id, type }` + - `ServerToolCaller object` Tool invocation generated by a server-side tool. - - `ServerToolCaller20260120 object { tool_id, type }` - - - `CodeExecutionToolResultBlockParam object { content, tool_use_id, type, cache_control }` + - `ServerToolCaller20260120 object` + + - `CodeExecutionToolResultBlockParam object` - `content: CodeExecutionToolResultBlockParamContent` Code execution result with encrypted stdout for PFC + web_search results. - - `CodeExecutionToolResultErrorParam object { error_code, type }` + - `CodeExecutionToolResultErrorParam object` - `error_code: CodeExecutionToolResultErrorCode`
from line 835
- `type: "code_execution_tool_result_error"` - - `"code_execution_tool_result_error"` - - - `CodeExecutionResultBlockParam object { content, return_code, stderr, 2 more }` + - `CodeExecutionResultBlockParam object` - `content: array of CodeExecutionOutputBlockParam`
from line 843
- `type: "code_execution_output"` - - `"code_execution_output"` - - `return_code: number` - `stderr: string`
from line 851
- `type: "code_execution_result"` - - `"code_execution_result"` - - - `EncryptedCodeExecutionResultBlockParam object { content, encrypted_stdout, return_code, 2 more }` + - `EncryptedCodeExecutionResultBlockParam object` Code execution result with encrypted stdout for PFC + web_search results.
from line 869
- `type: "encrypted_code_execution_result"` - - `"encrypted_code_execution_result"` - - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "code_execution_tool_result"` - - `"code_execution_tool_result"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block. - - `BashCodeExecutionToolResultBlockParam object { content, tool_use_id, type, cache_control }` + - `BashCodeExecutionToolResultBlockParam object` - `content: BashCodeExecutionToolResultErrorParam or BashCodeExecutionResultBlockParam` - - `BashCodeExecutionToolResultErrorParam object { error_code, type }` + - `BashCodeExecutionToolResultErrorParam object` - `error_code: BashCodeExecutionToolResultErrorCode`
from line 899
- `type: "bash_code_execution_tool_result_error"` - - `"bash_code_execution_tool_result_error"` - - - `BashCodeExecutionResultBlockParam object { content, return_code, stderr, 2 more }` + - `BashCodeExecutionResultBlockParam object` - `content: array of BashCodeExecutionOutputBlockParam`
from line 907
- `type: "bash_code_execution_output"` - - `"bash_code_execution_output"` - - `return_code: number` - `stderr: string`
from line 915
- `type: "bash_code_execution_result"` - - `"bash_code_execution_result"` - - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "bash_code_execution_tool_result"` - - `"bash_code_execution_tool_result"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block. - - `TextEditorCodeExecutionToolResultBlockParam object { content, tool_use_id, type, cache_control }` + - `TextEditorCodeExecutionToolResultBlockParam object` - `content: TextEditorCodeExecutionToolResultErrorParam or TextEditorCodeExecutionViewResultBlockParam or TextEditorCodeExecutionCreateResultBlockParam or TextEditorCodeExecutionStrReplaceResultBlockParam` - - `TextEditorCodeExecutionToolResultErrorParam object { error_code, type, error_message }` + - `TextEditorCodeExecutionToolResultErrorParam object` - `error_code: TextEditorCodeExecutionToolResultErrorCode`
from line 945
- `type: "text_editor_code_execution_tool_result_error"` - - `"text_editor_code_execution_tool_result_error"` - - `error_message: optional string or null` - - `TextEditorCodeExecutionViewResultBlockParam object { content, file_type, type, 3 more }` + - `TextEditorCodeExecutionViewResultBlockParam object` - `content: string`
from line 961
- `type: "text_editor_code_execution_view_result"` - - `"text_editor_code_execution_view_result"` - - `num_lines: optional number or null` - `start_line: optional number or null` - `total_lines: optional number or null` - - `TextEditorCodeExecutionCreateResultBlockParam object { is_file_update, type }` + - `TextEditorCodeExecutionCreateResultBlockParam object` - `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 }` + - `TextEditorCodeExecutionStrReplaceResultBlockParam object` - `type: "text_editor_code_execution_str_replace_result"` - - `"text_editor_code_execution_str_replace_result"` - - `lines: optional array of string or null` - `new_lines: optional number or null`
from line 989
- `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "text_editor_code_execution_tool_result"` - - `"text_editor_code_execution_tool_result"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block. - - `ToolSearchToolResultBlockParam object { content, tool_use_id, type, cache_control }` + - `ToolSearchToolResultBlockParam object` - `content: ToolSearchToolResultErrorParam or ToolSearchToolSearchResultBlockParam` - - `ToolSearchToolResultErrorParam object { error_code, type, error_message }` + - `ToolSearchToolResultErrorParam object` - `error_code: ToolSearchToolResultErrorCode`
from line 1015
- `type: "tool_search_tool_result_error"` - - `"tool_search_tool_result_error"` - - `error_message: optional string or null` - - `ToolSearchToolSearchResultBlockParam object { tool_references, type }` + - `ToolSearchToolSearchResultBlockParam object` - `tool_references: array of ToolReferenceBlockParam` - `tool_name: string` + maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$ + - `type: "tool_reference"` - `cache_control: optional CacheControlEphemeral or null`
from line 1033
- `type: "tool_search_tool_search_result"` - - `"tool_search_tool_search_result"` - - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "tool_search_tool_result"` - - `"tool_search_tool_result"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block. - - `ContainerUploadBlockParam object { file_id, type, cache_control }` + - `ContainerUploadBlockParam object` 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.
from line 1052
- `type: "container_upload"` - - `"container_upload"` - - `cache_control: optional CacheControlEphemeral or null` Create a cache control breakpoint at this content block.
from line 1146
Container identifier for reuse across requests. - - `ContainerParams object { id, skills }` + - `ContainerParams object` Container parameters with skills to be loaded.
from line 1158
List of skills to load in the container + maxItems: 20 + - `skill_id: string` Skill ID + maxLength: 64, minLength: 1 + - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
from line 1178
Skill version or 'latest' for most recent version + maxLength: 64, minLength: 1 + - `string` - `inference_geo: optional string or null`
from line 1196
This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number. + maxLength: 512 + - `output_config: optional OutputConfig` Configuration options for the model's output, such as the output format.
from line 1226
- `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.
from line 1262
- `text: string` + minLength: 1 + - `type: "text"` - `cache_control: optional CacheControlEphemeral or null`
from line 1272
- `citations: optional array of TextCitationParam or null` -- `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.
from line 1280
See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details. - - `ThinkingConfigEnabled object { budget_tokens, type, display }` + - `ThinkingConfigEnabled object` - `budget_tokens: number`
from line 1290
See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details. + minimum: 1024 + - `type: "enabled"` - - `"enabled"` - - `display: optional "summarized" or "omitted" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.
from line 1302
- `"omitted"` - - `ThinkingConfigDisabled object { type }` + - `ThinkingConfigDisabled object` - `type: "disabled"` - - `"disabled"` - - - `ThinkingConfigAdaptive object { type, display }` + - `ThinkingConfigAdaptive object` - `type: "adaptive"` - - `"adaptive"` - - `display: optional "summarized" or "omitted" or null` Controls how thinking content appears in the response. When set to `summarized`, thinking is returned normally. When set to `omitted`, thinking content is redacted but a signature is returned for multi-turn continuity. Defaults to `summarized`.
from line 1322
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 }` + - `ToolChoiceAuto object` 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 }` + - `ToolChoiceAny object` 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 }` + - `ToolChoiceTool object` The model will use the specified tool with `tool_choice.name`.
from line 1356
- `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 }` + - `ToolChoiceNone object` The model will not be allowed to use tools. - `type: "none"` - - - `"none"` - `tools: optional array of ToolUnion`
from line 1432
See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details. - - `Tool object { input_schema, name, allowed_callers, 7 more }` - - - `input_schema: object { type, properties, required }` + - `Tool object` + + - `input_schema: object` [JSON schema](https://json-schema.org/draft/2020-12) for this tool's input.
from line 1442
- `type: "object"` - - `"object"` - - `properties: optional map[unknown] or null` - `required: optional array of string or null`
from line 1452
This is how the tool will be called by the model and in `tool_use` blocks. + maxLength: 128, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,128}$ + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"`
from line 1490
- `type: optional "custom" or null` - - `"custom"` - - - `ToolBash20250124 object { name, type, allowed_callers, 4 more }` + - `ToolBash20250124 object` - `name: "bash"`
from line 1498
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" or "code_execution_20260521"` - `"direct"`
from line 1524
When true, guarantees schema validation on tool names and inputs - - `CodeExecutionTool20250522 object { name, type, allowed_callers, 3 more }` + - `CodeExecutionTool20250522 object` - `name: "code_execution"`
from line 1532
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" or "code_execution_20260521"` - `"direct"`
from line 1556
When true, guarantees schema validation on tool names and inputs - - `CodeExecutionTool20250825 object { name, type, allowed_callers, 3 more }` + - `CodeExecutionTool20250825 object` - `name: "code_execution"`
from line 1564
This is how the tool will be called by the model and in `tool_use` blocks. - - `"code_execution"` - - `type: "code_execution_20250825"` + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` + + - `"direct"` + - `"code_execution_20250825"` + - `"code_execution_20260120"` + + - `"code_execution_20260521"` + + - `cache_control: optional CacheControlEphemeral or null` + + Create a cache control breakpoint at this content block. + + - `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` + + 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. + + - `type: "code_execution_20260120"` + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"`
from line 1622
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). + - `CodeExecutionTool20260521 object` + + Code execution tool with REPL state persistence. - `name: "code_execution"`
from line 1632
This is how the tool will be called by the model and in `tool_use` blocks. - - `"code_execution"` - - - `type: "code_execution_20260120"` + - `type: "code_execution_20260521"` + + - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` + + - `"direct"` + + - `"code_execution_20250825"` - `"code_execution_20260120"` - - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - - - `"direct"` - - - `"code_execution_20250825"` - - - `"code_execution_20260120"` - - `"code_execution_20260521"` - `cache_control: optional CacheControlEphemeral or null`
from line 1656
When true, guarantees schema validation on tool names and inputs - - `CodeExecutionTool20260521 object { name, type, allowed_callers, 3 more }` - - Code execution tool with REPL state persistence. - - - `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_20260521"` - - - `"code_execution_20260521"` - - - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - - - `"direct"` - - - `"code_execution_20250825"` - - - `"code_execution_20260120"` - - - `"code_execution_20260521"` - - - `cache_control: optional CacheControlEphemeral or null` - - Create a cache control breakpoint at this content block. - - - `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 - - - `BrowserToolset20260801 object { type, allowed_callers, cache_control, configs }` + - `BrowserToolset20260801 object` The browser toolset: a single `tools[]` entry (carrying no `name`) that declares the browser tool family. The model is served
from line 1664
from its schema. - `type: "browser_toolset_20260801"` - - - `"browser_toolset_20260801"` - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"`
from line 2060
Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - - `MemoryTool20250818 object { name, type, allowed_callers, 4 more }` + - `MemoryTool20250818 object` - `name: "memory"`
from line 2068
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" or "code_execution_20260521"` - `"direct"`
from line 2094
When true, guarantees schema validation on tool names and inputs - - `ComputerToolset20260801 object { type, allowed_callers, cache_control, configs }` + - `ComputerToolset20260801 object` The computer toolset: a single `tools[]` entry (carrying no `name`) that declares the computer tool family. The model is
from line 2107
- `type: "computer_toolset_20260801"` - - `"computer_toolset_20260801"` - - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"`
from line 2334
Whether this member is offered to the model. Default is per member, per the toolset's documentation. A member whose enabled resolves false is withheld from the served schema. - - `ToolTextEditor20250124 object { name, type, allowed_callers, 4 more }` + - `ToolTextEditor20250124 object` - `name: "str_replace_editor"`
from line 2342
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" or "code_execution_20260521"` - `"direct"`
from line 2368
When true, guarantees schema validation on tool names and inputs - - `ToolTextEditor20250429 object { name, type, allowed_callers, 4 more }` + - `ToolTextEditor20250429 object` - `name: "str_replace_based_edit_tool"`
from line 2376
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" or "code_execution_20260521"` - `"direct"`
from line 2402
When true, guarantees schema validation on tool names and inputs - - `ToolTextEditor20250728 object { name, type, allowed_callers, 5 more }` + - `ToolTextEditor20250728 object` - `name: "str_replace_based_edit_tool"`
from line 2410
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" or "code_execution_20260521"` - `"direct"`
from line 2436
Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. + minimum: 1 + - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - - `WebSearchTool20250305 object { name, type, allowed_callers, 7 more }` + - `WebSearchTool20250305 object` - `name: "web_search"`
from line 2450
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" or "code_execution_20260521"` - `"direct"`
from line 2482
Maximum number of times the tool can be used in the API request. + exclusiveMinimum: 0 + - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs
from line 2494
- `type: "approximate"` - - `"approximate"` - - `city: optional string or null` The city of the user. + maxLength: 255, minLength: 1 + - `country: optional string or null` The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the user. + maxLength: 2, minLength: 2 + - `region: optional string or null` The region of the user. + maxLength: 255, minLength: 1 + - `timezone: optional string or null` The [IANA timezone](https://nodatime.org/TimeZones) of the user. - - `WebFetchTool20250910 object { name, type, allowed_callers, 8 more }` + maxLength: 255, minLength: 1 + + - `WebFetchTool20250910 object` - `name: "web_fetch"`
from line 2526
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" or "code_execution_20260521"` - `"direct"`
from line 2562
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. + exclusiveMinimum: 0 + - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. + exclusiveMinimum: 0 + - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - - `WebSearchTool20260209 object { name, type, allowed_callers, 7 more }` + - `WebSearchTool20260209 object` - `name: "web_search"`
from line 2582
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" or "code_execution_20260521"` - `"direct"`
from line 2614
Maximum number of times the tool can be used in the API request. + exclusiveMinimum: 0 + - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs
from line 2624
Parameters for the user's location. Used to provide more relevant search results. - - `WebFetchTool20260209 object { name, type, allowed_callers, 8 more }` + - `WebFetchTool20260209 object` - `name: "web_fetch"`
from line 2632
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" or "code_execution_20260521"` - `"direct"`
from line 2668
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. + exclusiveMinimum: 0 + - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. + exclusiveMinimum: 0 + - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs - - `WebFetchTool20260309 object { name, type, allowed_callers, 9 more }` + - `WebFetchTool20260309 object` Web fetch tool with use_cache parameter for bypassing cached content.
from line 2690
This is how the tool will be called by the model and in `tool_use` blocks. - - `"web_fetch"` - - `type: "web_fetch_20260309"` - - `"web_fetch_20260309"` - - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"`
from line 2726
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. + exclusiveMinimum: 0 + - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. + exclusiveMinimum: 0 + - `strict: optional boolean` When true, guarantees schema validation on tool names and inputs
from line 2742
Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - - `WebSearchTool20260318 object { name, type, allowed_callers, 8 more }` + - `WebSearchTool20260318 object` - `name: "web_search"`
from line 2750
This is how the tool will be called by the model and in `tool_use` blocks. - - `"web_search"` - - `type: "web_search_20260318"` - - `"web_search_20260318"` - - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"`
from line 2782
Maximum number of times the tool can be used in the API request. + exclusiveMinimum: 0 + - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.
from line 2800
Parameters for the user's location. Used to provide more relevant search results. - - `WebFetchTool20260318 object { name, type, allowed_callers, 10 more }` + - `WebFetchTool20260318 object` - `name: "web_fetch"`
from line 2808
This is how the tool will be called by the model and in `tool_use` blocks. - - `"web_fetch"` - - `type: "web_fetch_20260318"` - - `"web_fetch_20260318"` - - `allowed_callers: optional array of "direct" or "code_execution_20250825" or "code_execution_20260120" or "code_execution_20260521"` - `"direct"`
from line 2844
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. + exclusiveMinimum: 0 + - `max_uses: optional number or null` Maximum number of times the tool can be used in the API request. + exclusiveMinimum: 0 + - `response_inclusion: optional "full" or "excluded"` How this tool's result blocks appear in the API response when the result was consumed by a completed code_execution call in the same turn. 'full' returns the complete content (default). 'excluded' drops the nested server_tool_use and result block pair entirely. Results from direct calls, or from code_execution calls that paused before completing, are always returned in full so they can be sent back on the next turn.
from line 2868
Whether to use cached content. Set to false to bypass the cache and fetch fresh content. Only set to false when the user explicitly requests fresh content or when fetching rapidly-changing sources. - - `ToolSearchToolBm25_20251119 object { name, type, allowed_callers, 3 more }` + - `ToolSearchToolBm25_20251119 object` - `name: "tool_search_tool_bm25"`
from line 2876
This is how the tool will be called by the model and in `tool_use` blocks. + - `type: "tool_search_tool_bm25_20251119" or "tool_search_tool_bm25"` + + - `"tool_search_tool_bm25_20251119"` + - `"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" or "code_execution_20260521"` - `"direct"`
from line 2904
When true, guarantees schema validation on tool names and inputs - - `ToolSearchToolRegex20251119 object { name, type, allowed_callers, 3 more }` + - `ToolSearchToolRegex20251119 object` - `name: "tool_search_tool_regex"`
from line 2912
This is how the tool will be called by the model and in `tool_use` blocks. + - `type: "tool_search_tool_regex_20251119" or "tool_search_tool_regex"` + + - `"tool_search_tool_regex_20251119"` + - `"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" or "code_execution_20260521"` - `"direct"`
from line 2940
When true, guarantees schema validation on tool names and inputs +- `temperature: optional number` + + **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error. + + Amount of randomness injected into the response. + + Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. + + Note that even with `temperature` of `0.0`, the results will not be fully deterministic. + + maximum: 1, minimum: 0 + - `top_k: optional number` + **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error. + Only sample from the top K options for each subsequent token. Used to remove "long tail" low probability responses. [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277). Recommended for advanced use cases only. + minimum: 0 + - `top_p: optional number` + **Deprecated**: Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error. + Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. -### Returns - -- `Message object { id, container, content, 7 more }` + maximum: 1, minimum: 0 + +## Returns + +- `Message object` - `id: string`
from line 2998
The time at which the container will expire. + format: date-time + - `skills: array of ContainerSkill or null` Skills loaded in the container
from line 3008
Skill ID + maxLength: 64, minLength: 1 + - `type: "anthropic" or "custom"` Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)
from line 3021
- `version: string` The resolved version: a skill version ID for custom skills. + + maxLength: 64, minLength: 1 - `content: array of ContentBlock`
from line 3053
[{"type": "text", "text": "B)"}] ``` - - `TextBlock object { citations, text, type }` + - `TextBlock object` - `citations: array of TextCitation or null`
from line 3061
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 }` + - `CitationCharLocation object` - `cited_text: string` - `document_index: number` + minimum: 0 + - `document_title: string or null` - `end_char_index: number`
from line 3077
- `start_char_index: number` + minimum: 0 + - `type: "char_location"` - - `"char_location"` - - - `CitationPageLocation object { cited_text, document_index, document_title, 4 more }` + default: char_location + + - `CitationPageLocation object` - `cited_text: string` - `document_index: number` + minimum: 0 + - `document_title: string or null` - `end_page_number: number`
from line 3099
- `start_page_number: number` + minimum: 1 + - `type: "page_location"` - - `"page_location"` - - - `CitationContentBlockLocation object { cited_text, document_index, document_title, 4 more }` + default: page_location + + - `CitationContentBlockLocation object` - `cited_text: string`
from line 3115
- `document_index: number` + minimum: 0 + - `document_title: string or null` - `end_block_index: number`
from line 3131
0-based index of the first cited block in the source's `content` array. + minimum: 0 + - `type: "content_block_location"` - - `"content_block_location"` - - - `CitationsWebSearchResultLocation object { cited_text, encrypted_index, title, 2 more }` + default: content_block_location + + - `CitationsWebSearchResultLocation object` - `cited_text: string`
from line 3145
- `title: string or null` + maxLength: 512 + - `type: "web_search_result_location"` - - `"web_search_result_location"` + default: web_search_result_location - `url: string` - - `CitationsSearchResultLocation object { cited_text, end_block_index, search_result_index, 4 more }` + - `CitationsSearchResultLocation object` - `cited_text: string`
from line 3173
Counted separately from `document_index`; server-side web search results are not included in this count. + minimum: 0 + - `source: string` - `start_block_index: number` 0-based index of the first cited block in the source's `content` array. + minimum: 0 + - `title: string or null` - `type: "search_result_location"` - - `"search_result_location"` + default: search_result_location - `text: string` + maxLength: 5000000, minLength: 0 + - `type: "text"` - - `"text"` - - - `ThinkingBlock object { signature, thinking, type }` + default: text + + - `ThinkingBlock object` - `signature: string`
from line 3213
- `type: "thinking"` - - `"thinking"` - - - `RedactedThinkingBlock object { data, type }` + default: thinking + + - `RedactedThinkingBlock object` - `data: string`
from line 3227
- `type: "redacted_thinking"` - - `"redacted_thinking"` - - - `ToolUseBlock object { id, caller, input, 3 more }` + default: redacted_thinking + + - `ToolUseBlock object` - `id: string` + pattern: ^[a-zA-Z0-9_-]+$ + - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120` Tool invocation directly from the model. - - `DirectCaller object { type }` + default: {"type":"direct"} + + - `DirectCaller object` Tool invocation directly from the model. - `type: "direct"` - - `"direct"` - - - `ServerToolCaller object { tool_id, type }` + - `ServerToolCaller object` Tool invocation generated by a server-side tool. - `tool_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "code_execution_20250825"` - - `"code_execution_20250825"` - - - `ServerToolCaller20260120 object { tool_id, type }` + - `ServerToolCaller20260120 object` - `tool_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "code_execution_20260120"` - - `"code_execution_20260120"` - - `input: map[unknown]` - `name: string` + minLength: 1 + - `type: "tool_use"` - - `"tool_use"` + default: tool_use - `toolset_name: optional string or null` For a toolset member tool_use, the toolset family. - - `ServerToolUseBlock object { id, caller, input, 2 more }` + maxLength: 64, minLength: 1, pattern: ^[a-zA-Z0-9_-]+$ + + - `ServerToolUseBlock object` - `id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120` Tool invocation directly from the model. - - `DirectCaller object { type }` + default: {"type":"direct"} + + - `DirectCaller object` Tool invocation directly from the model. - - `ServerToolCaller object { tool_id, type }` + - `ServerToolCaller object` Tool invocation generated by a server-side tool. - - `ServerToolCaller20260120 object { tool_id, type }` + - `ServerToolCaller20260120 object` - `input: map[unknown]`
from line 3323
- `type: "server_tool_use"` - - `"server_tool_use"` - - - `WebSearchToolResultBlock object { caller, content, tool_use_id, type }` + default: server_tool_use + + - `WebSearchToolResultBlock object` - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120` Tool invocation directly from the model. - - `DirectCaller object { type }` + default: {"type":"direct"} + + - `DirectCaller object` Tool invocation directly from the model. - - `ServerToolCaller object { tool_id, type }` + - `ServerToolCaller object` Tool invocation generated by a server-side tool. - - `ServerToolCaller20260120 object { tool_id, type }` + - `ServerToolCaller20260120 object` - `content: WebSearchToolResultBlockContent` - - `WebSearchToolResultError object { error_code, type }` + - `WebSearchToolResultError object` - `error_code: WebSearchToolResultErrorCode`
from line 3363
- `type: "web_search_tool_result_error"` - - `"web_search_tool_result_error"` + default: web_search_tool_result_error - `array of WebSearchResultBlock`
from line 3375
- `type: "web_search_result"` - - `"web_search_result"` + default: web_search_result - `url: string` - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "web_search_tool_result"` - - `"web_search_tool_result"` - - - `WebFetchToolResultBlock object { caller, content, tool_use_id, type }` + default: web_search_tool_result + + - `WebFetchToolResultBlock object` - `caller: DirectCaller or ServerToolCaller or ServerToolCaller20260120` Tool invocation directly from the model. - - `DirectCaller object { type }` + default: {"type":"direct"} + + - `DirectCaller object` Tool invocation directly from the model. - - `ServerToolCaller object { tool_id, type }` + - `ServerToolCaller object` Tool invocation generated by a server-side tool. - - `ServerToolCaller20260120 object { tool_id, type }` + - `ServerToolCaller20260120 object` - `content: WebFetchToolResultErrorBlock or WebFetchBlock` - - `WebFetchToolResultErrorBlock object { error_code, type }` + - `WebFetchToolResultErrorBlock object` - `error_code: WebFetchToolResultErrorCode`
from line 3431
- `type: "web_fetch_tool_result_error"` - - `"web_fetch_tool_result_error"` - - - `WebFetchBlock object { content, retrieved_at, type, url }` + default: web_fetch_tool_result_error + + - `WebFetchBlock object` - `content: DocumentBlock`
from line 3443
- `enabled: boolean` + default: false + - `source: Base64PDFSource or PlainTextSource` - - `Base64PDFSource object { data, media_type, type }` + - `Base64PDFSource object` - `data: string` + format: byte + - `media_type: "application/pdf"` - - `"application/pdf"` - - `type: "base64"` - - `"base64"` - - - `PlainTextSource object { data, media_type, type }` + - `PlainTextSource object` - `data: string` - `media_type: "text/plain"` - - `"text/plain"` - - `type: "text"` - - `"text"` - - `title: string or null` The title of the document - `type: "document"` - - `"document"` + default: document - `retrieved_at: string or null`
from line 3479
- `type: "web_fetch_result"` - - `"web_fetch_result"` + default: web_fetch_result - `url: string`
from line 3487
- `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "web_fetch_tool_result"` - - `"web_fetch_tool_result"` - - - `CodeExecutionToolResultBlock object { content, tool_use_id, type }` + default: web_fetch_tool_result + + - `CodeExecutionToolResultBlock object` - `content: CodeExecutionToolResultBlockContent` Code execution result with encrypted stdout for PFC + web_search results. - - `CodeExecutionToolResultError object { error_code, type }` + - `CodeExecutionToolResultError object` - `error_code: CodeExecutionToolResultErrorCode`
from line 3513
- `type: "code_execution_tool_result_error"` - - `"code_execution_tool_result_error"` - - - `CodeExecutionResultBlock object { content, return_code, stderr, 2 more }` + default: code_execution_tool_result_error + + - `CodeExecutionResultBlock object` - `content: array of CodeExecutionOutputBlock`
from line 3523
- `type: "code_execution_output"` - - `"code_execution_output"` + default: code_execution_output - `return_code: number`
from line 3533
- `type: "code_execution_result"` - - `"code_execution_result"` - - - `EncryptedCodeExecutionResultBlock object { content, encrypted_stdout, return_code, 2 more }` + default: code_execution_result + + - `EncryptedCodeExecutionResultBlock object` Code execution result with encrypted stdout for PFC + web_search results.
from line 3545
- `type: "code_execution_output"` + default: code_execution_output + - `encrypted_stdout: string` - `return_code: number`
from line 3555
- `type: "encrypted_code_execution_result"` - - `"encrypted_code_execution_result"` + default: encrypted_code_execution_result - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "code_execution_tool_result"` - - `"code_execution_tool_result"` - - - `BashCodeExecutionToolResultBlock object { content, tool_use_id, type }` + default: code_execution_tool_result + + - `BashCodeExecutionToolResultBlock object` - `content: BashCodeExecutionToolResultError or BashCodeExecutionResultBlock` - - `BashCodeExecutionToolResultError object { error_code, type }` + - `BashCodeExecutionToolResultError object` - `error_code: BashCodeExecutionToolResultErrorCode`
from line 3585
- `type: "bash_code_execution_tool_result_error"` - - `"bash_code_execution_tool_result_error"` - - - `BashCodeExecutionResultBlock object { content, return_code, stderr, 2 more }` + default: bash_code_execution_tool_result_error + + - `BashCodeExecutionResultBlock object` - `content: array of BashCodeExecutionOutputBlock`
from line 3595
- `type: "bash_code_execution_output"` - - `"bash_code_execution_output"` + default: bash_code_execution_output - `return_code: number`
from line 3605
- `type: "bash_code_execution_result"` - - `"bash_code_execution_result"` + default: bash_code_execution_result - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "bash_code_execution_tool_result"` - - `"bash_code_execution_tool_result"` - - - `TextEditorCodeExecutionToolResultBlock object { content, tool_use_id, type }` + default: bash_code_execution_tool_result + + - `TextEditorCodeExecutionToolResultBlock object` - `content: TextEditorCodeExecutionToolResultError or TextEditorCodeExecutionViewResultBlock or TextEditorCodeExecutionCreateResultBlock or TextEditorCodeExecutionStrReplaceResultBlock` - - `TextEditorCodeExecutionToolResultError object { error_code, error_message, type }` + - `TextEditorCodeExecutionToolResultError object` - `error_code: TextEditorCodeExecutionToolResultErrorCode`
from line 3637
- `type: "text_editor_code_execution_tool_result_error"` - - `"text_editor_code_execution_tool_result_error"` - - - `TextEditorCodeExecutionViewResultBlock object { content, file_type, num_lines, 3 more }` + default: text_editor_code_execution_tool_result_error + + - `TextEditorCodeExecutionViewResultBlock object` - `content: string`
from line 3659
- `type: "text_editor_code_execution_view_result"` - - `"text_editor_code_execution_view_result"` - - - `TextEditorCodeExecutionCreateResultBlock object { is_file_update, type }` + default: text_editor_code_execution_view_result + + - `TextEditorCodeExecutionCreateResultBlock object` - `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 }` + default: text_editor_code_execution_create_result + + - `TextEditorCodeExecutionStrReplaceResultBlock object` - `lines: array of string or null`
from line 3683
- `type: "text_editor_code_execution_str_replace_result"` - - `"text_editor_code_execution_str_replace_result"` + default: text_editor_code_execution_str_replace_result - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "text_editor_code_execution_tool_result"` - - `"text_editor_code_execution_tool_result"` - - - `ToolSearchToolResultBlock object { content, tool_use_id, type }` + default: text_editor_code_execution_tool_result + + - `ToolSearchToolResultBlock object` - `content: ToolSearchToolResultError or ToolSearchToolSearchResultBlock` - - `ToolSearchToolResultError object { error_code, error_message, type }` + - `ToolSearchToolResultError object` - `error_code: ToolSearchToolResultErrorCode`
from line 3713
- `type: "tool_search_tool_result_error"` - - `"tool_search_tool_result_error"` - - - `ToolSearchToolSearchResultBlock object { tool_references, type }` + default: tool_search_tool_result_error + + - `ToolSearchToolSearchResultBlock object` - `tool_references: array of ToolReferenceBlock` - `tool_name: string` + maxLength: 256, minLength: 1, pattern: ^[a-zA-Z0-9_-]{1,256}$ + - `type: "tool_reference"` - - `"tool_reference"` + default: tool_reference - `type: "tool_search_tool_search_result"` - - `"tool_search_tool_search_result"` + default: tool_search_tool_search_result - `tool_use_id: string` + pattern: ^srvtoolu_[a-zA-Z0-9_]+$ + - `type: "tool_search_tool_result"` - - `"tool_search_tool_result"` - - - `ContainerUploadBlock object { file_id, type }` + default: tool_search_tool_result + + - `ContainerUploadBlock object` Response model for a file uploaded to the container.
from line 3747
- `type: "container_upload"` - - `"container_upload"` + default: container_upload - `model: Model`
from line 3829
This will always be `"assistant"`. - - `"assistant"` + default: assistant - `stop_details: RefusalStopDetails or null`
from line 3867
- `type: "refusal"` - - `"refusal"` + default: refusal - `stop_reason: StopReason or null`
from line 3911
For Messages, this is always `"message"`. - - `"message"` + default: message - `usage: Usage`
from line 3933
The number of input tokens used to create the 1 hour cache entry. + default: 0, minimum: 0 + - `ephemeral_5m_input_tokens: number` The number of input tokens used to create the 5 minute cache entry. + default: 0, minimum: 0 + - `cache_creation_input_tokens: number or null` The number of input tokens used to create the cache entry. + minimum: 0 + - `cache_read_input_tokens: number or null` The number of input tokens read from the cache. + minimum: 0 + - `inference_geo: string or null` The geographic region where inference was performed for this request.
from line 3961
The number of input tokens which were used. + minimum: 0 + - `output_tokens: number` The number of output tokens which were used. + + minimum: 0 - `output_tokens_details: OutputTokensDetails or null`
from line 3989
generation count by a small number of tokens. Always ≤ `output_tokens`; `output_tokens - thinking_tokens` approximates the non-reasoning output. + default: 0, minimum: 0 + - `server_tool_use: ServerToolUsage or null` The number of server tool requests.
from line 3999
The number of web fetch tool requests. + default: 0, minimum: 0 + - `web_search_requests: number` The number of web search tool requests. + default: 0, minimum: 0 + - `service_tier: "standard" or "priority" or "batch" or null` If the request used the priority, standard, or batch tier.
from line 4017
- `"batch"` -### Example - -```http +- `RawMessageStreamEvent = RawMessageStartEvent or RawMessageDeltaEvent or RawMessageStopEvent or 3 more` + + - `RawMessageStartEvent object` + + - `message: Message` + + - `type: "message_start"` + + default: message_start + + - `RawMessageDeltaEvent object` + + - `delta: object` + + - `container: Container or null` + + Information about the container used in the request (for the code execution tool) + + - `stop_details: RefusalStopDetails or null` + + Structured information about a refusal. + + - `stop_reason: StopReason or null` + + - `stop_sequence: string or null` + + - `type: "message_delta"` + + default: message_delta + + - `usage: MessageDeltaUsage` + + 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_input_tokens: number or null` + + The cumulative number of input tokens used to create the cache entry. + + minimum: 0 + + - `cache_read_input_tokens: number or null` + + The cumulative number of input tokens read from the cache. + + minimum: 0 + + - `input_tokens: number or null` + + The cumulative number of input tokens which were used. + + minimum: 0 + + - `output_tokens: number` + + The cumulative number of output tokens which were used. + + - `output_tokens_details: OutputTokensDetails or null` + + Breakdown of output tokens by category. + + `output_tokens` remains the inclusive, authoritative total used for billing. + This object provides a read-only decomposition for observability — for example, + how many of the billed output tokens were spent on internal reasoning that may + have been summarized before being returned to you. + + - `server_tool_use: ServerToolUsage or null` + + The number of server tool requests. + + - `RawMessageStopEvent object` + + - `type: "message_stop"` + + default: message_stop + + - `RawContentBlockStartEvent object` + + - `content_block: TextBlock or ThinkingBlock or RedactedThinkingBlock or 9 more` + + Response model for a file uploaded to the container. + + - `TextBlock object` + + - `ThinkingBlock object` + + - `RedactedThinkingBlock object` + + - `ToolUseBlock object` + + - `ServerToolUseBlock object` + + - `WebSearchToolResultBlock object` + + - `WebFetchToolResultBlock object` + + - `CodeExecutionToolResultBlock object` + + - `BashCodeExecutionToolResultBlock object` + + - `TextEditorCodeExecutionToolResultBlock object` + + - `ToolSearchToolResultBlock object` + + - `ContainerUploadBlock object` + + Response model for a file uploaded to the container. + + - `index: number` + + - `type: "content_block_start"` + + default: content_block_start + + - `RawContentBlockDeltaEvent object` + + - `delta: RawContentBlockDelta` + + - `TextDelta object` + + - `text: string` + + - `type: "text_delta"` + + default: text_delta + + - `InputJSONDelta object` + + - `partial_json: string` + + - `type: "input_json_delta"` + + default: input_json_delta + + - `CitationsDelta object` + + - `citation: CitationCharLocation or CitationPageLocation or CitationContentBlockLocation or 2 more` + + - `CitationCharLocation object` + + - `CitationPageLocation object` + + - `CitationContentBlockLocation object` + + - `CitationsWebSearchResultLocation object` + + - `CitationsSearchResultLocation object` + + - `type: "citations_delta"` + + default: citations_delta + + - `ThinkingDelta object` + + - `thinking: string` + + The incremental `thinking` text for this content block. Concatenate the `thinking` values of successive `thinking_delta` events to assemble the block's full `thinking` value. + + - `type: "thinking_delta"` + + default: thinking_delta + + - `SignatureDelta object` + + - `signature: string` + + The `signature` for this thinking block: an opaque value used to verify that the block was generated by Claude when it is passed back to the API. Delivered in a `signature_delta` event just before the block's `content_block_stop` event. + + - `type: "signature_delta"` + + default: signature_delta + + - `index: number` + + - `type: "content_block_delta"` + + default: content_block_delta + + - `RawContentBlockStopEvent object` + + - `index: number` + + - `type: "content_block_stop"` + + default: content_block_stop + +## Example + +```bash curl https://api.anthropic.com/v1/messages \ -H 'Content-Type: application/json' \ -H 'anthropic-version: 2023-06-01' \
from line 4258
}' ``` -#### Response +### Response (200) ```json {