batches

Creates, updates, deletes, gets or lists a batches resource.

Overview

Name	batches
Type	Resource
Id	anthropic.messages.batches

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Unique object identifier. The format and length of IDs may change over time.
archived_at	string (date-time)	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)	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)	RFC 3339 datetime string representing the time at which the Message Batch was created.
ended_at	string (date-time)	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)	RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
processing_status	string	Processing status of the Message Batch. (in_progress, canceling, ended)
▶request_counts	object	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.
results_url	string	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	string	Object type. For Message Batches, this is always `"message_batch"`. (message_batch)

list

Name	Datatype	Description
id	string	Unique object identifier. The format and length of IDs may change over time.
archived_at	string (date-time)	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)	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)	RFC 3339 datetime string representing the time at which the Message Batch was created.
ended_at	string (date-time)	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)	RFC 3339 datetime string representing the time at which the Message Batch will expire and end processing, which is 24 hours after creation.
processing_status	string	Processing status of the Message Batch. (in_progress, canceling, ended)
▶request_counts	object	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.
results_url	string	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	string	Object type. For Message Batches, this is always `"message_batch"`. (message_batch)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	message_batch_id		This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the results_url field in the response. Learn more about the Message Batches API in our user guide
list	select		before_id, after_id	List all Message Batches within a Workspace. Most recently created batches are returned first. Learn more about the Message Batches API in our user guide
create	insert	requests		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
delete	delete	message_batch_id		Delete a Message Batch. Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it. Learn more about the Message Batches API in our user guide
cancel	exec	message_batch_id		Batches may be canceled any time before processing ends. Once cancellation is initiated, the batch enters a canceling state, at which time the system may complete any in-progress, non-interruptible requests before finalizing cancellation. The number of canceled requests is specified in request_counts. To determine which requests were canceled, check the individual results within the batch. Note that cancellation may not result in any canceled requests if they were non-interruptible. Learn more about the Message Batches API in our user guide
results	exec	message_batch_id		Streams the results of a Message Batch as a .jsonl file. Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests. Learn more about the Message Batches API in our user guide

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
message_batch_id	string	ID of the Message Batch.
after_id	string	ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately after this object.
before_id	string	ID of the object to use as a cursor for pagination. When provided, returns the page of results immediately before this object.

SELECT examples

get

This endpoint is idempotent and can be used to poll for Message Batch completion. To access the results of a Message Batch, make a request to the results_url field in the response.

Learn more about the Message Batches API in our user guide

SELECT
id,
archived_at,
cancel_initiated_at,
created_at,
ended_at,
expires_at,
processing_status,
request_counts,
results_url,
type
FROM anthropic.messages.batches
WHERE message_batch_id = '{{ message_batch_id }}' -- required
;

list

List all Message Batches within a Workspace. Most recently created batches are returned first.

Learn more about the Message Batches API in our user guide

SELECT
id,
archived_at,
cancel_initiated_at,
created_at,
ended_at,
expires_at,
processing_status,
request_counts,
results_url,
type
FROM anthropic.messages.batches
WHERE before_id = '{{ before_id }}'
AND after_id = '{{ after_id }}'
;

INSERT examples

create

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

INSERT INTO anthropic.messages.batches (
requests
)
SELECT 
'{{ requests }}' /* required */
RETURNING
id,
archived_at,
cancel_initiated_at,
created_at,
ended_at,
expires_at,
processing_status,
request_counts,
results_url,
type
;

Manifest

# Description fields are for documentation purposes
- name: batches
props:
  - name: requests
    description: |
      List of requests for prompt completion. Each is an individual request to create a Message.
    value:
      - custom_id: "{{ custom_id }}"
        params:
          model: "{{ model }}"
          messages:
            - content: "{{ content }}"
              role: "{{ role }}"
          cache_control: "{{ cache_control }}"
          container: "{{ container }}"
          inference_geo: "{{ inference_geo }}"
          max_tokens: {{ max_tokens }}
          metadata:
            user_id: "{{ user_id }}"
          output_config:
            effort: "{{ effort }}"
            format:
              schema: "{{ schema }}"
              type: "{{ type }}"
          service_tier: "{{ service_tier }}"
          stop_sequences:
            - "{{ stop_sequences }}"
          stream: {{ stream }}
          system: "{{ system }}"
          temperature: {{ temperature }}
          thinking:
            budget_tokens: {{ budget_tokens }}
            display: "{{ display }}"
            type: "{{ type }}"
          tool_choice:
            disable_parallel_tool_use: {{ disable_parallel_tool_use }}
            type: "{{ type }}"
            name: "{{ name }}"
          tools:
            - "{{ tools }}"
          top_k: {{ top_k }}
          top_p: {{ top_p }}

DELETE examples

delete

Delete a Message Batch.

Message Batches can only be deleted once they've finished processing. If you'd like to delete an in-progress batch, you must first cancel it.

Learn more about the Message Batches API in our user guide

DELETE FROM anthropic.messages.batches
WHERE message_batch_id = '{{ message_batch_id }}' --required
;

Lifecycle Methods

cancel

Batches may be canceled any time before processing ends. Once cancellation is initiated, the batch enters a canceling state, at which time the system may complete any in-progress, non-interruptible requests before finalizing cancellation.

The number of canceled requests is specified in request_counts. To determine which requests were canceled, check the individual results within the batch. Note that cancellation may not result in any canceled requests if they were non-interruptible.

Learn more about the Message Batches API in our user guide

EXEC anthropic.messages.batches.cancel 
@message_batch_id='{{ message_batch_id }}' --required
;

results

Streams the results of a Message Batch as a .jsonl file.

Each line in the file is a JSON object containing the result of a single request in the Message Batch. Results are not guaranteed to be in the same order as requests. Use the custom_id field to match results to requests.

Learn more about the Message Batches API in our user guide

EXEC anthropic.messages.batches.results 
@message_batch_id='{{ message_batch_id }}' --required
;