Claude Batch

Overview

Claude Batch uses the Anthropic Message Batches API to process multiple Claude message requests asynchronously. Supports three operations: create (collect input items into a batch of message requests), check (poll batch status), and cancel (cancel a processing batch). For the create operation, all input items are submitted as a single batch. Optionally polls for completion with configurable intervals and timeouts. Batch processing offers a 50% cost discount over standard API calls.

Node Type

Action — processes input items and produces output

Input / Output

Direction	Port(s)
Input	Input
Output	Output, Error

Credentials

This tool requires Anthropic credentials. See the Credentials Guide for setup instructions.

Operations

Operation	Value	Description
Create Batch	create	Collect upstream items into a single batch. Each input item becomes one batch request
Check Status	check	Check the status of an existing batch
Cancel Batch	cancel	Cancel a processing batch

Parameters

Parameter	Type	Required	Default	Description
Model (default)	string	No	claude-sonnet-4-6	Default Claude model applied to EVERY batch request. Each upstream item can override this by including an item.model field. Always uses the latest version (auto-updated). (shown when Operation is create)
System Prompt (default)	string	No	—	Default system instructions applied to EVERY batch request. Each upstream item can override this by including an item.systemPrompt field. Per-item fields supported on each upstream item: item.message (or item.prompt/item.text) for a single-turn user message; item.messages for a full multi-turn array; item.systemPrompt to override the shared default; item.attachmentFileId (+ optional item.attachmentType) to attach an Anthropic file; item.model, item.maxTokens, item.temperature for per-request overrides. See the tool documentation for full details and examples. (shown when Operation is create)
Batch ID	string	No	—	The batch ID to check or cancel. Falls back to item.json.batchId if empty. (shown when Operation is check, cancel)
Options	collection	No	{}
— Max Tokens	number	No	4096	Maximum number of tokens per response in the batch.
— Poll Interval (ms)	number	No	30000	How often to poll for completion status in milliseconds.
— Max Poll Duration (ms)	number	No	600000	Maximum total time to spend polling for completion in milliseconds.
— Wait for Completion	boolean	No	false	If true, poll until the batch completes (or fails/expires) before returning.
— Response Field Name	string	No	batch	Field name in the output JSON where the batch result will be placed.
Include Input	boolean	No	false	Whether to include the original input item fields in the output.
Max Concurrency	number	No	5	Maximum number of items to process concurrently (for check/cancel operations).

Output Data

Create Batch submits one batch for the whole node run and then emits one output item per input item, each carrying the same batch metadata. Check Status and Cancel Batch process items individually. Binary data on the input item is forwarded unchanged, and with Include Input on the original item fields are merged in alongside the result.

{
  "batch": { "id": "msgbatch_01...", "processing_status": "in_progress" },
  "batchId": "msgbatch_01...",
  "status": "in_progress",
  "requestCount": 500,
  "resultsUrl": "https://api.anthropic.com/v1/messages/batches/msgbatch_01.../results",
  "requestCounts": { "processing": 480, "succeeded": 20, "errored": 0, "canceled": 0, "expired": 0 }
}

• The field named by Response Field Name (batch by default) holds the batch object exactly as Anthropic returned it.
• batchId and status are lifted to the top level for convenience. batchId is what a downstream Check Status or Cancel Batch node reads automatically when its own Batch ID is left empty.
• requestCount is returned by Create Batch only, and is the number of requests that went into the batch.
• resultsUrl and requestCounts appear once Anthropic has published them — typically after the batch has ended. requestCounts is where you see how many individual requests succeeded or errored; a batch can end successfully with errored requests inside it.
• With Wait for Completion on, the node polls until the batch reports ended (or the Max Poll Duration elapses), so the values above are the final ones. With it off, the node returns as soon as the batch is accepted.
• If no input item carried a usable message, Create Batch submits nothing and emits items with a null batch, batchId: null and status: "empty".

Reference the result downstream by expression, e.g. {{ $json.batchId }}.

Example Configuration

Create a batch and continue immediately:

{
  "type": "claude_batch",
  "parameters": {
    "operation": "create",
    "systemPrompt": "You are a concise summarization assistant. Return only the summary.",
    "options": {
      "maxTokens": 1024,
      "waitForCompletion": false,
      "responseFieldName": "batch"
    }
  }
}

Create a batch and block until every request has been processed:

{
  "type": "claude_batch",
  "parameters": {
    "operation": "create",
    "systemPrompt": "Classify the sentiment of the provided text as positive, negative, or neutral.",
    "includeInput": true,
    "options": {
      "maxTokens": 256,
      "waitForCompletion": true,
      "pollIntervalMs": 20000,
      "maxPollDurationMs": 900000,
      "responseFieldName": "sentimentResult"
    }
  }
}

Check a batch created earlier, taking the ID from the incoming item:

{
  "type": "claude_batch",
  "parameters": {
    "operation": "check",
    "batchId": "",
    "options": {
      "waitForCompletion": true,
      "pollIntervalMs": 30000,
      "maxPollDurationMs": 600000,
      "responseFieldName": "batch"
    }
  }
}

Cancel a batch by ID:

{
  "type": "claude_batch",
  "parameters": {
    "operation": "cancel",
    "batchId": "{{ $json.batchId }}",
    "options": {
      "responseFieldName": "cancelResult"
    }
  }
}

Error Handling

Mode	Behavior
stop	Halts workflow on first error
continue	Skips failed items, passes successful ones through
errorPort	Routes failed items to Error output port

Tips

Claude Batch submits multiple Claude message requests to the Anthropic Message Batches API asynchronously, supporting create, check, and cancel operations at a 50% cost discount over standard API calls. Use it when processing large volumes of independent prompts where real-time responses are unnecessary and minimizing inference cost is a priority. It outputs per-request response data to the main channel upon batch completion, or routes submission and processing failures to the error channel.