Claude Platform Docs

批处理

创建消息批次
$ ant messages:batches create
POST/v1/messages/batches

发送一批消息创建请求。

检索消息批次
$ ant messages:batches retrieve
GET/v1/messages/batches/{message_batch_id}

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

列出消息批次
$ ant messages:batches list
GET/v1/messages/batches

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

取消消息批次
$ ant messages:batches cancel
POST/v1/messages/batches/{message_batch_id}/cancel

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

删除消息批次
$ ant messages:batches delete
DELETE/v1/messages/batches/{message_batch_id}

删除消息批次。

检索消息批次结果
$ ant messages:batches results
GET/v1/messages/batches/{message_batch_id}/results

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