--- title: Create a Message Batch url: https://platform.claude.com/docs/en/api/php/beta/messages/batches/create --- # Create a Message Batch `$client->beta->messages->batches->create(list requests, ?list betas, ?string userProfileID, ?string workspaceID): MessageBatch` **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?sdk_languages=php) ## Parameters - `requests: list` List of requests for prompt completion. Each is an individual request to create a Message. - `betas?: optional list` (header parameter) Optional header to specify the beta version(s) you want to use. - `userProfileID?: optional string` (header parameter) The user profile ID to attribute the requests in this batch to. Use when acting on behalf of a party other than your organization. Applies to every request in the batch; an individual request whose `user_profile_id` body field conflicts with this header is errored. - `workspaceID?: optional string` (header parameter) 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. ## Returns - `class MessageBatch` - `"message_batch" type` Object type. For Message Batches, this is always `"message_batch"`. - `string id` Unique object identifier. The format and length of IDs may change over time. - `?\Datetime archivedAt` RFC 3339 datetime string representing the time at which the Message Batch was archived and its results became unavailable. - `?\Datetime cancelInitiatedAt` RFC 3339 datetime string representing the time at which cancellation was initiated for the Message Batch. Specified only if cancellation was initiated. - `\Datetime createdAt` RFC 3339 datetime string representing the time at which the Message Batch was created. - `?\Datetime endedAt` 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. - `\Datetime expiresAt` RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation. - `ProcessingStatus processingStatus` Processing status of the Message Batch. - `MessageBatchRequestCounts requestCounts` Tallies requests within the Message Batch, categorized by their status. Requests start as `processing` and move to one of the other statuses only once processing of the entire batch ends. The sum of all values always matches the total number of requests in the batch. - `?string resultsURL` 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. ## Example ```php beta->messages->batches->create( requests: [ [ 'customID' => 'my-custom-id-1', 'params' => [ 'maxTokens' => 1024, 'messages' => [['content' => 'Hello, world', 'role' => 'user']], 'model' => Model::CLAUDE_OPUS_5_5, 'cacheControl' => ['type' => 'ephemeral', 'ttl' => '5m'], 'compaction' => [ 'type' => 'summarize', 'instructions' => 'instructions' ], 'container' => [ 'id' => 'id', 'skills' => [ ['skillID' => 'pdf', 'type' => 'anthropic', 'version' => 'latest'] ], ], 'contextManagement' => [ 'edits' => [ [ 'type' => 'clear_tool_uses_20250919', 'clearAtLeast' => ['type' => 'input_tokens', 'value' => 0], 'clearToolInputs' => true, 'excludeTools' => ['string'], 'keep' => ['type' => 'tool_uses', 'value' => 0], 'trigger' => ['type' => 'input_tokens', 'value' => 1], ], ], ], 'diagnostics' => ['previousMessageID' => 'previous_message_id'], 'fallbackCreditToken' => 'x', 'fallbacks' => 'default', 'inferenceGeo' => 'inference_geo', 'mcpServers' => [ [ 'name' => 'name', 'type' => 'url', 'url' => 'url', 'authorizationToken' => 'authorization_token', 'toolConfiguration' => [ 'allowedTools' => ['string'], 'enabled' => true ], ], ], 'metadata' => ['userID' => '13803d75-b4b5-4c3e-b2a2-6f21399b021b'], 'outputConfig' => [ 'effort' => 'low', 'format' => ['schema' => ['foo' => 'bar'], 'type' => 'json_schema'], 'taskBudget' => [ 'total' => 1024, 'type' => 'tokens', 'remaining' => 0 ], ], 'outputFormat' => [ 'schema' => ['foo' => 'bar'], 'type' => 'json_schema' ], 'serviceTier' => 'auto', 'speed' => 'standard', 'stopSequences' => ['string'], 'stream' => false, 'system' => [ [ 'text' => 'Today\'s date is 2024-06-01.', 'type' => 'text', 'cacheControl' => ['type' => 'ephemeral', 'ttl' => '5m'], 'citations' => [ [ 'citedText' => 'The grass is green. The sky is blue.', 'documentIndex' => 0, 'documentTitle' => 'x', 'endCharIndex' => 0, 'startCharIndex' => 0, 'type' => 'char_location', ], ], ], ], 'thinking' => [ 'type' => 'adaptive', 'blockBinding' => [ 'prefixMismatchBehavior' => BetaThinkingPrefixMismatchBehavior::ERROR, ], 'display' => 'summarized', ], 'thread' => ['type' => 'create'], 'toolChoice' => ['type' => 'auto', 'disableParallelToolUse' => true], 'tools' => [ [ 'inputSchema' => [ 'type' => 'object', 'properties' => ['location' => 'bar', 'unit' => 'bar'], 'required' => ['location'], ], 'name' => 'name', 'allowedCallers' => ['direct'], 'cacheControl' => ['type' => 'ephemeral', 'ttl' => '5m'], 'deferLoading' => true, 'description' => 'Get the current weather in a given location', 'eagerInputStreaming' => true, 'inputExamples' => [['foo' => 'bar']], 'strict' => true, 'type' => 'custom', ], ], ], ], ], betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24], userProfileID: 'anthropic-user-profile-id', workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy', ); var_dump($betaMessageBatch); ``` ### Response (200) ```json { "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF", "archived_at": "2024-08-20T18:37:24.100435Z", "cancel_initiated_at": "2024-08-20T18:37:24.100435Z", "created_at": "2024-08-20T18:37:24.100435Z", "ended_at": "2024-08-20T18:37:24.100435Z", "expires_at": "2024-08-20T18:37:24.100435Z", "processing_status": "in_progress", "request_counts": { "canceled": 10, "errored": 30, "expired": 10, "processing": 100, "succeeded": 50 }, "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results", "type": "message_batch" } ```