Claude Platform Docs

Lotes

Crear un lote de mensajes
beta.messages.batches.create(**kwargs) -> BetaMessageBatch
POST/v1/messages/batches

Envía un lote de solicitudes de creación de mensajes.

Recuperar un lote de mensajes
beta.messages.batches.retrieve(message_batch_id, **kwargs) -> BetaMessageBatch
GET/v1/messages/batches/{message_batch_id}

Este endpoint es idempotente y puede usarse para sondear la finalización de un lote de mensajes. Para acceder a los resultados de un lote de mensajes, realiza una solicitud al campo results_url de la respuesta.

Listar lotes de mensajes
beta.messages.batches.list(**kwargs) -> SyncPage[BetaMessageBatch]
GET/v1/messages/batches

Lista todos los lotes de mensajes dentro de un Workspace. Los lotes creados más recientemente se devuelven primero.

Cancelar un lote de mensajes
beta.messages.batches.cancel(message_batch_id, **kwargs) -> BetaMessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel

Los lotes pueden cancelarse en cualquier momento antes de que finalice el procesamiento. Una vez iniciada la cancelación, el lote entra en estado canceling, momento en el cual el sistema puede completar cualquier solicitud en curso no interrumpible antes de finalizar la cancelación.

Eliminar un lote de mensajes
beta.messages.batches.delete(message_batch_id, **kwargs) -> BetaDeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}

Elimina un lote de mensajes.

Recuperar resultados de un lote de mensajes
beta.messages.batches.results(message_batch_id, **kwargs) -> BetaMessageBatchIndividualResponse
GET/v1/messages/batches/{message_batch_id}/results

Devuelve en streaming los resultados de un lote de mensajes como un archivo .jsonl.

Models
class BetaDeletedMessageBatch: type: "message_batch_deleted"; id
type: Literal["message_batch_deleted"]

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted
id: str

ID of the Message Batch.

class BetaMessageBatch: type: "message_batch"; id; archived_at; ... # 7 more
class BetaMessageBatchCanceledResult: type: "canceled"
type: Literal["canceled"]
defaultcanceled
class BetaMessageBatchErroredResult: type: "errored"; error
type: Literal["errored"]
defaulterrored
error: BetaErrorResponse
type: Literal["error"]
defaulterror
error: BetaError
One of the following:
request_id: Optional[str]
class BetaMessageBatchExpiredResult: type: "expired"
type: Literal["expired"]
defaultexpired
class BetaMessageBatchIndividualResponse: custom_id; result

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: BetaMessageBatchResult

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 BetaMessageBatchRequestCounts: canceled; errored; expired; ... # 2 more
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
type BetaMessageBatchResult = ...

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 BetaMessageBatchSucceededResult: type: "succeeded"; message
type: Literal["succeeded"]
defaultsucceeded
message: BetaMessage