Claude Platform Docs

Batalkan Message Batch

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

Batch dapat dibatalkan kapan saja sebelum pemrosesan berakhir. Setelah pembatalan dimulai, batch memasuki status canceling, dan pada saat itu sistem dapat menyelesaikan permintaan yang sedang berjalan dan tidak dapat diinterupsi sebelum memfinalisasi pembatalan.

Jumlah permintaan yang dibatalkan ditentukan dalam request_counts. Untuk menentukan permintaan mana yang dibatalkan, periksa hasil individual dalam batch. Perhatikan bahwa pembatalan mungkin tidak menghasilkan permintaan yang dibatalkan jika permintaan tersebut tidak dapat diinterupsi.

Pelajari lebih lanjut tentang Message Batches API di panduan pengguna kami

Path parameters
message_batch_id: string

ID of the Message Batch.

Headers
"anthropic-workspace-id": optional string

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Returns
MessageBatch object{ type: "message_batch", id, archived_at, 7 more }
Batalkan Message Batch
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"
}