Claude Platform Docs

Lotes

Criar um lote de mensagens
messages.batches.create(**kwargs) -> MessageBatch
POST/v1/messages/batches

Envie um lote de solicitações de criação de mensagens.

Recuperar um lote de mensagens
messages.batches.retrieve(message_batch_id, **kwargs) -> MessageBatch
GET/v1/messages/batches/{message_batch_id}

Este endpoint é idempotente e pode ser usado para fazer polling da conclusão de um lote de mensagens. Para acessar os resultados de um lote de mensagens, faça uma solicitação para o campo results_url na resposta.

Listar lotes de mensagens
messages.batches.list(**kwargs) -> SyncPage[MessageBatch]
GET/v1/messages/batches

Liste todos os lotes de mensagens em um Workspace. Os lotes criados mais recentemente são retornados primeiro.

Cancelar um lote de mensagens
messages.batches.cancel(message_batch_id, **kwargs) -> MessageBatch
POST/v1/messages/batches/{message_batch_id}/cancel

Os lotes podem ser cancelados a qualquer momento antes do término do processamento. Depois que o cancelamento é iniciado, o lote entra em um estado canceling, momento em que o sistema pode concluir quaisquer solicitações em andamento e não interrompíveis antes de finalizar o cancelamento.

Excluir um lote de mensagens
messages.batches.delete(message_batch_id, **kwargs) -> DeletedMessageBatch
DELETE/v1/messages/batches/{message_batch_id}

Exclua um lote de mensagens.

Recuperar resultados de um lote de mensagens
messages.batches.results(message_batch_id, **kwargs) -> MessageBatchIndividualResponse
GET/v1/messages/batches/{message_batch_id}/results

Faz streaming dos resultados de um lote de mensagens como um arquivo .jsonl.

Models
class DeletedMessageBatch: 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 MessageBatch: type: "message_batch"; id; archived_at; ... # 7 more
class MessageBatchCanceledResult: type: "canceled"
type: Literal["canceled"]
defaultcanceled
class MessageBatchErroredResult: type: "errored"; error
type: Literal["errored"]
defaulterrored
error: ErrorResponse
type: Literal["error"]
defaulterror
error: ErrorObject
One of the following:
request_id: Optional[str]
class MessageBatchExpiredResult: type: "expired"
type: Literal["expired"]
defaultexpired
class MessageBatchIndividualResponse: 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: 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; 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 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: type: "succeeded"; message
type: Literal["succeeded"]
defaultsucceeded
message: Message