Claude Platform Docs

Batch

Buat Message Batch
client.Beta.Messages.Batches.New(ctx, params) (*BetaMessageBatch, error)
POST/v1/messages/batches

Kirim batch permintaan pembuatan Message.

Ambil Message Batch
client.Beta.Messages.Batches.Get(ctx, messageBatchID, query) (*BetaMessageBatch, error)
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
client.Beta.Messages.Batches.List(ctx, params) (*Page[BetaMessageBatch], error)
GET/v1/messages/batches

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

Batalkan Message Batch
client.Beta.Messages.Batches.Cancel(ctx, messageBatchID, body) (*BetaMessageBatch, error)
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
client.Beta.Messages.Batches.Delete(ctx, messageBatchID, body) (*BetaDeletedMessageBatch, error)
DELETE/v1/messages/batches/{message_batch_id}
Ambil hasil Message Batch
client.Beta.Messages.Batches.ResultsStreaming(ctx, messageBatchID, query) *jsonl.Stream[BetaMessageBatchIndividualResponse]
GET/v1/messages/batches/{message_batch_id}/results

Melakukan streaming hasil Message Batch sebagai file .jsonl.

Models
type BetaDeletedMessageBatch struct { Type: "message_batch_deleted"; ID }
Type MessageBatchDeleted

Deleted object type.

For Message Batches, this is always "message_batch_deleted".

defaultmessage_batch_deleted
ID string

ID of the Message Batch.

type BetaMessageBatch struct { Type: "message_batch"; ID; ArchivedAt; /* 7 more */ }
type BetaMessageBatchCanceledResult struct { Type: "canceled" }
Type Canceled
defaultcanceled
type BetaMessageBatchErroredResult struct { Type: "errored"; Error }
Type Errored
defaulterrored
Error BetaErrorResponse
Type Error
defaulterror
Error BetaErrorUnion
One of the following:
RequestID string
type BetaMessageBatchExpiredResult struct { Type: "expired" }
Type Expired
defaultexpired
type BetaMessageBatchIndividualResponse struct { CustomID; Result }

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

CustomID 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 BetaMessageBatchResultUnion

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:
type BetaMessageBatchRequestCounts struct { Canceled; Errored; Expired; /* 2 more */ }
Canceled int64

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 int64

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 int64

Number of requests in the Message Batch that have expired.

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

default0
Processing int64

Number of requests in the Message Batch that are processing.

default0
Succeeded int64

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 BetaMessageBatchResultUnion interface{…}

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:
type BetaMessageBatchSucceededResult struct { Type: "succeeded"; Message }
Type Succeeded
defaultsucceeded
Message BetaMessage