Batches

Create a Message Batch

MessageBatch Messages.Batches.Create(parameters, cancellationToken = default)

POST/v1/messages/batches

Send a batch of Message creation requests.

Retrieve a Message Batch

MessageBatch Messages.Batches.Retrieve(parameters, cancellationToken = default)

GET/v1/messages/batches/{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.

List Message Batches

BatchListPage Messages.Batches.List(parameters, cancellationToken = default)

GET/v1/messages/batches

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

Cancel a Message Batch

MessageBatch Messages.Batches.Cancel(parameters, cancellationToken = default)

POST/v1/messages/batches/{message_batch_id}/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.

Delete a Message Batch

DeletedMessageBatch Messages.Batches.Delete(parameters, cancellationToken = default)

DELETE/v1/messages/batches/{message_batch_id}

Retrieve Message Batch results

MessageBatchIndividualResponse Messages.Batches.ResultsStreaming(parameters, cancellationToken = default)

GET/v1/messages/batches/{message_batch_id}/results

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

Models

class DeletedMessageBatch { Type = "message_batch_deleted"; ID; }

JsonElement Type = "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

required string ID

ID of the Message Batch.

class MessageBatch { Type = "message_batch"; ID; ArchivedAt; /* 7 more */ }

class MessageBatchCanceledResult { Type = "canceled"; }

JsonElement Type = "canceled"

class MessageBatchErroredResult { Type = "errored"; Error; }

JsonElement Type = "errored"

required ErrorResponse Error

JsonElement Type = "error"

required ErrorObject Error

One of the following:

required string? RequestID

class MessageBatchExpiredResult { Type = "expired"; }

JsonElement Type = "expired"

class MessageBatchIndividualResponse { CustomID; Result; }

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

required string CustomID

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.

required MessageBatchResult Result

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; Errored; Expired; /* 2 more */ }

required long Canceled

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

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

required long Errored

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

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

required long Expired

Number of requests in the Message Batch that have expired.

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

required long Processing

Number of requests in the Message Batch that are processing.

required long Succeeded

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

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

class MessageBatchResult: union

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.

class MessageBatchSucceededResult { Type = "succeeded"; Message; }

JsonElement Type = "succeeded"

required Message Message