Claude Platform Docs

建立訊息

BetaMessage Beta.Messages.Create(parameters, cancellationToken = default)
POST/v1/messages

傳送包含文字和/或圖片內容的結構化輸入訊息清單,模型將產生對話中的下一則訊息。

Messages API 可用於單次查詢或無狀態的多輪對話。

在我們的使用者指南中進一步瞭解 Messages API

Parameters
MessageCreateParams parameters
required long maxTokens

Body param: The maximum number of tokens to generate before stopping.

Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.

Set to 0 to populate the prompt cache without generating a response.

Different models have different maximum values for this parameter. See models for details.

minimum0
required IReadOnlyList<BetaMessageParam> messages

Body param: Input messages.

Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn.

Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages.

If the final message uses the assistant role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response.

Example with a single user message:

[{"role": "user", "content": "Hello, Claude"}]

Example with multiple conversational turns:

[
  {"role": "user", "content": "Hello there."},
  {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"},
  {"role": "user", "content": "Can you explain LLMs in plain English?"},
]

Example with a partially-filled response from Claude:

[
  {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"},
  {"role": "assistant", "content": "The best answer is ("},
]

Each input message content may be either a single string or an array of content blocks, where each block has a specific type. Using a string for content is shorthand for an array of one content block of type "text". The following input messages are equivalent:

{"role": "user", "content": "Hello, Claude"}
{"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]}

See input examples.

Note that if you want to include a system prompt, you can use the top-level system parameter — there is no "system" role for input messages in the Messages API.

There is a limit of 100,000 messages in a single request.

required Content Content
One of the following:
string
IReadOnlyList<BetaContentBlockParam>
One of the following:
class BetaTextBlockParam { Type = "text"; Text; CacheControl; Citations; }
class BetaImageBlockParam { Type = "image"; Source; CacheControl; Transformations; }
class BetaRequestDocumentBlock { Type = "document"; Source; CacheControl; /* 3 more */ }
class BetaSearchResultBlockParam { Type = "search_result"; Content; Source; /* 3 more */ }
class BetaThinkingBlockParam { Type = "thinking"; Signature; Thinking; }
JsonElement Type = "thinking"
required string Signature

The signature value of this thinking block, exactly as returned by the API in a previous response. Used to verify that the block was generated by Claude.

Thinking blocks must be passed back unmodified and in their original order; a modified block results in a 400 invalid_request_error.

required string Thinking

The thinking text of this block as returned by the API.

class BetaRedactedThinkingBlockParam { Type = "redacted_thinking"; Data; }
JsonElement Type = "redacted_thinking"
required string Data

The data value of this redacted thinking block, exactly as returned by the API in a previous response. Opaque and encrypted; pass it back unchanged.

class BetaToolUseBlockParam { Type = "tool_use"; ID; Input; /* 4 more */ }
class BetaToolResultBlockParam { Type = "tool_result"; ToolUseID; CacheControl; /* 3 more */ }
class BetaServerToolUseBlockParam { Type = "server_tool_use"; ID; Input; /* 3 more */ }
class BetaWebSearchToolResultBlockParam { Type = "web_search_tool_result"; Content; ToolUseID; /* 2 more */ }
class BetaWebFetchToolResultBlockParam { Type = "web_fetch_tool_result"; Content; ToolUseID; /* 2 more */ }
class BetaAdvisorToolResultBlockParam { Type = "advisor_tool_result"; Content; ToolUseID; CacheControl; }
class BetaCodeExecutionToolResultBlockParam { Type = "code_execution_tool_result"; Content; ToolUseID; CacheControl; }
JsonElement Type = "code_execution_tool_result"
One of the following:
required string ToolUseID
pattern^srvtoolu_[a-zA-Z0-9_]+$
BetaCacheControlEphemeral? CacheControl

Create a cache control breakpoint at this content block.

JsonElement Type = "ephemeral"
Ttl Ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
Ttl5m("5m")
Ttl1h("1h")
class BetaBashCodeExecutionToolResultBlockParam { Type = "bash_code_execution_tool_result"; Content; ToolUseID; CacheControl; }
class BetaTextEditorCodeExecutionToolResultBlockParam { Type = "text_editor_code_execution_tool_result"; Content; ToolUseID; CacheControl; }
class BetaToolSearchToolResultBlockParam { Type = "tool_search_tool_result"; Content; ToolUseID; CacheControl; }
class BetaMcpToolUseBlockParam { Type = "mcp_tool_use"; ID; Input; /* 3 more */ }
JsonElement Type = "mcp_tool_use"
required string ID
pattern^[a-zA-Z0-9_-]+$
required IReadOnlyDictionary<string, JsonElement> Input
required string Name
required string ServerName

The name of the MCP server

BetaCacheControlEphemeral? CacheControl

Create a cache control breakpoint at this content block.

JsonElement Type = "ephemeral"
Ttl Ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
Ttl5m("5m")
Ttl1h("1h")
class BetaRequestMcpToolResultBlockParam { Type = "mcp_tool_result"; ToolUseID; CacheControl; /* 2 more */ }
class BetaContainerUploadBlockParam { Type = "container_upload"; FileID; CacheControl; }

A content block that represents a file to be uploaded to the container Files uploaded via this block will be available in the container's input directory.

JsonElement Type = "container_upload"
required string FileID
BetaCacheControlEphemeral? CacheControl

Create a cache control breakpoint at this content block.

JsonElement Type = "ephemeral"
Ttl Ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
Ttl5m("5m")
Ttl1h("1h")
class BetaCompactionBlockParam { Type = "compaction"; CacheControl; Content; /* 2 more */ }

A compaction block containing summary of previous context.

Users should round-trip these blocks from responses to subsequent requests to maintain context across compaction boundaries.

When content is None, the block represents a failed compaction. The server treats these as no-ops. Empty string content is not allowed.

JsonElement Type = "compaction"
BetaCacheControlEphemeral? CacheControl

Create a cache control breakpoint at this content block.

JsonElement Type = "ephemeral"
Ttl Ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
Ttl5m("5m")
Ttl1h("1h")
string? Content

Summary of previously compacted content, or null if compaction failed

string? EncryptedContent

Opaque metadata from prior compaction, to be round-tripped verbatim

string? Signature

The block's signature as returned, to be sent back verbatim

class BetaRequestToolAdditionBlock { Type = "tool_addition"; Tool; CacheControl; }

Mid-conversation directive to surface a declared tool.

tool references a tool (or MCP toolset) by name from the request's tools; it is offered to the model from this point in the conversation onward.

class BetaRequestToolRemovalBlock { Type = "tool_removal"; Tool; CacheControl; }

Mid-conversation directive to withdraw a tool.

tool references a tool (or MCP toolset) by name from the request's tools; it is no longer offered to the model from this point in the conversation onward.

class BetaFallbackBlockParam { Type = "fallback"; From; To; Trigger; }

A fallback block echoed back from a prior response.

Accepted in messages[].content and not rendered into the prompt; not validated against the request's fallbacks chain or top-level model.

Echo the assistant turn back verbatim, including this block in its original position. The block marks the boundary between content produced before and after a fallback hop, and the server relies on that boundary to validate the turn: when thinking runs flank the boundary, omitting the block merges them into one span the server cannot validate (the request is rejected), and moving it into the middle of a single run is likewise rejected; between non-thinking blocks the block's placement has no validation effect.

JsonElement Type = "fallback"
required BetaFallbackInfoParam From

Identifies one hop of a fallback transition.

required Model Model

The model that will complete your prompt.

See models for additional details and options.

One of the following:
required BetaFallbackInfoParam To

Identifies one hop of a fallback transition.

required Model Model

The model that will complete your prompt.

See models for additional details and options.

One of the following:
JsonElement Trigger

The response block's trigger, echoed verbatim. Accepted and ignored by the server; any object or null is allowed.

required Role Role
One of the following:
User("user")
Assistant("assistant")
System("system")
ClearAt? ClearAt

How long this system message's text stays in front of the model. "never" (the default) renders it on every request that includes it. "next_user_message" renders it only for the user turn it follows: once a later role: "user" message exists in messages the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on role: "system" messages.

One of the following:
NextUserMessage("next_user_message")
Never("never")

Per-message output configuration on a role:"system" input message.

Fields here apply per-turn; format remains top-level only. An empty {} is accepted on a message that carries content; a message with neither content nor output_config fields is rejected.

Effort? Effort

All possible effort levels.

One of the following:
Low("low")
Medium("medium")
High("high")
Xhigh("xhigh")
Max("max")
required Model model

Body param: The model that will complete your prompt.

See models for additional details and options.

BetaCacheControlEphemeral? cacheControl

Body param: Top-level cache control automatically applies a cache_control marker to the last cacheable block in the request.

BetaCompactionConfig? compaction

Body param: Compact the whole conversation and return a signed compaction block, alone, that a later request sends back first in messages, in place of the messages it summarizes. There is no trigger and no pause flag: sending the parameter compacts, and nothing is sampled after the block.

The summarization prompt is the server's own unless instructions are given, which then replace it for this request; a value that is empty or only whitespace counts as absent.

Container? container

Body param: Container identifier for reuse across requests.

class BetaContainerParams { ID; Skills; }

Container parameters with skills to be loaded.

string? ID

Container id

IReadOnlyList<BetaSkillParams>? Skills

List of skills to load in the container

maxItems20
required Type Type

Type of skill - either 'anthropic' (built-in) or 'custom' (user-defined)

One of the following:
Anthropic("anthropic")
Custom("custom")
required string SkillID

Skill ID

maxLength64
minLength1
string Version

Skill version or 'latest' for most recent version

maxLength64
minLength1
string
BetaContextManagementConfig? contextManagement

Body param: Context management configuration.

This allows you to control how Claude manages context across multiple requests, such as whether to clear function results or not.

BetaDiagnosticsParam? diagnostics

Body param: Request-level diagnostics. Currently carries the previous response id for prompt-cache divergence reporting.

FallbackCreditToken? fallbackCreditToken

Body param: The fallback_credit_token from a prior refusal's stop_details.

When a preceding request was refused and returned a fallback_credit_token, pass that code here on the retry to have the retry's cache-creation tokens for the prefix that was warm on the refused model billed at the cache-read rate. Must be redeemed by the same organization and workspace, with the same request body (optionally extended by one appended assistant message whose content is the partial text — with any trailing whitespace stripped from the final text block — and paired server-tool blocks streamed before the refusal; the appended-assistant form is not available for requests with output_format set or forced tool_choice), on an eligible fallback model, on the same platform, and within 5 minutes of the refusal; a mismatch is a 400. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed with the appended-assistant form — if an exact-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry with the appended-assistant form instead.

When the appended-assistant form is used on a model that otherwise disallows assistant-turn prefill, this token also authorizes that one prefill.

string
class BetaFallbackCreditTokenParam { Token; Mode; }

Object form of fallback_credit_token: the token plus a redemption mode.

Requires anthropic-beta: fallback-credit-2026-07-01; without that header the field accepts the bare string only. The bare string and the mode-less object are equivalent (both select strict), so wrapping an existing token changes nothing by itself.

required string Token

The opaque fallback_credit_token from a prior refusal's stop_details — the same string the bare-string form carries.

maxLength2048
minLength1
Mode Mode

How a failing token affects the retry. strict (the default, and the bare-string behavior): a failing redemption is a 400 and the retry is not served. best_effort: the retry is served either way — a token-layer failure no longer rejects the request; the retry proceeds at normal price and the outcome is reported on the response's usage.fallback_credit. Two failures stay hard in both modes: a malformed token, and combining fallback_credit_token with fallbacks.

One of the following:
Strict("strict")
BestEffort("best_effort")
BetaFallbacksParam? fallbacks

Body param: Opt-in server-side retry on one or more substitute models when the requested model declines for policy reasons. Tried in order: if the first entry also declines, the second is tried, and so on. The string "default" requests the requested model's server-defined default fallback configuration.

string? inferenceGeo

Body param: Specifies the geographic region for inference processing. If not specified, the workspace's default_inference_geo is used.

IReadOnlyList<BetaRequestMcpServerUrlDefinition> mcpServers

Body param: MCP servers to be utilized in this request

maxItems20
JsonElement Type = "url"
required string Name
required string Url
string? AuthorizationToken
IReadOnlyList<string>? AllowedTools
bool? Enabled
BetaMetadata metadata

Body param: An object describing metadata about the request.

BetaOutputConfig outputConfig

Body param: Configuration options for the model's output, such as the output format.

ServiceTier serviceTier

Body param: Determines whether to use priority capacity (if available) or standard capacity for this request.

Anthropic offers different levels of service for your API requests. See service-tiers for details.

Auto("auto")
StandardOnly("standard_only")
Speed? speed

Body param: Inference speed mode. fast provides significantly faster output token generation at premium pricing. Not all models support fast; invalid combinations are rejected at create time.

Standard("standard")
Fast("fast")
IReadOnlyList<string> stopSequences

Body param: Custom text sequences that will cause the model to stop generating.

Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of "end_turn".

If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be "stop_sequence" and the response stop_sequence value will contain the matched stop sequence.

System system

Body param: System prompt.

A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.

string
IReadOnlyList<BetaTextBlockParam>
JsonElement Type = "text"
required string Text
minLength1
BetaCacheControlEphemeral? CacheControl

Create a cache control breakpoint at this content block.

JsonElement Type = "ephemeral"
Ttl Ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
Ttl5m("5m")
Ttl1h("1h")
IReadOnlyList<BetaTextCitationParam>? Citations
One of the following:
class BetaCitationCharLocationParam { Type = "char_location"; CitedText; DocumentIndex; /* 3 more */ }
JsonElement Type = "char_location"
required string CitedText
required long DocumentIndex
minimum0
required string? DocumentTitle
maxLength500
minLength1
required long EndCharIndex
required long StartCharIndex
minimum0
class BetaCitationPageLocationParam { Type = "page_location"; CitedText; DocumentIndex; /* 3 more */ }
JsonElement Type = "page_location"
required string CitedText
required long DocumentIndex
minimum0
required string? DocumentTitle
maxLength500
minLength1
required long EndPageNumber
required long StartPageNumber
minimum1
class BetaCitationContentBlockLocationParam { Type = "content_block_location"; CitedText; DocumentIndex; /* 3 more */ }
JsonElement Type = "content_block_location"
required string CitedText

The full text of the cited block range, concatenated.

Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

required long DocumentIndex
minimum0
required string? DocumentTitle
maxLength500
minLength1
required long EndBlockIndex

Exclusive 0-based end index of the cited block range in the source's content array.

Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.

required long StartBlockIndex

0-based index of the first cited block in the source's content array.

minimum0
class BetaCitationWebSearchResultLocationParam { Type = "web_search_result_location"; CitedText; EncryptedIndex; /* 2 more */ }
JsonElement Type = "web_search_result_location"
required string CitedText
required string EncryptedIndex
required string? Title
maxLength512
minLength1
required string Url
minLength1
class BetaCitationSearchResultLocationParam { Type = "search_result_location"; CitedText; EndBlockIndex; /* 4 more */ }
JsonElement Type = "search_result_location"
required string CitedText

The full text of the cited block range, concatenated.

Always equals the contents of content[start_block_index:end_block_index] joined together. The text block is the minimal citable unit; this field is never a substring of a single block. Not counted toward output tokens, and not counted toward input tokens when sent back in subsequent turns.

required long EndBlockIndex

Exclusive 0-based end index of the cited block range in the source's content array.

Always greater than start_block_index; a single-block citation has end_block_index = start_block_index + 1.

required long SearchResultIndex

0-based index of the cited search result among all search_result content blocks in the request, in the order they appear across messages and tool results.

Counted separately from document_index; server-side web search results are not included in this count.

minimum0
required string Source
required long StartBlockIndex

0-based index of the first cited block in the source's content array.

minimum0
required string? Title

Body param: Configuration for enabling Claude's extended thinking.

When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.

See extended thinking for details.

BetaToolChoice toolChoice

Body param: How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.

IReadOnlyList<BetaToolUnion> tools

Body param: Definitions of tools that the model may use.

If you include tools in your API request, the model may return tool_use content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks.

There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool).

Each tool definition includes:

  • name: Name of the tool.
  • description: Optional, but strongly-recommended description of the tool.
  • input_schema: JSON schema for the tool input shape that the model will produce in tool_use output content blocks.

For example, if you defined tools as:

[
  {
    "name": "get_stock_price",
    "description": "Get the current stock price for a given ticker symbol.",
    "input_schema": {
      "type": "object",
      "properties": {
        "ticker": {
          "type": "string",
          "description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
        }
      },
      "required": ["ticker"]
    }
  }
]

And then asked the model "What's the S&P 500 at today?", the model might produce tool_use content blocks in the response like this:

[
  {
    "type": "tool_use",
    "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
    "name": "get_stock_price",
    "input": { "ticker": "^GSPC" }
  }
]

You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:

[
  {
    "type": "tool_result",
    "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
    "content": "259.75 USD"
  }
]

Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.

See our guide for more details.

class BetaTool { Type; InputSchema; Name; /* 7 more */ }
class BetaToolBash20241022 { Type = "bash_20241022"; Name; AllowedCallers; /* 4 more */ }
class BetaToolBash20250124 { Type = "bash_20250124"; Name; AllowedCallers; /* 4 more */ }
class BetaCodeExecutionTool20250522 { Type = "code_execution_20250522"; Name; AllowedCallers; /* 3 more */ }
class BetaCodeExecutionTool20250825 { Type = "code_execution_20250825"; Name; AllowedCallers; /* 3 more */ }
class BetaCodeExecutionTool20260120 { Type = "code_execution_20260120"; Name; AllowedCallers; /* 3 more */ }

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

class BetaCodeExecutionTool20260521 { Type = "code_execution_20260521"; Name; AllowedCallers; /* 3 more */ }

Code execution tool with REPL state persistence.

class BetaBrowserToolset20260801 { Type = "browser_toolset_20260801"; CacheControl; Configs; }

The browser toolset: a single tools[] entry (carrying no name) that declares the browser tool family. The model is served the family's tool with any members disabled via configs removed from its schema.

JsonElement Type = "browser_toolset_20260801"
BetaCacheControlEphemeral? CacheControl

Create a cache control breakpoint at this content block.

JsonElement Type = "ephemeral"
Ttl Ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
Ttl5m("5m")
Ttl1h("1h")

Per-member configuration for browser_toolset_20260801: one optional field per member tool, keyed by the member name — the same name the member's tool_use blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set.

class BetaToolComputerUse20241022 { Type = "computer_20241022"; DisplayHeightPx; DisplayWidthPx; /* 7 more */ }
class BetaMemoryTool20250818 { Type = "memory_20250818"; Name; AllowedCallers; /* 4 more */ }
class BetaToolComputerUse20250124 { Type = "computer_20250124"; DisplayHeightPx; DisplayWidthPx; /* 7 more */ }
class BetaToolTextEditor20241022 { Type = "text_editor_20241022"; Name; AllowedCallers; /* 4 more */ }
class BetaToolComputerUse20251124 { Type = "computer_20251124"; DisplayHeightPx; DisplayWidthPx; /* 8 more */ }
class BetaComputerToolset20260801 { Type = "computer_toolset_20260801"; CacheControl; Configs; }

The computer toolset: a single tools[] entry (carrying no name) that declares the computer tool family. The model is served the family's tool with any members disabled via configs removed from its schema. Every member is enabled by default, zoom included. The single-tool options display_number and enable_zoom are not fields of a toolset entry — it carries only type, configs, and cache_control; zoom is controlled via configs.zoom.enabled.

JsonElement Type = "computer_toolset_20260801"
BetaCacheControlEphemeral? CacheControl

Create a cache control breakpoint at this content block.

JsonElement Type = "ephemeral"
Ttl Ttl

The time-to-live for the cache control breakpoint.

This may be one the following values:

  • 5m: 5 minutes
  • 1h: 1 hour

Defaults to 5m. See prompt caching pricing for details.

One of the following:
Ttl5m("5m")
Ttl1h("1h")

Per-member configuration for computer_toolset_20260801: one optional field per member tool, keyed by the member name — the same name the member's tool_use blocks carry. Every member is an accepted key, and a member's defaults apply wherever its key is absent. Unknown keys are rejected: the field set is this toolset version's complete member set.

class BetaToolTextEditor20250124 { Type = "text_editor_20250124"; Name; AllowedCallers; /* 4 more */ }
class BetaToolTextEditor20250429 { Type = "text_editor_20250429"; Name; AllowedCallers; /* 4 more */ }
class BetaToolTextEditor20250728 { Type = "text_editor_20250728"; Name; AllowedCallers; /* 5 more */ }
class BetaWebSearchTool20250305 { Type = "web_search_20250305"; Name; AllowedCallers; /* 7 more */ }
class BetaWebFetchTool20250910 { Type = "web_fetch_20250910"; Name; AllowedCallers; /* 9 more */ }
class BetaWebSearchTool20260209 { Type = "web_search_20260209"; Name; AllowedCallers; /* 7 more */ }
class BetaWebFetchTool20260209 { Type = "web_fetch_20260209"; Name; AllowedCallers; /* 9 more */ }
class BetaWebFetchTool20260309 { Type = "web_fetch_20260309"; Name; AllowedCallers; /* 10 more */ }

Web fetch tool with use_cache parameter for bypassing cached content.

class BetaWebSearchTool20260318 { Type = "web_search_20260318"; Name; AllowedCallers; /* 8 more */ }
class BetaWebFetchTool20260318 { Type = "web_fetch_20260318"; Name; AllowedCallers; /* 11 more */ }
class BetaAdvisorTool20260301 { Type = "advisor_20260301"; Model; Name; /* 7 more */ }
class BetaToolSearchToolBm25_20251119 { Type; Name; AllowedCallers; /* 3 more */ }
class BetaToolSearchToolRegex20251119 { Type; Name; AllowedCallers; /* 3 more */ }
class BetaMcpToolset { Type = "mcp_toolset"; McpServerName; CacheControl; /* 2 more */ }

Configuration for a group of tools from an MCP server.

Allows configuring enabled status and defer_loading for all tools from an MCP server, with optional per-tool overrides.

IReadOnlyList<AnthropicBeta> betas

Header param: Optional header to specify the beta version(s) you want to use.

MessageBatches2024_09_24("message-batches-2024-09-24")
PromptCaching2024_07_31("prompt-caching-2024-07-31")
ComputerUse2024_10_22("computer-use-2024-10-22")
ComputerUse2025_01_24("computer-use-2025-01-24")
Pdfs2024_09_25("pdfs-2024-09-25")
TokenCounting2024_11_01("token-counting-2024-11-01")
TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")
Output128k2025_02_19("output-128k-2025-02-19")
FilesApi2025_04_14("files-api-2025-04-14")
McpClient2025_04_04("mcp-client-2025-04-04")
McpClient2025_11_20("mcp-client-2025-11-20")
DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")
InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")
CodeExecution2025_05_22("code-execution-2025-05-22")
ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")
Context1m2025_08_07("context-1m-2025-08-07")
ContextManagement2025_06_27("context-management-2025-06-27")
ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")
Skills2025_10_02("skills-2025-10-02")
FastMode2026_02_01("fast-mode-2026-02-01")
Output300k2026_03_24("output-300k-2026-03-24")
UserProfiles2026_03_24("user-profiles-2026-03-24")
UserProfiles2026_08_18("user-profiles-2026-08-18")
UserProfiles2026_09_04("user-profiles-2026-09-04")
AdvisorTool2026_03_01("advisor-tool-2026-03-01")
ManagedAgents2026_04_01("managed-agents-2026-04-01")
CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")
Dreaming2026_04_21("dreaming-2026-04-21")
ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")
ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")
ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")
FallbackCredit2026_06_01("fallback-credit-2026-06-01")
FallbackCredit2026_07_01("fallback-credit-2026-07-01")
AgentMemory2026_07_22("agent-memory-2026-07-22")
MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")
Compact2026_01_12("compact-2026-01-12")
ComputerUse2025_11_24("computer-use-2025-11-24")
McpTunnels2026_06_22("mcp-tunnels-2026-06-22")
StructuredOutputs2025_11_13("structured-outputs-2025-11-13")
TaskBudgets2026_03_13("task-budgets-2026-03-13")
ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")
CEUserManagement2026_07_13("ce-user-management-2026-07-13")
MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")
ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")
MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")
Compact2026_09_04("compact-2026-09-04")
string userProfileID

Header param: 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.

string workspaceID

Header param: Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

BetaJsonOutputFormat? outputFormatDeprecated

Body param: Deprecated: Use output_config.format instead. See structured outputs

A schema to specify Claude's output format in responses. This parameter will be removed in a future release.

double temperatureDeprecated

Body param: Amount of randomness injected into the response.

Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 will be accepted for backwards compatibility, all other values will be rejected with a 400 error.

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.

maximum1
minimum0
long topKDeprecated

Body param: Only sample from the top K options for each subsequent token.

Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error.

Used to remove "long tail" low probability responses. Learn more technical details here.

Recommended for advanced use cases only.

minimum0
double topPDeprecated

Body param: Use nucleus sampling.

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.

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.

maximum1
minimum0
Returns
class BetaMessage { Type = "message"; ID; Container; /* 10 more */ }
class BetaRawMessageStreamEvent: union
建立訊息
MessageCreateParams parameters = new()
{
    MaxTokens = 1024,
    Messages =
    [
        new()
        {
            Content = "Hello, world",
            Role = Role.User,
            ClearAt = ClearAt.NextUserMessage,
            OutputConfig = new() { Effort = Effort.Low },
        },
    ],
    Model = Model.ClaudeOpus5,
};

var betaMessage = await client.Beta.Messages.Create(parameters);

Console.WriteLine(betaMessage);
Returns Examples
Response 200
{
  "id": "msg_013Zva2CMHLNnXjNJJKqJ2EF",
  "container": {
    "id": "container_011CpZohnwH4vuy7gazohgSP",
    "expires_at": "2019-12-27T18:11:19.117Z",
    "skills": [
      {
        "skill_id": "pdf",
        "type": "anthropic",
        "version": "latest"
      }
    ]
  },
  "content": [
    {
      "citations": [
        {
          "cited_text": "The grass is green. The sky is blue.",
          "document_index": 0,
          "document_title": "My Document",
          "end_char_index": 0,
          "file_id": "file_011CNha8iCJcU1wXNR6q4V8w",
          "start_char_index": 0,
          "type": "char_location"
        }
      ],
      "text": "Hi! My name is Claude.",
      "type": "text"
    }
  ],
  "context_management": {
    "applied_edits": [
      {
        "cleared_input_tokens": 0,
        "cleared_tool_uses": 0,
        "type": "clear_tool_uses_20250919"
      }
    ]
  },
  "diagnostics": {
    "cache_miss_reason": {
      "cache_missed_input_tokens": 0,
      "type": "model_changed"
    }
  },
  "model": "claude-opus-5",
  "role": "assistant",
  "stop_details": {
    "category": "cyber",
    "explanation": "This request was declined because it conflicts with Anthropic's Usage Policy.",
    "fallback_credit_token": "QW50aHJvcGljL0NsYXVkZQ==",
    "fallback_has_prefill_claim": true,
    "recommended_model": "claude-opus-4-8",
    "type": "refusal"
  },
  "stop_reason": "end_turn",
  "stop_sequence": null,
  "type": "message",
  "usage": {
    "cache_creation": {
      "ephemeral_1h_input_tokens": 0,
      "ephemeral_5m_input_tokens": 0
    },
    "cache_creation_input_tokens": 2051,
    "cache_read_input_tokens": 2051,
    "fallback_credit": {
      "status": {
        "type": "redeemed"
      }
    },
    "inference_geo": "global",
    "input_tokens": 2095,
    "iterations": [
      {
        "cache_creation": {
          "ephemeral_1h_input_tokens": 0,
          "ephemeral_5m_input_tokens": 0
        },
        "cache_creation_input_tokens": 0,
        "cache_read_input_tokens": 0,
        "input_tokens": 0,
        "model": "claude-fable-5-1",
        "output_tokens": 0,
        "type": "message"
      }
    ],
    "output_tokens": 503,
    "output_tokens_details": {
      "thinking_tokens": 0
    },
    "server_tool_use": {
      "web_fetch_requests": 2,
      "web_search_requests": 0
    },
    "service_tier": "standard",
    "speed": "standard"
  },
  "input_transformations": [
    {
      "path": "path",
      "reason": "model_binding_mismatch",
      "type": "thinking_dropped"
    }
  ]
}