Claude Platform Docs

メッセージバッチをキャンセル

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

バッチは処理が終了する前であればいつでもキャンセルできます。キャンセルが開始されると、バッチはcanceling状態になり、この間にシステムはキャンセルを確定する前に、進行中の中断不可能なリクエストを完了させる場合があります。

キャンセルされたリクエストの数はrequest_countsに示されます。どのリクエストがキャンセルされたかを確認するには、バッチ内の個々の結果を確認してください。リクエストが中断不可能であった場合、キャンセルしてもキャンセルされたリクエストが1件も発生しない場合があることに注意してください。

Message Batches APIの詳細については、ユーザーガイドをご覧ください。

Path parameters
message_batch_id: string

ID of the Message Batch.

Returns
MessageBatch object{ id, archived_at, cancel_initiated_at, 7 more }
メッセージバッチをキャンセル
curl https://api.anthropic.com/v1/messages/batches/$MESSAGE_BATCH_ID/cancel \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"
Returns Examples
Response 200
{
  "id": "msgbatch_013Zva2CMHLNnXjNJJKqJ2EF",
  "archived_at": "2024-08-20T18:37:24.100435Z",
  "cancel_initiated_at": "2024-08-20T18:37:24.100435Z",
  "created_at": "2024-08-20T18:37:24.100435Z",
  "ended_at": "2024-08-20T18:37:24.100435Z",
  "expires_at": "2024-08-20T18:37:24.100435Z",
  "processing_status": "in_progress",
  "request_counts": {
    "canceled": 10,
    "errored": 30,
    "expired": 10,
    "processing": 100,
    "succeeded": 50
  },
  "results_url": "https://api.anthropic.com/v1/messages/batches/msgbatch_013Zva2CMHLNnXjNJJKqJ2EF/results",
  "type": "message_batch"
}