TokenLab

檔案與批次

取消批次

取消排隊或正在運行的批次作業。

POST
/v1/batches/{batch_id}/cancel

請求取消排隊或執行中的批次。回應會返回目前狀態,可能仍在取消,也可能已取消完成。已結束的批次保留原有終態。若回傳狀態尚未結束,請再次取得批次以確認結果。

請求

cURL
curl -X POST "https://api.tokenlab.sh/v1/batches/batch_abc123/cancel" \
  -H "Authorization: Bearer sk-your-api-key"

回應

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "status": "cancelling",
  "input_file_id": "file_abc123"
}
idstring
用於後續呼叫和支援排障的識別符。
statusstring
批次目前狀態。取消請求成功並不一定回傳 cancelling。

授權

BearerAuth
AuthorizationBearer <token>

API Key 驗證。請在 Dashboard > API > API Keys 建立或管理 API 金鑰。

位置: header

路徑參數

batch_id*string

回應

application/json

application/json