Batch

Buat Message Batch

POST/v1/messages/batches

Kirim batch permintaan pembuatan Message.

Ambil Message Batch

GET/v1/messages/batches/{message_batch_id}

Endpoint ini idempoten dan dapat digunakan untuk melakukan polling penyelesaian Message Batch. Untuk mengakses hasil Message Batch, buat permintaan ke field results_url dalam respons.

Daftar Message Batch

GET/v1/messages/batches

Daftar semua Message Batch dalam sebuah Workspace. Batch yang paling baru dibuat dikembalikan terlebih dahulu.

Batalkan Message Batch

POST/v1/messages/batches/{message_batch_id}/cancel

Batch dapat dibatalkan kapan saja sebelum pemrosesan berakhir. Setelah pembatalan dimulai, batch memasuki status canceling, dan pada saat itu sistem dapat menyelesaikan permintaan yang sedang berjalan dan tidak dapat diinterupsi sebelum memfinalisasi pembatalan.

Hapus Message Batch

DELETE/v1/messages/batches/{message_batch_id}

Ambil hasil Message Batch

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

Melakukan streaming hasil Message Batch sebagai file .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 }