Skip to main content
POST
バッチをキャンセル
ワークスペースのプレビュー機能へのアクセスが必要です。設定、Webhook、結果の処理については、動画とバッチのジョブを参照してください。

承認

Authorization
string
header
必須

Bearer トークンによる認証

パスパラメータ

batch_id
string
必須

キャンセルするバッチのID。

レスポンス

バッチ状態のレスポンス

id
string
native_batch_id
string | null

ゲートウェイが所有するIDと異なる場合の、プロバイダー固有のバッチID。

object
string
endpoint
string
errors
object
input_file_id
string
completion_window
string
status
string
lifecycle_status
enum<string>

ポーリング、WebSocket、Webhookの利用側向けに正規化された非同期ライフサイクル状態。

利用可能なオプション:
pending,
running,
completed,
failed,
cancelled,
expired
progress
integer

プロバイダーのリクエスト数から算出するバッチのおおよその完了率(取得できる場合)。完了したバッチは100を報告します。

必須範囲: 0 <= x <= 100
polling_url
string<uri>
websocket_url
string<uri>

非同期ジョブの正規化されたライフサイクル更新を購読するWebSocket URL。

cancel_url
string<uri> | null

互換性のために予約されています。現在は常にnullです。

results_url
string<uri> | null

対応する終端状態バッチ用の認証付きPhaseo JSONLダウンロードURL。処理中はnullです。終端状態のバッチに出力がない場合もあります。所有ワークスペースのAPIキーを使用してください。プロバイダーの保持期限が適用されます。

output_file_id
string
error_file_id
string
created_at
integer
in_progress_at
integer
expires_at
integer
finalizing_at
integer
completed_at
integer
failed_at
integer
expired_at
integer
cancelling_at
integer
cancelled_at
integer
request_counts
object
metadata
object
request_id
string
provider
string
session_id
string
webhook
object

機密情報を除去した非同期Webhook設定と配信状態。シークレットは返されません。has_secretは署名付き配信が有効かを示します。署名付き配信にはx-phaseo-signature、x-phaseo-timestamp、x-phaseo-event-id、x-phaseo-event-type、x-phaseo-delivery-key、x-phaseo-attempt、x-phaseo-max-attemptsヘッダーが含まれます。

next_webhook_retry_at
string | null
last_webhook_progress
number | null
last_webhook_progress_at
string | null
last_webhook_dispatched_at
string | null
finalized_at
string | null
pricing_lines
object[]
usage
object

確定後の正規化された集計使用量とコスト。

billing
object
最終更新日 2026年10月2日