檔案與批次
取消訊息批次 (Cancel Message Batch)
取消仍在處理中的訊息批次。
概覽
請求取消仍在處理中的訊息批次。回應將顯示目前的狀態。processing_status 通常為 canceling,且已經在執行中的請求仍可能會完成。若批次已經結束,則會原樣返回。
注意事項
- 取消後,請持續檢索該批次,直到
processing_status變為ended。尚未開始的請求將以canceled狀態結束。 - 若批次不存在或已被刪除,將返回
404。若批次尚未準備好進行變更,將返回409;請稍後重試。 - 取消操作不會刪除該批次。若要移除它,請在批次結束後將其刪除。
請求
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"回應
{
"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 金鑰。
位置: 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