Claude Platform Docs

批处理

创建消息批次
client.Beta.Messages.Batches.New(ctx, params) (*BetaMessageBatch, error)
POST/v1/messages/batches

发送一批消息创建请求。

检索消息批次
client.Beta.Messages.Batches.Get(ctx, messageBatchID, query) (*BetaMessageBatch, error)
GET/v1/messages/batches/{message_batch_id}

此端点是幂等的，可用于轮询消息批次是否完成。要访问消息批次的结果，请向响应中的 results_url 字段发起请求。

列出消息批次
client.Beta.Messages.Batches.List(ctx, params) (*Page[BetaMessageBatch], error)
GET/v1/messages/batches

列出工作区内的所有消息批次。最近创建的批次最先返回。

取消消息批次
client.Beta.Messages.Batches.Cancel(ctx, messageBatchID, body) (*BetaMessageBatch, error)
POST/v1/messages/batches/{message_batch_id}/cancel

批次可在处理结束前的任何时间取消。一旦发起取消，批次将进入 canceling 状态，此时系统可能会先完成任何正在进行的、不可中断的请求，然后再最终完成取消。

删除消息批次
client.Beta.Messages.Batches.Delete(ctx, messageBatchID, body) (*BetaDeletedMessageBatch, error)
DELETE/v1/messages/batches/{message_batch_id}

删除消息批次。

检索消息批次结果
client.Beta.Messages.Batches.ResultsStreaming(ctx, messageBatchID, query) *jsonl.Stream[BetaMessageBatchIndividualResponse]
GET/v1/messages/batches/{message_batch_id}/results

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