Berkas & batch

Membatalkan Batch Pesan

Membatalkan Batch Pesan yang masih dalam proses.

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

Gambaran Umum

Meminta pembatalan Batch Pesan yang masih dalam proses. Respons menunjukkan status saat ini. processing_status biasanya adalah canceling, dan permintaan yang sudah berjalan mungkin masih dapat selesai. Batch yang sudah berakhir akan dikembalikan tanpa perubahan.

Catatan

  • Setelah Anda membatalkan, ambil batch tersebut hingga processing_status menjadi ended. Permintaan yang belum dimulai akan berakhir sebagai canceled.
  • Batch yang tidak ada atau telah dihapus akan mengembalikan 404. Batch yang belum siap untuk diubah akan mengembalikan 409; coba lagi nanti.
  • Pembatalan tidak menghapus batch. Untuk menghapusnya, hapus batch tersebut setelah batch berakhir.

Contoh

Permintaan

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"

Contoh respons

Respons

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
}

Bidang penting

processing_statusstring
canceling saat pembatalan sedang berlangsung, ended setelah selesai. Jangan berasumsi bahwa setiap permintaan pembatalan akan mengembalikan canceling.
cancel_initiated_atstring|null
Waktu saat permintaan pembatalan diterima, atau null.

Otorisasi

BearerAuth
AuthorizationBearer <token>

Autentikasi API Key. Buat atau kelola API key di Dashboard > API > API Keys.

Lokasi: header

Parameter path

message_batch_id*string

Pengidentifikasi batch pesan

Respons

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json