Lotes

Crear un lote de mensajes

$ ant messages:batches create

POST/v1/messages/batches

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

Recuperar un lote de mensajes

$ ant messages:batches retrieve

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

$ ant messages:batches list

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

$ ant messages:batches cancel

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

$ ant messages:batches delete

DELETE/v1/messages/batches/{message_batch_id}

Elimina un lote de mensajes.

Recuperar resultados de un lote de mensajes

$ ant messages:batches results

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

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

Models

deleted_message_batch: object{ type: "message_batch_deleted", id }

type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

id: string

ID of the Message Batch.

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

message_batch_canceled_result: object{ type: "canceled" }

type: "canceled"

message_batch_errored_result: object{ type: "errored", error }

message_batch_expired_result: object{ type: "expired" }

type: "expired"

message_batch_individual_response: object{ custom_id, result }

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

message_batch_request_counts: 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.

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.

expired: number

Number of requests in the Message Batch that have expired.

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

processing: number

Number of requests in the Message Batch that are processing.

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.

message_batch_result: MessageBatchSucceededResult or MessageBatchErroredResult or MessageBatchCanceledResult or MessageBatchExpiredResult

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.

message_batch_succeeded_result: object{ type: "succeeded", message }