TokenLab

Tệp và lô

Hủy Message Batch

Hủy một Message Batch vẫn đang trong quá trình xử lý.

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

Tổng quan

Yêu cầu hủy một Message Batch vẫn đang trong quá trình xử lý. Phản hồi sẽ hiển thị trạng thái hiện tại. processing_status thường là canceling, và các yêu cầu đang chạy vẫn có thể hoàn tất. Một batch đã kết thúc sẽ được trả về mà không có thay đổi.

Lưu ý

  • Sau khi bạn hủy, hãy truy xuất batch cho đến khi processing_status là ended. Các yêu cầu chưa bắt đầu sẽ kết thúc với trạng thái canceled.
  • Một batch không tồn tại hoặc đã bị xóa sẽ trả về 404. Một batch chưa sẵn sàng để thay đổi sẽ trả về 409; hãy thử lại sau.
  • Việc hủy không xóa batch. Để xóa batch, hãy xóa nó sau khi nó đã kết thúc.

Ví dụ

Yêu cầu

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"

Ví dụ phản hồi

Phản hồi

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
}

Các trường quan trọng

processing_statusstring
canceling trong khi quá trình hủy đang diễn ra, ended sau khi hoàn tất. Đừng giả định rằng mọi yêu cầu hủy đều trả về canceling.
cancel_initiated_atstring|null
Thời điểm yêu cầu hủy được chấp nhận, hoặc null.

Xác thực

BearerAuth
AuthorizationBearer <token>

Xác thực bằng Khóa API. Tạo hoặc quản lý khóa API trong Dashboard > API > API Keys.

Vị trí: header

Tham số đường dẫn

message_batch_id*string

Định danh batch tin nhắn

Phản hồi

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json