Lots

Models

beta_deleted_message_batch: object{ id, type }

id: string

ID of the Message Batch.

type: "message_batch_deleted"

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

beta_message_batch: object{ id, archived_at, cancel_initiated_at, 7 more }

beta_message_batch_canceled_result: object{ type }

type: "canceled"

beta_message_batch_errored_result: object{ error, type }

beta_message_batch_expired_result: object{ type }

type: "expired"

beta_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.

beta_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.

beta_message_batch_result: BetaMessageBatchSucceededResult { message, type } or BetaMessageBatchErroredResult { error, type } or BetaMessageBatchCanceledResult { type } or BetaMessageBatchExpiredResult { type }

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.

beta_message_batch_succeeded_result: object{ message, type }

Créer un lot de messages

Récupérer un lot de messages

Lister les lots de messages

Annuler un lot de messages

Supprimer un lot de messages

Récupérer les résultats d'un lot de messages

Models