Claude Platform Docs

Créer un message

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

Envoyez une liste structurée de messages d'entrée contenant du texte et/ou des images, et le modèle générera le message suivant de la conversation.

L'API Messages peut être utilisée aussi bien pour des requêtes uniques que pour des conversations multi-tours sans état.

Pour en savoir plus sur l'API Messages, consultez notre guide de l'utilisateur.

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<MessageParam> 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<ContentBlockParam>
One of the following:
class TextBlockParam { Type = "text"; Text; CacheControl; Citations; }
class ImageBlockParam { Type = "image"; Source; CacheControl; Transformations; }
class DocumentBlockParam { Type = "document"; Source; CacheControl; /* 3 more */ }
class SearchResultBlockParam { Type = "search_result"; Content; Source; /* 3 more */ }
class ThinkingBlockParam { 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 RedactedThinkingBlockParam { 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 ToolUseBlockParam { Type = "tool_use"; ID; Input; /* 4 more */ }
class ToolResultBlockParam { Type = "tool_result"; ToolUseID; CacheControl; /* 3 more */ }
class ServerToolUseBlockParam { Type = "server_tool_use"; ID; Input; /* 3 more */ }
class WebSearchToolResultBlockParam { Type = "web_search_tool_result"; Content; ToolUseID; /* 2 more */ }
class WebFetchToolResultBlockParam { Type = "web_fetch_tool_result"; Content; ToolUseID; /* 2 more */ }
class CodeExecutionToolResultBlockParam { 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_]+$
CacheControlEphemeral? 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 BashCodeExecutionToolResultBlockParam { Type = "bash_code_execution_tool_result"; Content; ToolUseID; CacheControl; }
class TextEditorCodeExecutionToolResultBlockParam { Type = "text_editor_code_execution_tool_result"; Content; ToolUseID; CacheControl; }
class ToolSearchToolResultBlockParam { Type = "tool_search_tool_result"; Content; ToolUseID; CacheControl; }
class ContainerUploadBlockParam { 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
CacheControlEphemeral? 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")
required Role Role
One of the following:
User("user")
Assistant("assistant")
System("system")
required Model model

Body param: The model that will complete your prompt.

See models for additional details and options.

CacheControlEphemeral? cacheControl

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

Body param: Container identifier for reuse across requests.

string? inferenceGeo

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

Metadata metadata

Body param: An object describing metadata about the request.

OutputConfig 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")
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<TextBlockParam>
JsonElement Type = "text"
required string Text
minLength1
CacheControlEphemeral? 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<TextCitationParam>? Citations
One of the following:
class CitationCharLocationParam { 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 CitationPageLocationParam { 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 CitationContentBlockLocationParam { 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 CitationWebSearchResultLocationParam { 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 CitationSearchResultLocationParam { 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.

ToolChoice 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<ToolUnion> 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 Tool { Type; InputSchema; Name; /* 7 more */ }
class ToolBash20250124 { Type = "bash_20250124"; Name; AllowedCallers; /* 4 more */ }
class CodeExecutionTool20250522 { Type = "code_execution_20250522"; Name; AllowedCallers; /* 3 more */ }
class CodeExecutionTool20250825 { Type = "code_execution_20250825"; Name; AllowedCallers; /* 3 more */ }
class CodeExecutionTool20260120 { Type = "code_execution_20260120"; Name; AllowedCallers; /* 3 more */ }

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

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

Code execution tool with REPL state persistence.

class BrowserToolset20260801 { 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"
CacheControlEphemeral? 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 MemoryTool20250818 { Type = "memory_20250818"; Name; AllowedCallers; /* 4 more */ }
class ComputerToolset20260801 { 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"
CacheControlEphemeral? 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 ToolTextEditor20250124 { Type = "text_editor_20250124"; Name; AllowedCallers; /* 4 more */ }
class ToolTextEditor20250429 { Type = "text_editor_20250429"; Name; AllowedCallers; /* 4 more */ }
class ToolTextEditor20250728 { Type = "text_editor_20250728"; Name; AllowedCallers; /* 5 more */ }
class WebSearchTool20250305 { Type = "web_search_20250305"; Name; AllowedCallers; /* 7 more */ }
class WebFetchTool20250910 { Type = "web_fetch_20250910"; Name; AllowedCallers; /* 9 more */ }
class WebSearchTool20260209 { Type = "web_search_20260209"; Name; AllowedCallers; /* 7 more */ }
class WebFetchTool20260209 { Type = "web_fetch_20260209"; Name; AllowedCallers; /* 9 more */ }
class WebFetchTool20260309 { Type = "web_fetch_20260309"; Name; AllowedCallers; /* 10 more */ }

Web fetch tool with use_cache parameter for bypassing cached content.

class WebSearchTool20260318 { Type = "web_search_20260318"; Name; AllowedCallers; /* 8 more */ }
class WebFetchTool20260318 { Type = "web_fetch_20260318"; Name; AllowedCallers; /* 11 more */ }
class ToolSearchToolBm25_20251119 { Type; Name; AllowedCallers; /* 3 more */ }
class ToolSearchToolRegex20251119 { Type; Name; AllowedCallers; /* 3 more */ }
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.

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 Message { Type = "message"; ID; Container; /* 7 more */ }
class RawMessageStreamEvent: union
Créer un message
MessageCreateParams parameters = new()
{
    MaxTokens = 1024,
    Messages =
    [
        new()
        {
            Content = "Hello, world",
            Role = Role.User,
        },
    ],
    Model = Model.ClaudeOpus5,
};

var message = await client.Messages.Create(parameters);

Console.WriteLine(message);
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"
    }
  ],
  "model": "claude-opus-5",
  "role": "assistant",
  "stop_details": {
    "category": "cyber",
    "explanation": "This request was declined because it conflicts with Anthropic's Usage Policy.",
    "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,
    "inference_geo": "global",
    "input_tokens": 2095,
    "output_tokens": 503,
    "output_tokens_details": {
      "thinking_tokens": 0
    },
    "server_tool_use": {
      "web_fetch_requests": 2,
      "web_search_requests": 0
    },
    "service_tier": "standard"
  }
}