Lotes

Criar um lote de mensagens

POST/v1/messages/batches

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

Recuperar um lote de mensagens

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

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

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

DELETE/v1/messages/batches/{message_batch_id}

Exclua um lote de mensagens.

Recuperar resultados de um lote de mensagens

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

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

Models

BetaDeletedMessageBatch object{ type: "message_batch_deleted", id }

type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted

id: string

ID of the Message Batch.

BetaMessageBatch object{ type: "message_batch", id, archived_at, 7 more }

BetaMessageBatchCanceledResult object{ type: "canceled" }

type: "canceled"

defaultcanceled

BetaMessageBatchErroredResult object{ type: "errored", error }

type: "errored"

defaulterrored

error: BetaErrorResponse { type: "error", error, request_id }

type: "error"

defaulterror

error: BetaError

One of the following:

request_id: string or null

BetaMessageBatchExpiredResult object{ type: "expired" }

type: "expired"

defaultexpired

BetaMessageBatchIndividualResponse object{ custom_id, result }

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

custom_id: string

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:

BetaMessageBatchRequestCounts object{ canceled, errored, expired, 2 more }

canceled: number

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

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

Number of requests in the Message Batch that have expired.

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

default0

processing: number

Number of requests in the Message Batch that are processing.

default0

succeeded: number

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

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

default0

BetaMessageBatchResult = BetaMessageBatchSucceededResult or BetaMessageBatchErroredResult or BetaMessageBatchCanceledResult or BetaMessageBatchExpiredResult

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:

BetaMessageBatchSucceededResult object{ type: "succeeded", message }

type: "succeeded"

defaultsucceeded

message: BetaMessage { type: "message", id, container, 10 more }