--- title: "Create a Message Batch" method: POST path: "/v1/messages/batches" --- # Create a Message Batch `POST /v1/messages/batches` Send a batch of Message creation requests. The Message Batches API can be used to process multiple Messages API requests at once. Once a Message Batch is created, it begins processing immediately. Batches can take up to 24 hours to complete. Learn more about the Message Batches API in our [user guide](https://platform.claude.com/docs/en/build-with-claude/batch-processing) ## Headers - `anthropic-version` string — The version of the Claude API you want to use. Read more about versioning and our version history [here](https://platform.claude.com/docs/en/api/versioning). - `anthropic-user-profile-id` string — The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Requires the `user-profiles` beta header. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. ## Request body - CreateMessageBatchParams - `requests` MessageBatchIndividualRequestParams[], required — List of requests for prompt completion. Each is an individual request to create a Message. - `custom_id` string, required — Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order. Must be unique for each request within the Message Batch. - `params` CreateMessageParams, required - `model` union, required — The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/models-overview) for additional details and options. - string - 'claude-sonnet-5' — High-performance model for coding and agents - 'claude-fable-5' — Next generation of intelligence for the hardest knowledge work and coding problems - 'claude-mythos-5' — Most capable model for cybersecurity and biology research - 'claude-opus-5' — Powerful intelligence for long-running agents and coding - 'claude-opus-4-8' — Powerful intelligence for long-running agents and coding - 'claude-opus-4-7' — Powerful intelligence for long-running agents and coding - 'claude-mythos-preview' — New class of intelligence, strongest in coding and cybersecurity - 'claude-opus-4-6' — Powerful intelligence for long-running agents and coding - 'claude-sonnet-4-6' — Best combination of speed and intelligence - 'claude-haiku-4-5' — Fastest model with near-frontier intelligence - 'claude-haiku-4-5-20251001' — Fastest model with near-frontier intelligence - 'claude-opus-4-5' — Powerful intelligence for long-running agents and coding - 'claude-opus-4-5-20251101' — Powerful intelligence for long-running agents and coding - 'claude-sonnet-4-5' — High-performance model for agents and coding - 'claude-sonnet-4-5-20250929' — High-performance model for agents and coding - `messages` InputMessage[], required — Input messages. Our models are trained to operate on alternating `user` and `assistant` conversational turns. When creating a new `Message`, you specify the prior conversational turns with the `messages` parameter, and the model then generates the next `Message` in the conversation. Consecutive `user` or `assistant` turns in your request will be combined into a single turn. Each input message must be an object with a `role` and `content`. You can specify a single `user`-role message, or you can include multiple `user` and `assistant` messages. If the final message uses the `assistant` role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response. Example with a single `user` message: ```json [{"role": "user", "content": "Hello, Claude"}] ``` Example with multiple conversational turns: ```json [ {"role": "user", "content": "Hello there."}, {"role": "assistant", "content": "Hi, I'm Claude. How can I help you?"}, {"role": "user", "content": "Can you explain LLMs in plain English?"}, ] ``` Example with a partially-filled response from Claude: ```json [ {"role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"}, {"role": "assistant", "content": "The best answer is ("}, ] ``` Each input message `content` may be either a single `string` or an array of content blocks, where each block has a specific `type`. Using a `string` for `content` is shorthand for an array of one content block of type `"text"`. The following input messages are equivalent: ```json {"role": "user", "content": "Hello, Claude"} ``` ```json {"role": "user", "content": [{"type": "text", "text": "Hello, Claude"}]} ``` See [input examples](https://platform.claude.com/docs/en/build-with-claude/working-with-messages). Note that if you want to include a [system prompt](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role), you can use the top-level `system` parameter — there is no `"system"` role for input messages in the Messages API. There is a limit of 100,000 messages in a single request. - `content` union, required - string - InputContentBlock[] - union - … - `role` 'user' | 'assistant' | 'system', required - `cache_control` CacheControlEphemeral - `ttl` '5m' | '1h' — The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details. - `type` 'ephemeral', required - `container` string, nullable — Container identifier for reuse across requests. - `inference_geo` string, nullable — Specifies the geographic region for inference processing. If not specified, the workspace's `default_inference_geo` is used. - `max_tokens` integer, required — 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](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. - `metadata` Metadata - `user_id` string, nullable — An external identifier for the user who is associated with the request. This should be a uuid, hash value, or other opaque identifier. Anthropic may use this id to help detect abuse. Do not include any identifying information such as name, email address, or phone number. - `output_config` OutputConfig - `effort` 'low' | 'medium' | 'high' | 'xhigh' | 'max' — All possible effort levels. - `format` JsonOutputFormat - `schema` object, required — The JSON schema of the format - `type` 'json_schema', required - `service_tier` 'auto' | 'standard_only' — Determines whether to use priority capacity (if available) or standard capacity for this request. Anthropic offers different levels of service for your API requests. See [service-tiers](https://platform.claude.com/docs/en/api/service-tiers) for details. - `stop_sequences` string[] — Custom text sequences that will cause the model to stop generating. Our models will normally stop when they have naturally completed their turn, which will result in a response `stop_reason` of `"end_turn"`. If you want the model to stop generating when it encounters custom strings of text, you can use the `stop_sequences` parameter. If the model encounters one of the custom sequences, the response `stop_reason` value will be `"stop_sequence"` and the response `stop_sequence` value will contain the matched stop sequence. - `stream` boolean — Whether to incrementally stream the response using server-sent events. See [streaming](https://platform.claude.com/docs/en/build-with-claude/streaming) for details. - `system` union — System prompt. A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our [guide to system prompts](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/claude-prompting-best-practices#give-claude-a-role). - string - RequestTextBlock[] - `cache_control` CacheControlEphemeral - `ttl` '5m' | '1h' — The time-to-live for the cache control breakpoint. This may be one the following values: - `5m`: 5 minutes - `1h`: 1 hour Defaults to `5m`. See [prompt caching pricing](https://platform.claude.com/docs/en/build-with-claude/prompt-caching) for details. - `type` 'ephemeral', required - `citations` union[], nullable - union - … - `text` string, required - `type` 'text', required - `temperature` 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` union — Configuration for enabling Claude's extended thinking. When enabled, responses include `thinking` content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your `max_tokens` limit. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details. - ThinkingConfigEnabled - `budget_tokens` integer, required — Determines how many tokens Claude can use for its internal reasoning process. Larger budgets can enable more thorough analysis for complex problems, improving response quality. Must be ≥1024 and less than `max_tokens`. See [extended thinking](https://platform.claude.com/docs/en/build-with-claude/extended-thinking) for details. - `display` 'summarized' | 'omitted' - `type` 'enabled', required - ThinkingConfigDisabled - `type` 'disabled', required - ThinkingConfigAdaptive - `display` 'summarized' | 'omitted' - `type` 'adaptive', required - `tool_choice` union — 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 — The model will automatically decide whether to use tools. - `disable_parallel_tool_use` boolean — Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output at most one tool use. - `type` 'auto', required - ToolChoiceAny — The model will use any available tools. - `disable_parallel_tool_use` boolean — Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `type` 'any', required - ToolChoiceTool — The model will use the specified tool with `tool_choice.name`. - `disable_parallel_tool_use` boolean — Whether to disable parallel tool use. Defaults to `false`. If set to `true`, the model will output exactly one tool use. - `name` string, required — The name of the tool to use. - `type` 'tool', required - ToolChoiceNone — The model will not be allowed to use tools. - `type` 'none', required - `tools` union[] — Definitions of tools that the model may use. If you include `tools` in your API request, the model may return `tool_use` content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using `tool_result` content blocks. There are two types of tools: **client tools** and **server tools**. The behavior described below applies to client tools. For [server tools](https://platform.claude.com/docs/en/agents-and-tools/tool-use/server-tools), see their individual documentation as each has its own behavior (e.g., the [web search tool](https://platform.claude.com/docs/en/agents-and-tools/tool-use/web-search-tool)). Each tool definition includes: * `name`: Name of the tool. * `description`: Optional, but strongly-recommended description of the tool. * `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the tool `input` shape that the model will produce in `tool_use` output content blocks. For example, if you defined `tools` as: ```json [ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ] ``` And then asked the model "What's the S&P 500 at today?", the model might produce `tool_use` content blocks in the response like this: ```json [ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ] ``` You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an input, and return the following back to the model in a subsequent `user` message: ```json [ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ] ``` Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output. See our [guide](https://platform.claude.com/docs/en/agents-and-tools/tool-use/overview) for more details. - union - Tool - `type` 'custom', nullable - `description` string — Description of what this tool does. Tool descriptions should be as detailed as possible. The more information that the model has about what the tool is and how to use it, the better it will perform. You can use natural language descriptions to reinforce important aspects of the tool input JSON schema. - `name` string, required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `input_schema` InputSchema, required - … - `cache_control` CacheControlEphemeral - … - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `eager_input_streaming` boolean, nullable — Enable eager input streaming for this tool. When true, tool input parameters will be streamed incrementally as they are generated, and types will be inferred on-the-fly rather than buffering the full JSON output. When false, streaming is disabled for this tool even if the fine-grained-tool-streaming beta is active. When null (default), uses the default behavior based on beta headers. - `allowed_callers` AllowedCaller[] - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples` object[] - … - BashTool20250124 - `allowed_callers` AllowedCaller[] - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples` object[] - … - `name` 'bash', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'bash_20250124', required - CodeExecutionTool20250522 - `allowed_callers` AllowedCaller[] - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `name` 'code_execution', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'code_execution_20250522', required - CodeExecutionTool20250825 - `allowed_callers` AllowedCaller[] - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `name` 'code_execution', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'code_execution_20250825', required - CodeExecutionTool20260120 — Code execution tool with REPL state persistence (daemon mode + gVisor checkpoint). - `allowed_callers` AllowedCaller[] - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `name` 'code_execution', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'code_execution_20260120', required - CodeExecutionTool20260521 — Code execution tool with REPL state persistence. - `allowed_callers` AllowedCaller[] - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `name` 'code_execution', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'code_execution_20260521', required - MemoryTool20250818 - `allowed_callers` AllowedCaller[] - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples` object[] - … - `name` 'memory', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'memory_20250818', required - TextEditor20250124 - `allowed_callers` AllowedCaller[] - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples` object[] - … - `name` 'str_replace_editor', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'text_editor_20250124', required - TextEditor20250429 - `allowed_callers` AllowedCaller[] - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples` object[] - … - `name` 'str_replace_based_edit_tool', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'text_editor_20250429', required - TextEditor20250728 - `allowed_callers` AllowedCaller[] - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `input_examples` object[] - … - `max_characters` integer, nullable — Maximum number of characters to display when viewing a file. If not specified, defaults to displaying the full file. - `name` 'str_replace_based_edit_tool', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'text_editor_20250728', required - WebSearchTool20250305 - `allowed_callers` AllowedCaller[] - `allowed_domains` string[], nullable — If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains` string[], nullable — If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses` integer, nullable — Maximum number of times the tool can be used in the API request. - `name` 'web_search', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'web_search_20250305', required - `user_location` UserLocation - … - WebFetchTool20250910 - `allowed_callers` AllowedCaller[] - `allowed_domains` string[], nullable — List of domains to allow fetching from - `blocked_domains` string[], nullable — List of domains to block fetching from - `cache_control` CacheControlEphemeral - … - `citations` RequestCitationsConfig - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens` integer, nullable — Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses` integer, nullable — Maximum number of times the tool can be used in the API request. - `name` 'web_fetch', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'web_fetch_20250910', required - WebSearchTool20260209 - `allowed_callers` AllowedCaller[] - `allowed_domains` string[], nullable — If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains` string[], nullable — If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses` integer, nullable — Maximum number of times the tool can be used in the API request. - `name` 'web_search', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'web_search_20260209', required - `user_location` UserLocation - … - WebFetchTool20260209 - `allowed_callers` AllowedCaller[] - `allowed_domains` string[], nullable — List of domains to allow fetching from - `blocked_domains` string[], nullable — List of domains to block fetching from - `cache_control` CacheControlEphemeral - … - `citations` RequestCitationsConfig - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens` integer, nullable — Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses` integer, nullable — Maximum number of times the tool can be used in the API request. - `name` 'web_fetch', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'web_fetch_20260209', required - WebFetchTool20260309 — Web fetch tool with use_cache parameter for bypassing cached content. - `allowed_callers` AllowedCaller[] - `allowed_domains` string[], nullable — List of domains to allow fetching from - `blocked_domains` string[], nullable — List of domains to block fetching from - `cache_control` CacheControlEphemeral - … - `citations` RequestCitationsConfig - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens` integer, nullable — Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses` integer, nullable — Maximum number of times the tool can be used in the API request. - `name` 'web_fetch', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'web_fetch_20260309', required - `use_cache` boolean — 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 - `allowed_callers` AllowedCaller[] - `allowed_domains` string[], nullable — If provided, only these domains will be included in results. Cannot be used alongside `blocked_domains`. - `blocked_domains` string[], nullable — If provided, these domains will never appear in results. Cannot be used alongside `allowed_domains`. - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_uses` integer, nullable — Maximum number of times the tool can be used in the API request. - `name` 'web_search', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `response_inclusion` 'full' | '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. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'web_search_20260318', required - `user_location` UserLocation - … - WebFetchTool20260318 - `allowed_callers` AllowedCaller[] - `allowed_domains` string[], nullable — List of domains to allow fetching from - `blocked_domains` string[], nullable — List of domains to block fetching from - `cache_control` CacheControlEphemeral - … - `citations` RequestCitationsConfig - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `max_content_tokens` integer, nullable — Maximum number of tokens used by including web page text content in the context. The limit is approximate and does not apply to binary content such as PDFs. - `max_uses` integer, nullable — Maximum number of times the tool can be used in the API request. - `name` 'web_fetch', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `response_inclusion` 'full' | '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. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'web_fetch_20260318', required - `use_cache` boolean — 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. - ToolSearchToolBM2520251119 - `allowed_callers` AllowedCaller[] - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `name` 'tool_search_tool_bm25', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'tool_search_tool_bm25_20251119' | 'tool_search_tool_bm25', required - ToolSearchToolRegex20251119 - `allowed_callers` AllowedCaller[] - `cache_control` CacheControlEphemeral - … - `defer_loading` boolean — If true, tool will not be included in initial system prompt. Only loaded when returned via tool_reference from tool search. - `name` 'tool_search_tool_regex', required — Name of the tool. This is how the tool will be called by the model and in `tool_use` blocks. - `strict` boolean — When true, guarantees schema validation on tool names and inputs - `type` 'tool_search_tool_regex_20251119' | 'tool_search_tool_regex', required - `top_k` integer — 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. - `top_p` number — Use nucleus sampling. In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by `top_p`. Recommended for advanced use cases only. ## Response `200` Successful Response - MessageBatch - `archived_at` string, date-time, nullable, required — RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `cancel_initiated_at` string, date-time, nullable, required — RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `created_at` string, date-time, required — RFC 3339 datetime string representing the time at which the Message Batch was created. - `ended_at` string, date-time, nullable, required — RFC 3339 datetime string representing the time at which processing for the Message Batch ended. Specified only once processing ends. Processing ends when every request in a Message Batch has either succeeded, errored, canceled, or expired. - `expires_at` string, date-time, required — RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `id` string, required — Unique object identifier. The format and length of IDs may change over time. - `processing_status` 'in_progress' | 'canceling' | 'ended', required — Processing status of the Message Batch. - `request_counts` RequestCounts, required - `canceled` integer, required — Number of requests in the Message Batch that have been canceled. This is zero until processing of the entire Message Batch has ended. - `errored` integer, required — Number of requests in the Message Batch that encountered an error. This is zero until processing of the entire Message Batch has ended. - `expired` integer, required — Number of requests in the Message Batch that have expired. This is zero until processing of the entire Message Batch has ended. - `processing` integer, required — Number of requests in the Message Batch that are processing. - `succeeded` integer, required — Number of requests in the Message Batch that have completed successfully. This is zero until processing of the entire Message Batch has ended. - `results_url` string, nullable, required — URL to a `.jsonl` file containing the results of the Message Batch requests. Specified only once processing ends. Results in the file are not guaranteed to be in the same order as requests. Use the `custom_id` field to match results to requests. - `type` 'message_batch', required — Object type. For Message Batches, this is always `"message_batch"`. ## Other responses - `4XX` — Error response. See our [errors documentation](https://platform.claude.com/docs/en/api/errors) for more details. --- [API](https://skmtc.net/anthropics/apis/anthropic-api.md) · [All operations](https://skmtc.net/anthropics/apis/anthropic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/anthropics/anthropic-api/versions/93d8fd7d6493/schema)