API リファレンス

ヘッダー

リクエストヘッダー

ヘッダー必須対象説明
Authorizationはい各 APIBearer YOUR_API_KEY。認証を参照してください。
Content-Type本文がある場合JSON 本文を送る APIapplication/json。
Idempotency-Keyいいえ生成要求1〜255文字の印字可能 ASCII。UUID を推奨します。同じキーと入力の再送は、元のジョブに結び付きます。冪等性キーを参照してください。

x-api-key でも認証できます。Authorization と同時に指定せず、どちらか一方を使用してください。

クエリパラメーター

パラメーター対象説明
limitジョブ一覧・イベント取得1ページで返す件数。操作ごとの上限を確認してください。
typeジョブ一覧生成ジョブの種類で絞り込みます。
statusジョブ一覧ジョブの処理状態で絞り込みます。
starting_afterジョブ一覧前の応答の next_cursor。先頭ページでは省略します。

Webhook の通知先はクエリではなく、生成要求の JSON 本文の webhook_url に指定します。mode: "webhook" と組み合わせてください。Webhookで送信例を確認できます。

レスポンスヘッダー

ヘッダー対象説明
x-orchestor-request-idAPI 応答HTTP 要求の相関 ID。生成ジョブの ID と分けて記録し、問い合わせに添えます。
ratelimit-limitレート制限情報を含む応答現在の期間に許可される要求数。
ratelimit-remainingレート制限情報を含む応答現在の期間に残っている要求数。
ratelimit-resetレート制限情報を含む応答制限がリセットされるまでの秒数。
retry-after再試行の待機時間を含む応答次の試行まで待つ秒数。レート制限を参照してください。
x-orchestor-poll-afterジョブ状態取得の応答次の状態取得まで待つ秒数。

Webhook 配信ヘッダー

Orchestor から受信先へ送るWebhookに付与します。

ヘッダー説明
x-orchestor-webhook-timestamp署名に使用した Unix 時刻(秒)。現在時刻との差が300秒以内か確認します。
x-orchestor-webhook-signatureorchestor-v1= に続く HMAC-SHA256 の16進数。複数署名はカンマ区切りです。
x-orchestor-webhook-secret-fingerprint署名シークレットの世代を識別する指紋。秘密値ではありません。

署名対象は <timestamp>.<raw body> です。本文を再シリアライズせず、受信時のバイト列を検証します。重複処理の防止には、検証済み本文の job_id を使用してください。

関連ページ