API リファレンス
ヘッダー
リクエストヘッダー
x-api-key でも認証できます。Authorization と同時に指定せず、どちらか一方を使用してください。
クエリパラメーター
| パラメーター | 対象 | 説明 |
|---|---|---|
limit | ジョブ一覧・イベント取得 | 1ページで返す件数。操作ごとの上限を確認してください。 |
type | ジョブ一覧 | 生成ジョブの種類で絞り込みます。 |
status | ジョブ一覧 | ジョブの処理状態で絞り込みます。 |
starting_after | ジョブ一覧 | 前の応答の next_cursor。先頭ページでは省略します。 |
Webhook の通知先はクエリではなく、生成要求の JSON 本文の webhook_url に指定します。mode: "webhook" と組み合わせてください。Webhookで送信例を確認できます。
レスポンスヘッダー
| ヘッダー | 対象 | 説明 |
|---|---|---|
x-orchestor-request-id | API 応答 | 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-signature | orchestor-v1= に続く HMAC-SHA256 の16進数。複数署名はカンマ区切りです。 |
x-orchestor-webhook-secret-fingerprint | 署名シークレットの世代を識別する指紋。秘密値ではありません。 |
署名対象は <timestamp>.<raw body> です。本文を再シリアライズせず、受信時のバイト列を検証します。重複処理の防止には、検証済み本文の job_id を使用してください。