Cancel Batch

​

Headers

​

Path parameters

​

Example request

curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/batches/batch_processing001/cancel' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

​

Example response

{
  "id": "batch_processing001",
  "object": "batch",
  "status": "cancelling",
  "input_file_id": "file_input002",
  "completion_window": "24h",
  "created_at": "2026-07-06T11:59:02Z",
  "expires_at": "2026-07-07T11:59:02Z",
  "request_counts": {
    "total": 10,
    "pending": 0,
    "running": 3,
    "completed": 7,
    "failed": 0,
    "cancelled": 0,
    "expired": 0
  },
  "usage": {
    "total_credits": 12.5
  }
}

​

Response fields

​

Cancellation flow

1. Batch already in a terminal state: returns 200 idempotently, no operation performed.
2. CAS transitions the status validating|queued|processing → cancelling.
3. Drain the Redis queue and bulk-mark pending tasks as cancelled.
4. Call CancelSession on each running task.
5. If no running tasks remain, trigger finalize immediately; otherwise wait for the last CompleteTask to drive finalize.

​

Error codes

​

Notes

• Cancellation is asynchronous. A cancelling response means the request was accepted; poll the batch detail to confirm the terminal state.
• Cancelling a batch already in a terminal state is idempotent and returns 200.

​

Related