ファイルとバッチ
バッチのキャンセル
未完了のバッチをキャンセルします。
キューに入っているか実行中のバッチのキャンセルをリクエストします。レスポンスには現在のステータスが含まれます。キャンセル処理がまだ進行中である場合や、すでに完了している場合があります。すでに終了しているバッチは、既存の終端ステータスを維持します。返されたステータスが終端ステータスでない場合は、バッチを再取得して結果を確認してください。不明なバッチIDの場合は 404 batch_not_found が返されます。
リクエスト
curl -X POST "https://api.tokenlab.sh/v1/batches/batch_abc123/cancel" \
-H "Authorization: Bearer sk-your-api-key"レスポンス
{
"id": "batch_abc123",
"object": "batch",
"status": "cancelling",
"input_file_id": "file_abc123"
}idstring
バッチID。
statusstring
現在のバッチステータス。キャンセルリクエストが成功した場合でも、必ず
cancelling が返されるとは限りません。認証
BearerAuth AuthorizationBearer <token>
APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。
場所: header
パスパラメータ
batch_id*string
レスポンス
application/json
application/json
application/json