バッチのキャンセル

キューに入っているまたは実行中のバッチジョブをキャンセルします。

待機中または実行中のバッチのキャンセルを要求します。レスポンスには現在の状態が返され、キャンセル処理中の場合も、すでにキャンセル済みの場合もあります。すでに終了したバッチは元の終了状態を保持します。終了状態でなければ、バッチを再取得して結果を確認してください。

リクエスト

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キー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。

場所: header

batch_id*string