文件与批处理

取消 Message Batch

取消仍在处理中的 Message Batch。

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

概述

请求取消仍在处理中的 Message Batch。响应显示当前状态。processing_status 通常为 canceling,已经在运行的请求仍可能完成。已经结束的批次原样返回。

说明

  • 取消后,请获取该批次,直到 processing_status 变为 ended。尚未开始的请求以 canceled 结束。
  • 批次不存在或已删除时返回 404。批次尚未就绪时返回 409,请稍后重试。
  • 取消不会删除批次。要移除批次,请在它结束后删除。

示例

请求

cURL
curl -X POST "https://api.tokenlab.sh/v1/messages/batches/msgbatch_01ABC123/cancel" \
  -H "x-api-key: sk-your-api-key" \
  -H "anthropic-version: 2023-06-01"

响应示例

响应

200 OK
{
  "id": "msgbatch_01ABC123",
  "type": "message_batch",
  "processing_status": "canceling",
  "request_counts": {
    "processing": 1,
    "succeeded": 1,
    "errored": 0,
    "canceled": 0,
    "expired": 0
  },
  "ended_at": null,
  "created_at": "2026-11-01T10:00:00Z",
  "expires_at": "2026-11-02T10:00:00Z",
  "cancel_initiated_at": "2026-11-01T10:05:00Z",
  "archived_at": null,
  "results_url": null
}

重要字段

processing_statusstring
取消进行中为 canceling,取消完成后为 ended。不要假设每个取消请求都返回 canceling。
cancel_initiated_atstring|null
取消请求被受理的时间,没有则为 null。

授权

BearerAuth
AuthorizationBearer <token>

API Key 身份验证。在 Dashboard > API > API Keys 中创建或管理 API Key。

位置: header

路径参数

message_batch_id*string

消息批处理标识符

响应

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json