Claude Platform Docs

Batches

Create a Message Batch
messages.batches.create(BatchCreateParams**kwargs) -> MessageBatch
POST/v1/messages/batches
Retrieve a Message Batch
messages.batches.retrieve(strmessage_batch_id) -> MessageBatch
GET/v1/messages/batches/{message_batch_id}
List Message Batches
messages.batches.list(BatchListParams**kwargs) -> SyncPage[MessageBatch]
GET/v1/messages/batches
Cancel a Message Batch
messages.batches.cancel(strmessage_batch_id) -> MessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel
Delete a Message Batch
messages.batches.delete(strmessage_batch_id) -> DeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
messages.batches.results(strmessage_batch_id) -> MessageBatchIndividualResponse
GET/v1/messages/batches/{message_batch_id}/results
Models
class DeletedMessageBatch: …
id: str

ID of the Message Batch.

type: Literal["message_batch_deleted"]

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted
class MessageBatch: …
class MessageBatchCanceledResult: …
type: Literal["canceled"]
defaultcanceled
class MessageBatchErroredResult: …
error: ErrorResponse
error: ErrorObject
One of the following:
request_id: Optional[str]
type: Literal["error"]
defaulterror
type: Literal["errored"]
defaulterrored
class MessageBatchExpiredResult: …
type: Literal["expired"]
defaultexpired
class MessageBatchIndividualResponse: …

This is a single line in the response .jsonl file and does not represent the response as a whole.

custom_id: str

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.

result: MessageBatchResult

Processing result for this request.

Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

One of the following:
class MessageBatchRequestCounts: …
canceled: int

Number of requests in the Message Batch that have been canceled.

This is zero until processing of the entire Message Batch has ended.

default0
errored: int

Number of requests in the Message Batch that encountered an error.

This is zero until processing of the entire Message Batch has ended.

default0
expired: int

Number of requests in the Message Batch that have expired.

This is zero until processing of the entire Message Batch has ended.

default0
processing: int

Number of requests in the Message Batch that are processing.

default0
succeeded: int

Number of requests in the Message Batch that have completed successfully.

This is zero until processing of the entire Message Batch has ended.

default0
MessageBatchResult

Processing result for this request.

Contains a Message output if processing was successful, an error response if processing failed, or the reason why processing was not attempted, such as cancellation or expiration.

One of the following:
class MessageBatchSucceededResult: …
message: Message
type: Literal["succeeded"]
defaultsucceeded