ファイルとバッチ
メッセージバッチのキャンセル
処理中のメッセージバッチをキャンセルします。
概要
処理中のメッセージバッチのキャンセルをリクエストします。レスポンスには現在の状態が表示されます。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キー認証。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