生成

画像を生成

model でモデルを指定します。async と webhook は即座にジョブを返し、sync と subscribe は最大 30 秒待機します。次のポーリングまで next_poll_after_seconds 秒待ちます。同じ Idempotency-Key と入力の再送は同じジョブを返し、異なる入力は 409 になります。

POST
/v1/creative/image-router/generate
Alpha
curl --request POST 'https://api.orchestor.io/v1/creative/image-router/generate' \  --header "Authorization: Bearer $ORCHESTOR_API_KEY" \  --header 'Content-Type: application/json' \  --header 'Idempotency-Key: 9816bc88-9791-43a1-86c2-876dc7c544e8' \  --data-raw '{"model": "gpt-image-2", "prompt": "白い背景の上に置いた青い陶器の花瓶", "aspect_ratio": "1:1", "mode": "async"}'
{  "data": {    "request_id": "job_7513b52d-3669-4ffe-b317-8b02000715eb",    "job": {      "id": "job_7513b52d-3669-4ffe-b317-8b02000715eb",      "type": "image_generation",      "status": "queued",      "model": "gpt-image-2",      "idempotency_key": "9816bc88-9791-43a1-86c2-876dc7c544e8",      "communication_mode": "async",      "created_at": "2026-11-06T00:00:00Z",      "updated_at": "2026-11-06T00:00:00Z",      "started_at": null,      "completed_at": null,      "canceled_at": null,      "result": null,      "error": null,      "usage_summary": null,      "webhook_delivery": null,      "input": {        "model": "gpt-image-2",        "prompt": "白い背景の上に置いた青い陶器の花瓶",        "aspect_ratio": "1:1",        "mode": "async"      }    },    "status_url": "https://api.orchestor.io/v1/creative/jobs/job_7513b52d-3669-4ffe-b317-8b02000715eb/status",    "result_url": "https://api.orchestor.io/v1/creative/jobs/job_7513b52d-3669-4ffe-b317-8b02000715eb/result",    "events_url": "https://api.orchestor.io/v1/creative/jobs/job_7513b52d-3669-4ffe-b317-8b02000715eb/events",    "cancel_url": "https://api.orchestor.io/v1/creative/jobs/job_7513b52d-3669-4ffe-b317-8b02000715eb/cancel",    "cancelable": true,    "next_action": "poll_status",    "next_poll_after_seconds": 2,    "recommended_poll_interval_seconds": 2,    "retry_after_seconds": null,    "result_ready": false,    "terminal": false,    "idempotency_hit": false,    "usage": {      "credits": 5,      "usd": "0.05"    },    "generation_limits": null  }}

認証

次のいずれかの条件を満たしてください。

  • bearerAuth
  • x-api-key
  • Session cookie

認証の詳細

bearer
Authorization

外部 API キー。session は受け付けません。apiKey と同時に送ると 401 です。

ヘッダー

Idempotency-Keystringheader

同じ入力の再送で同じジョブを返すキー。1〜255 文字の印字可能 ASCII。同じキーで異なる入力を送ると 409 です。

文字数
≥ 1, ≤ 255
パターン
^[ -~]+$

ボディapplication/json必須

以下の入力を JSON で送信します。モデル固有の項目はカタログの対応条件も確認してください。

{  "model": "gpt-image-2",  "prompt": "白い背景の上に置いた青い陶器の花瓶",  "aspect_ratio": "1:1",  "mode": "async"}
追加プロパティ
許可しない
modelstringenum<string>body必須

カタログに掲載されたモデル ID を指定します。利用可能な入力と料金は、呼び出すワークスペースのカタログ行で確認してください。

許可される値
higgsfield-soulsoul-2.0gpt-image-2.5gpt-image-2.5-sunburstgpt-image-2.6gpt-image-2.6-sunburstgpt-image-2nano-banana-2.1nano-banana-2-litenano-banana-2ideogram-vectorideogram-4-5-precise-editseedream-5.5minimax-h3-imageflux-3-imagegpt-image-1.5nano-banana-proseedream-5-liteseedream-4-5-editgrok-imageseedream-v4flux-2-proflux-2-flexideogram-v3recraft-v4qwen-image-layeredqwen-image-anglesideogram-v4.5nano-bananaflux-kontext-maxwan-2.2recraft-v4.1seedream-5-flashz-imageflux-2-maxkling-image-o1kling-image-3-omniseedream-5-prohiggsfield-soul-standardhiggsfield-soul-cinemagrok-imagine-2recraft-v4.1-utilitykling-image-3higgsfield-ai-influencerhiggsfield-ads-studio
promptstringbody必須

生成する内容、または編集で変更したい内容を記述する文章。

文字数
≥ 1
character_element_idstringbody

Soul 2 で使用する、このワークスペースの学習済みキャラクター要素の ID。

パターン
^elem_[a-f0-9-]{36}$
image_urlsstring[]body

編集や参照に使う画像の HTTPS URL。入力は認証なしで取得できる必要があります。

要素数
≥ 1, ≤ 16
image_urls[]stringbody形式:uri
mask_urlstringbody形式:uri

編集する領域を指定するマスク画像の HTTPS URL。対応モデルで使用します。

aspect_ratiostringenum<string>body

出力の幅と高さの比。auto は入力画像に合わせます。モデルの対応値を確認してください。

許可される値
auto1:116:99:164:33:43:22:34:55:49:81:22:11:33:11:44:11:88:19:2121:910:1616:1020:919.5:99:19.59:206:1014:1010:14
image_sizestring | object | stringbody

プリセット、WIDTHxHEIGHT、または width と height のオブジェクト。aspect_ratio より優先されます。

以下のちょうど1つに一致

形式 1: string

image_sizestringenum<string>body
許可される値
squaresquare_hdportrait_16_9landscape_16_9landscape_4_3portrait_4_3autoauto_2Kauto_3Kauto_4K

形式 2: object

追加プロパティ
許可しない
image_size.widthintegerbody必須

画像またはフレームの幅。単位はピクセル。

値の範囲
≥ 1
image_size.heightintegerbody必須

画像またはフレームの高さ。単位はピクセル。

値の範囲
≥ 1

形式 3: string

image_sizestringbody
パターン
^[0-9]+[x×][0-9]+$
qualitystringbody

モデルが受け付ける生成品質。対応する値はカタログで確認します。

resolutionstringenum<string>body

出力の解像度。モデルが対応する値をカタログで確認します。

許可される値
0.5K1K2K4K720p1080p
num_imagesintegerbody

一つのジョブで生成する画像数。共通スキーマの範囲内でもモデル固有の上限が適用されます。

値の範囲
≥ 1, ≤ 10
output_formatstringenum<string>body

成果物のファイル形式。対応する値はモデルによって異なります。

許可される値
pngjpegjpgwebpgifsvg
metadataobjectbody

利用者の追跡用データ。ジョブと関連付けて保存し、モデルには送りません。

modestringenum<string>bodyデフォルト:async

async は即時応答、webhook は終端通知、sync と subscribe は時間を区切って完了を待ちます。

許可される値
asyncsyncsubscribewebhook
webhook_urlstringbody形式:uri

終端イベントを受け取る公開 HTTPS URL(2048 文字以内、既定のポート)。async または webhook モードで指定し、sync とは併用できません。localhost、プライベート、ループバック、リンクローカルのアドレス宛ては指定できません。ジョブが完了、失敗、取消のいずれかになると、ワークスペースの署名シークレットで署名した通知を 1 件送ります。

文字数
≤ 2048
wait_timeout_secondsintegerbody

HTTP 応答を待つ秒数。0〜30。時間を過ぎてもジョブは継続します。

値の範囲
≥ 0, ≤ 30
project_idstringbody

ジョブまたは配置先を関連付けるプロジェクトの ID。

文字数
≤ 200
model_paramsobjectbody

モデル固有設定。通常は省略または空オブジェクト。higgsfield-ai-influencer は tier(normal、freak、total)と selection(グループ ID から最大 4 個の選択 ID への対応)を指定できます。

backgroundstringenum<string>body

GPT Image 2.5 系の背景指定。auto、transparent、opaque。対応モデルだけに指定します。

許可される値
autotransparentopaque
rendering_speedstringenum<string>body

生成速度と品質の配分。TURBO、BALANCED、QUALITY から対応モデルの値を選びます。

許可される値
TURBOBALANCEDQUALITY
complexitystringenum<string>body

描画前の計画量。low、medium、high。GPT Image 2.6 系で使用し、既定は high です。quality とは別の設定です。

許可される値
lowmediumhigh
frame_countintegerbody

GIF のフレーム数。GPT Image 2.6 の GIF 出力で 2〜16、既定は 9。image_size は各フレームのサイズです。

値の範囲
≥ 2, ≤ 16
frame_duration_msintegerbody

GIF の 1 フレームの表示時間。20〜2,000 ミリ秒を 10 ミリ秒単位に丸めます。既定は 200。

値の範囲
≥ 20, ≤ 2000

レスポンス

application/json

生成の受付結果。job.id を保存し、result_ready が false の場合は status_url を指定間隔で取得してください。

ヘッダー

x-orchestor-request-idstringheader

HTTP リクエストの相関 ID。ジョブの request_id とは別の値。

ratelimit-limitintegerheader

現在の期間で許可されるリクエスト数。

ratelimit-remainingintegerheader

現在の期間で残っているリクエスト数。

ratelimit-resetintegerheader

制限がリセットされるまでの秒数。

retry-afterintegerheader

再試行までの待機秒数。

x-orchestor-poll-afterintegerheader

次のジョブ状態取得までの待機秒数。

値の範囲
≥ 0
{  "data": {    "request_id": "job_7513b52d-3669-4ffe-b317-8b02000715eb",    "job": {      "id": "job_7513b52d-3669-4ffe-b317-8b02000715eb",      "type": "image_generation",      "status": "queued",      "model": "gpt-image-2",      "idempotency_key": "9816bc88-9791-43a1-86c2-876dc7c544e8",      "communication_mode": "async",      "created_at": "2026-11-06T00:00:00Z",      "updated_at": "2026-11-06T00:00:00Z",      "started_at": null,      "completed_at": null,      "canceled_at": null,      "result": null,      "error": null,      "usage_summary": null,      "webhook_delivery": null,      "input": {        "model": "gpt-image-2",        "prompt": "白い背景の上に置いた青い陶器の花瓶",        "aspect_ratio": "1:1",        "mode": "async"      }    },    "status_url": "https://api.orchestor.io/v1/creative/jobs/job_7513b52d-3669-4ffe-b317-8b02000715eb/status",    "result_url": "https://api.orchestor.io/v1/creative/jobs/job_7513b52d-3669-4ffe-b317-8b02000715eb/result",    "events_url": "https://api.orchestor.io/v1/creative/jobs/job_7513b52d-3669-4ffe-b317-8b02000715eb/events",    "cancel_url": "https://api.orchestor.io/v1/creative/jobs/job_7513b52d-3669-4ffe-b317-8b02000715eb/cancel",    "cancelable": true,    "next_action": "poll_status",    "next_poll_after_seconds": 2,    "recommended_poll_interval_seconds": 2,    "retry_after_seconds": null,    "result_ready": false,    "terminal": false,    "idempotency_hit": false,    "usage": {      "credits": 5,      "usd": "0.05"    },    "generation_limits": null  }}
dataobject必須

この操作が返す結果。形状は以下の子フィールドを参照してください。

data.request_idstring必須

この生成または HTTP 要求を追跡する ID。HTTP の相関 ID とジョブ ID は別に記録します。

data.jobJob必須

生成ジョブの入力、状態、時刻、結果をまとめた情報。

data.job.idstring必須

状態・結果・取消・通知の照合に使う生成ジョブ ID。

data.job.typestring必須

対象の種類。ジョブでは生成種別、成果物ではメディア種別を示します。

data.job.statusstringenum<string>必須

queued は待機中、processing は生成中。completed、failed、canceled で処理が終了します。

許可される値
queuedprocessingcompletedfailedcanceled
data.job.modelstring | null必須

モデルカタログの ID。モデルが受け付ける入力と制約は対応するカタログ行で確認します。

data.job.idempotency_keystring | null必須

生成の重複を防ぐため送信時に指定したキー。未指定なら null。

data.job.communication_modestringenum<string>必須

生成送信時に選択した応答方式。

許可される値
asyncsyncsubscribewebhook
data.job.created_atstring必須形式:date-time

このリソースを作成した日時。ISO 8601 形式。

data.job.updated_atstring必須形式:date-time

状態を最後に更新した日時。ISO 8601 形式。

data.job.started_atstring | null必須形式:date-time

生成を開始した日時。未開始なら null。

data.job.completed_atstring | null必須形式:date-time

生成が完了した日時。未完了なら null。

data.job.canceled_atstring | null必須形式:date-time

取消が完了した日時。取り消していなければ null。

data.job.resultJobResultPayload | null必須

生成された成果物。処理中や失敗時は null。

data.job.result.artifactsArtifact[]

生成した画像・動画・音声の成果物。各 URL からファイルを取得できます。

data.job.result.artifacts[]Artifact
data.job.result.artifacts[].idstring必須

取得・更新時に指定する、このリソースの一意な識別子。

data.job.result.artifacts[].public_artifact_idstring

生成メディアを外部で照合する不透明な ID。値から所有者や保存先を推測しないでください。

data.job.result.artifacts[].stagestring

first_frame・pose_frame・scene_preview など、成果物が生成工程のどの段階で作られたかを示します。

data.job.result.artifacts[].typestringenum<string>必須

対象の種類。ジョブでは生成種別、成果物ではメディア種別を示します。

許可される値
imagevideoaudiomodelfile
data.job.result.artifacts[].urlstring必須形式:uri

対象ファイルまたは通知先の HTTPS URL。

data.job.result.artifacts[].content_typestring | null必須

ファイルの MIME タイプ。例は image/png、video/mp4。

data.job.result.artifacts[].size_bytesinteger | null

ファイルの正確なサイズ。単位はバイト。

data.job.result.artifacts[].widthinteger | null

画像またはフレームの幅。単位はピクセル。

data.job.result.artifacts[].heightinteger | null

画像またはフレームの高さ。単位はピクセル。

data.job.result.artifacts[].duration_msinteger | null

動画または音声の再生時間。単位はミリ秒。

data.job.result.artifacts[].checksum_sha256string | null

ファイルの SHA-256。取得したバイト列の整合性確認に使用する 64 桁の小文字16進数。

パターン
^[a-f0-9]{64}$
data.job.result.transcript_receiptobject

生成入力が受理済み原稿と一致したことを示す、サーバー発行の証明。

追加プロパティ
許可しない
data.job.result.transcript_receipt.job_idstring必須

検証または結果取得の対象となる生成ジョブの ID。

data.job.result.transcript_receipt.script_revision_idstring必須

受理済み原稿の版を指定する ID。同じ認証文脈で取得した値を使います。

data.job.result.transcript_receipt.sentence_idsstring[]必須

原稿内の文を示す ID の配列。生成入力では重複させず、連続した原稿順に指定します。

data.job.result.transcript_receipt.sentence_ids[]string
data.job.result.transcript_receipt.canonicalization_versionstringenum<string>必須

原稿を NFC と LF に正規化して文へ分割する規則の版。

許可される値
nfc-lf-sentence-v1
data.job.result.transcript_receipt.submitted_transcript_sha256string必須

実際に読み上げへ渡した文章の SHA-256。受理した原稿との一致確認に使います。

パターン
^[a-f0-9]{64}$
data.job.result.transcript_receipt.input_integritystringenum<string>必須

受理済み原稿との結び付きをサーバーが検証した結果。利用者が自己申告する値ではありません。

許可される値
source_bound
data.job.result.generation_configobject | null

モデルが capabilities.settings に公開している音量・速度・感情の設定だけを指定します。

data.job.result.generation_config.volumenumber

音量の倍率。1が元の音量です。モデルごとの範囲内で指定します。

data.job.result.generation_config.speednumber

読み上げ速度。generation_config では数値倍率、直下では旧形式の slow・normal・fast です。

data.job.result.generation_config.emotionstring

読み上げの感情。モデルの対応一覧にある値を指定します。

data.job.result.speedstring | null

読み上げ速度。generation_config では数値倍率、直下では旧形式の slow・normal・fast です。

data.job.result.textstring

文字起こしの文章。文区間ではその区間の文章を返します。

data.job.result.language_codestring | null

文字起こしの言語ヒント。省略時は自動判定し、結果では検出した言語を返します。

data.job.result.language_probabilitynumber | null

検出した言語の確信度。取得できない場合は null です。

data.job.result.wordsobject[]

開始時刻順の単語と秒単位の時刻。TTS の入力では true でこれらの出力を要求します。

data.job.result.words[]object
data.job.result.words[].wordstring

文字起こしされた単語またはトークン。

data.job.result.words[].startnumber

音声の先頭から区間開始までの秒数。

data.job.result.words[].endnumber

音声の先頭から区間終了までの秒数。

data.job.result.words[].typestring

単語や空白など、返されたトークンの分類。

data.job.result.words_truncatedboolean

単語配列が20,000件の上限で切り詰められた場合だけ true を返します。

data.job.result.words_totalinteger

切り詰める前の単語件数。words_truncated と併せて返します。

data.job.result.segmentsobject[]

順番に並ぶ文区間。隣接する区間の境界を共有し、時刻から必要な範囲を切り出せます。

data.job.result.segments[]object
data.job.result.segments[].indexinteger

文区間の順番。0から数えます。

data.job.result.segments[].textstring

文字起こしの文章。文区間ではその区間の文章を返します。

data.job.result.segments[].startnumber

音声の先頭から区間開始までの秒数。

data.job.result.segments[].endnumber

音声の先頭から区間終了までの秒数。

data.job.result.segments[].duration_secondsnumber

処理対象または生成する音声の秒数。STT の申告値は料金を決めず、音楽では対応モデルだけが受け付けます。

data.job.result.audio_urlstring形式:uri

生成音声の取得先 URL。TTS、音楽、声の変換で返します。

data.job.result.video_urlstring形式:uri

声の変換や吹替後の動画の取得先 URL。

data.job.result.model_idstring

実際に音声を生成したエンジンの ID。ジョブの model と区別します。

data.job.result.voiceobject

使用する声の指定。モデルの voice_family に一致する一覧から ID を選びます。

追加プロパティ
許可しない
data.job.result.voice.modestringenum<string>デフォルト:id

声の ID を指定する方式。現在は id のみを受け付けます。

許可される値
id
data.job.result.voice.idstring

生成要求の voice.id に指定する声の ID。表示名ではなく一覧の値をそのまま使います。

文字数
≥ 1, ≤ 128
data.job.result.languagestring

読み上げる言語の BCP-47 または ISO 639 コード。日本語なら ja を明示します。

data.job.result.output_formatobject

出力音声の形式。モデルの capabilities.output_formats にある組み合わせを指定します。

追加プロパティ
許可しない
data.job.result.output_format.containerstringenum<string>

音声ファイルのコンテナ。文ごとの音声切り出しには wav または raw を使います。

許可される値
mp3wavraw
data.job.result.output_format.sample_rateintegerenum<integer>

音声のサンプルレート。単位は Hz。モデルが対応する値を選びます。

許可される値
8000160002205024000320004410048000
data.job.result.output_format.bit_rateintegerenum<integer>

MP3 の毎秒ビット数。MP3 の既定形式を変更するときに指定します。

許可される値
320006400096000128000192000
data.job.result.output_format.encodingstringenum<string>

wav または raw で使用する PCM の符号化形式。

許可される値
pcm_f32lepcm_s16lepcm_mulawpcm_alaw
data.job.result.preview_image_urlstring | null形式:uri

準備済みの代表静止画 URL。まだ使える画像がない場合は null です。

data.job.result.sceneobject | null

背景を文章または写真で指定します。

追加プロパティ
許可しない
data.job.result.scene.typestringenum<string>必須

この要素の形式を選ぶ識別子。選んだ形式の必須フィールドを併せて指定します。

許可される値
promptphotonone
data.job.result.scene.statusstringenum<string>必須

現在の準備・処理状態。利用する前に ready または completed になったことを確認します。

許可される値
queuedprocessingreadyfailedcanceled
data.job.result.scene.preview_image_urlstring | null必須形式:uri

準備済みの代表静止画 URL。まだ使える画像がない場合は null です。

data.job.result.scene.image_urlstring形式:uri

参照する静止画の取得可能な公開 HTTPS URL。人物 ID・ハンドルとの併用はできません。

data.job.result.scene_previewsAvatarVideoScenePreview[]

各シーンの構図を確認する静止画一覧です。

data.job.result.scene_previews[]AvatarVideoScenePreview
追加プロパティ
許可しない
data.job.result.scene_previews[].indexinteger必須

順序付きシーンの中でこの要素が占める位置です。

値の範囲
≥ 0
data.job.result.scene_previews[].idstring

この要素を後で参照・取得するときに使う識別子です。

data.job.result.scene_previews[].statusstringenum<string>必須

現在の準備・処理状態。利用する前に ready または completed になったことを確認します。

許可される値
queuedprocessingreadyfailedcanceled
data.job.result.scene_previews[].preview_image_urlstring | null必須形式:uri

準備済みの代表静止画 URL。まだ使える画像がない場合は null です。

data.job.result.scene_previews[].sceneAvatarVideoScenePreviewReference必須

背景を文章または写真で指定します。

追加プロパティ
許可しない
data.job.result.scene_previews[].scene.typestringenum<string>必須

prompt は文章、photo は写真、props は人物属性を使う入力形式。none は背景指定がない結果を表します。列挙値の範囲で選びます。

許可される値
promptphotonone
data.job.result.scene_previews[].scene.image_urlstring形式:uri

参照する静止画の取得可能な公開 HTTPS URL。人物 ID・ハンドルとの併用はできません。

data.job.result.scene_previews[].avatar_handlestring

再利用する人物のハンドル。先頭の @ を除き小文字で保存します。英数字・ピリオド・アンダースコアを使い、区切り記号の先頭・末尾・連続使用は避けます。

data.job.result.scene_previews[].start_time_secondsnumber

このシーンの開始時刻を秒で示します。

値の範囲
≥ 0
data.job.result.scene_previews[].end_time_secondsnumber

このシーンの終了時刻を秒で示します。

値の範囲
≥ 0
data.job.result.scene_previews[].duration_secondsnumber

出力や料金予約の基準になる長さを秒で指定します。各操作の上限以内の値を使います。

値の範囲
≥ 0
data.job.errorJobError | null必須

失敗理由と再試行に必要な情報。失敗していなければ null。

data.job.error.codeCreativeErrorCodeenum<CreativeErrorCode>

失敗原因を識別する機械処理向けコード。message の文字列で分岐しないでください。

許可される値
bad_requestinvalid_requestunknown_parameterunauthorizedsession_not_acceptedinsufficient_fundsnot_enough_creditsapi_key_spend_limit_exceededinsufficient_scopeopen_key_route_not_allowedopen_key_requirednot_foundidempotency_conflictdraft_expiredjob_not_completedjob_failedjob_canceledjob_generation_already_startedjob_not_cancelablewebhook_not_configuredjob_not_terminalasset_upload_incompletetop_up_in_dashboardpayload_too_largeasset_too_largeunsupported_media_typequeue_fullrate_limitedprovider_rate_limitedinternal_errorbilling_in_dashboardprovider_submission_failedprovider_capacity_exceededprovider_not_configureddatabase_busydeploy_drainingoverloadedreplica_not_readyapi_key_auth_unavailableasset_storage_unavailable
data.job.error.messagestring

利用者に表示できる処理結果または失敗理由の説明。

data.job.error.categorystringenum<string>必須

入力、認証、課金、生成など、失敗原因の分類。

許可される値
validationauthquotaqueuegeneration_unavailablegeneration_rejectedgeneration_timeoutruntime_unavailableworker_timeoutinternal
data.job.error.stagestringenum<string>必須

入力検証、受付、生成、決済など、失敗が発生した段階。

許可される値
validationqueueusage_reservationgeneration_submitgeneration_processingusage_settlementwebhook_deliverycancellationinternal
data.job.error.retryableboolean必須

入力を変えずに後から再試行できるかどうか。

data.job.error.retry_after_secondsinteger | null必須

同じ要求を再試行するまで待つ秒数。再試行不要なら null。

data.job.error.public_reasonstring必須

利用者に公開できる失敗理由の識別子。

data.job.error.next_actionstringenum<string>必須

次に必要な操作。値に従って入力修正、待機、状態確認、結果取得などを行います。

許可される値
fix_inputauthenticateadd_fundsretry_laterpoll_statusinspect_eventscontact_support
data.job.error.detailsobject

失敗原因を調べるための補足情報。内容はエラーコードごとに異なります。

追加プロパティ
許可しない
data.job.error.details.alignment_reasonstringenum<string>

音声と文章の時刻合わせに失敗した理由。

許可される値
invalid_alignment_payloadempty_aligned_wordsinvalid_stt_spanoverlapping_stt_spansnon_monotonic_timingsscript_coverage_mismatch
data.job.error.details.script_word_countinteger

時刻合わせ対象の原稿に含まれる単語数。

値の範囲
≥ 0
data.job.error.details.stt_word_countinteger

音声認識で得られた単語数。

値の範囲
≥ 0
data.job.error.details.ffmpeg_errorstring

メディア処理中のエラーの説明。機密情報を除いた内容です。

data.job.error.details.provider_error_typestring

モデル提供元のエラー分類。

data.job.error.details.provider_error_messagestring

モデル提供元のエラーから公開可能な範囲を取り出した説明。

data.job.error.details.input_fieldstring

問題のある入力フィールドのパス。

data.job.error.details.segment_indexinteger

問題が起きた区間の 0 始まりの位置。

値の範囲
≥ 0
data.job.error.details.source_slotstring

問題がある入力メディアのスロット名。

data.job.error.details.source_statusinteger

入力ファイルの取得先が返した HTTP ステータス。

data.job.error.details.source_hoststring

入力ファイルの取得先ホスト名。認証情報を含めません。

data.job.usage_summaryJobUsageSummary | null必須

ジョブの予約、確定、返金、解放した利用量。

data.job.usage_summary.statusstringenum<string>必須

料金の精算状態。reserved は予約中、captured は確定、refunded は返金済み。

許可される値
reservedcapturedrefunded
data.job.usage_summary.reserved_creditsnumber必須

受付時に予約したクレジット。

値の範囲
≥ 0
data.job.usage_summary.captured_creditsnumber必須

完了により消費が確定したクレジット。

値の範囲
≥ 0
data.job.usage_summary.refunded_creditsnumber必須

失敗や取消により返したクレジット。

値の範囲
≥ 0
data.job.usage_summary.released_creditsnumber必須

未使用の予約を解放したクレジット。

値の範囲
≥ 0
data.job.usage_summary.reserved_usd_centsinteger

予約した料金。単位は USD セント。

値の範囲
≥ 0
data.job.usage_summary.captured_usd_centsinteger

消費が確定した料金。単位は USD セント。

値の範囲
≥ 0
data.job.usage_summary.refunded_usd_centsinteger

返金した料金。単位は USD セント。

値の範囲
≥ 0
data.job.usage_summary.released_usd_centsinteger

未使用の予約から解放した料金。単位は USD セント。

値の範囲
≥ 0
data.job.usage_summary.finalboolean必須

料金の精算が確定し、今後変更しないかどうか。

data.job.usage_summary.updated_atstring必須形式:date-time

状態を最後に更新した日時。ISO 8601 形式。

data.job.webhook_deliveryWebhookDelivery | null必須

終端イベントの配信先、試行回数、直近の応答。

data.job.webhook_delivery.urlstring | null必須形式:uri

対象ファイルまたは通知先の HTTPS URL。

data.job.webhook_delivery.event_typestring | nullenum<string | null>必須

配信した通知の種類。

許可される値
job.completedjob.failedjob.cancelednull
data.job.webhook_delivery.statusstringenum<string>必須

通知の配信状況。exhausted は試行回数の上限に達した状態で、ジョブ自体の成否とは別です。

許可される値
pendingdeliveringdeliveredretryingfailedexhausted
data.job.webhook_delivery.attemptsinteger必須

これまでに行った配信の試行回数。

data.job.webhook_delivery.max_attemptsinteger必須

配信を試みる回数の上限。終端通知は最大 8 回です。

data.job.webhook_delivery.next_attempt_atstring | null必須形式:date-time

再配信を予定している日時。予定がなければ null。

data.job.webhook_delivery.last_attempt_atstring | null必須形式:date-time

最後に配信を試みた日時。未試行なら null。

data.job.webhook_delivery.delivered_atstring | null必須形式:date-time

受信先が 2xx で受領した日時。未配信なら null。

data.job.webhook_delivery.last_status_codeinteger | null必須

直近の配信先の HTTP ステータス。応答がなければ null。

data.job.webhook_delivery.last_errorstring | null必須

直近の配信で発生したエラー。問題がなければ null。

data.job.webhook_delivery.signature_versionstring必須

通知署名の形式。v1 は Standard Webhooks の webhook-signature(<webhook-id>.<webhook-timestamp>.<body> の HMAC-SHA256 を Base64 で表した値)です。同じ通知に orchestor-v1 の署名も付けます。

data.job.webhook_delivery.signing_secret_fingerprintstring | null必須

使用した署名シークレットを区別する指紋。シークレット自体ではありません。

data.job.webhook_delivery.manual_redeliveriesinteger

利用者が手動で再配信を依頼した回数。

値の範囲
≥ 0
data.job.inputobject

生成に使用した入力。ジョブの再現や送信内容の確認に使います。

data.job.preview_image_urlstring | null形式:uri

準備済みの代表静止画 URL。まだ使える画像がない場合は null です。

data.job.sceneobject | null

背景を文章または写真で指定します。

追加プロパティ
許可しない
data.job.scene.typestringenum<string>必須

この要素の形式を選ぶ識別子。選んだ形式の必須フィールドを併せて指定します。

許可される値
promptphotonone
data.job.scene.statusstringenum<string>必須

現在の準備・処理状態。利用する前に ready または completed になったことを確認します。

許可される値
queuedprocessingreadyfailedcanceled
data.job.scene.preview_image_urlstring | null必須形式:uri

準備済みの代表静止画 URL。まだ使える画像がない場合は null です。

data.job.scene.image_urlstring形式:uri

参照する静止画の取得可能な公開 HTTPS URL。人物 ID・ハンドルとの併用はできません。

data.job.scene_previewsAvatarVideoScenePreview[] | null

各シーンの構図を確認する静止画一覧です。

data.job.scene_previews[]AvatarVideoScenePreview
追加プロパティ
許可しない
data.job.scene_previews[].indexinteger必須

順序付きシーンの中でこの要素が占める位置です。

値の範囲
≥ 0
data.job.scene_previews[].idstring

この要素を後で参照・取得するときに使う識別子です。

data.job.scene_previews[].statusstringenum<string>必須

現在の準備・処理状態。利用する前に ready または completed になったことを確認します。

許可される値
queuedprocessingreadyfailedcanceled
data.job.scene_previews[].preview_image_urlstring | null必須形式:uri

準備済みの代表静止画 URL。まだ使える画像がない場合は null です。

data.job.scene_previews[].sceneAvatarVideoScenePreviewReference必須

背景を文章または写真で指定します。

追加プロパティ
許可しない
data.job.scene_previews[].scene.typestringenum<string>必須

prompt は文章、photo は写真、props は人物属性を使う入力形式。none は背景指定がない結果を表します。列挙値の範囲で選びます。

許可される値
promptphotonone
data.job.scene_previews[].scene.image_urlstring形式:uri

参照する静止画の取得可能な公開 HTTPS URL。人物 ID・ハンドルとの併用はできません。

data.job.scene_previews[].avatar_handlestring

再利用する人物のハンドル。先頭の @ を除き小文字で保存します。英数字・ピリオド・アンダースコアを使い、区切り記号の先頭・末尾・連続使用は避けます。

data.job.scene_previews[].start_time_secondsnumber

このシーンの開始時刻を秒で示します。

値の範囲
≥ 0
data.job.scene_previews[].end_time_secondsnumber

このシーンの終了時刻を秒で示します。

値の範囲
≥ 0
data.job.scene_previews[].duration_secondsnumber

出力や料金予約の基準になる長さを秒で指定します。各操作の上限以内の値を使います。

値の範囲
≥ 0
data.job.transcript_receiptobject

原稿と音声の対応関係を確認するための検証結果です。

追加プロパティ
許可しない
data.job.transcript_receipt.job_idstring必須

進行状況の照会に使う関連ジョブの ID です。

data.job.transcript_receipt.script_revision_idstring必須

音声に使った受理済み原稿の版を特定します。

data.job.transcript_receipt.sentence_idsstring[]必須

その音声に含まれる原稿中の文を順番に特定します。

data.job.transcript_receipt.sentence_ids[]string
data.job.transcript_receipt.canonicalization_versionstringenum<string>必須

原稿の比較前に適用した正規化方式の版です。

許可される値
nfc-lf-sentence-v1
data.job.transcript_receipt.submitted_transcript_sha256string必須

送信原稿を比較するための SHA256 値です。

パターン
^[a-f0-9]{64}$
data.job.transcript_receipt.input_integritystringenum<string>必須

送信した原稿の一致を確認するための検証情報です。

許可される値
source_bound
data.job.auth_sourcestring | nullenum<string | null>

ジョブの認証経路を表す分類。資格情報の値は含みません。

許可される値
api_keynull
data.status_urlstring必須形式:uri

このジョブの状態を GET で確認する URL。

data.result_urlstring必須形式:uri

完了後の成果物を GET で取得する URL。

data.events_urlstring必須形式:uri

ジョブの状態遷移と配信履歴を取得する URL。

data.cancel_urlstring | null必須形式:uri

生成開始前に取り消すための POST 先。取り消せない場合は null。

data.cancelableboolean必須

現在このジョブを取り消せるかどうか。

data.next_actionstringenum<string>必須

次に必要な操作。値に従って入力修正、待機、状態確認、結果取得などを行います。

許可される値
poll_statusfetch_resultinspect_events
data.next_poll_after_secondsinteger | null必須

次の状態取得まで待つ秒数。終端状態では null。

data.recommended_poll_interval_secondsinteger | null必須

継続して状態を取得する場合の推奨間隔。単位は秒。

data.retry_after_secondsinteger | null必須

同じ要求を再試行するまで待つ秒数。再試行不要なら null。

data.result_readyboolean必須

成果物を result_url から取得できるかどうか。

data.terminalboolean必須

成功・失敗・取消のいずれかで処理が終了したかどうか。

data.idempotency_hitboolean必須

同じ冪等性キーと入力に対応する既存ジョブを返したかどうか。

data.usageobject必須

この生成の料金予約や決済の情報。

data.usage.creditsnumber | null必須

Creative credits reserved for this generation, captured on completion or released on failure.

値の範囲
≥ 0
data.usage.usdstring

指定した処理の料金。単位は USD。

パターン
^\d+\.\d{2}$
data.usage.costnumber

割引適用後に必要な料金。

値の範囲
≥ 0
data.usage.cost_detailsobject

通常料金、割引、適用元の内訳。

追加プロパティ
許可しない
data.usage.cost_details.list_costnumber必須

割引前の通常料金。

値の範囲
≥ 0
data.usage.cost_details.discountnumber必須

通常料金から差し引く金額。

値の範囲
≥ 0
data.usage.cost_details.discount_sourcestring | nullenum<string | null>必須

適用した割引の種類。適用がなければ null。

許可される値
generation_ticketnull
data.generation_limitsGenerationLimits | null

ワークスペースの同時実行数とキュー受付数の現在値。

data.generation_limits.tierstringenum<string>必須

直近の購入実績などから決まる利用枠の区分。

許可される値
freeprostartupscaleenterprisetier_10tier_100tier_500tier_1000
data.generation_limits.plan_idstringenum<string>必須

受付上限の基準となるプランの ID。

許可される値
freeprostartupscaleenterprise
data.generation_limits.limit_sourcestringenum<string>必須

現在の上限がプラン・購入実績・個別設定のどれに基づくか。

許可される値
planadmin_override
data.generation_limits.purchased_credits_last_4_weeksinteger必須

直近 4 週間に購入したクレジットの合計。

値の範囲
≥ 0
data.generation_limits.purchased_concurrency_limitinteger必須

購入実績に基づく同時実行数の上限。

値の範囲
≥ 1
data.generation_limits.purchased_queued_jobs_limitinteger必須

購入実績に基づく待機ジョブ数の上限。

値の範囲
≥ 1
data.generation_limits.plan_concurrency_limitinteger必須

プランの同時実行数の上限。

値の範囲
≥ 1
data.generation_limits.plan_queued_jobs_limitinteger必須

プランの待機ジョブ数の上限。

値の範囲
≥ 1
data.generation_limits.concurrency_limitinteger必須

現在適用されている同時実行数の上限。

値の範囲
≥ 1
data.generation_limits.queued_jobs_limitinteger必須

キューで待機できるジョブ数の上限。

値の範囲
≥ 0
data.generation_limits.admin_override_expires_atstring | null必須形式:date-time

個別に設定された上限の有効期限。期限がなければ null。

data.generation_limits.accepted_generation_jobs_limitinteger必須

実行中と待機中を合わせて受け付けられるジョブ数の上限。

値の範囲
≥ 1
data.generation_limits.active_generation_jobsinteger必須

現在生成を実行中のジョブ数。

値の範囲
≥ 0
data.generation_limits.queued_generation_jobsinteger必須

現在キューで待機しているジョブ数。

値の範囲
≥ 0
data.generation_limits.accepted_generation_jobsinteger必須

実行中と待機中のジョブ数の合計。

値の範囲
≥ 0
data.generation_limits.queue_capacity_remaininginteger必須

追加で受け付けられるジョブ数。

値の範囲
≥ 0
data.generation_limits.wave_size_hintinteger必須

次に送信するジョブのまとまりの大きさの目安。

値の範囲
≥ 1
data.syncobject | null

sync または subscribe の待機結果。ジョブの完了とは別に確認します。

data.sync.wait_timeout_secondsinteger必須

HTTP 応答を待つ秒数。0〜30。時間を過ぎてもジョブは継続します。

data.sync.completedboolean必須

待機中にジョブが完了状態になったかどうか。

data.sync.terminalboolean必須

成功・失敗・取消のいずれかで処理が終了したかどうか。

data.sync.succeededboolean必須

生成が成功して成果物を取得できるかどうか。

data.sync.failedboolean必須

生成が失敗で終了したかどうか。

data.sync.canceledboolean必須

生成開始前の取消が完了したかどうか。

data.sync.result_readyboolean必須

成果物を result_url から取得できるかどうか。

data.sync.timed_outboolean必須

ジョブが終わる前に HTTP の待機が終了したかどうか。

data.sync.capacity_exhaustedboolean必須

同期待機の枠がなく、ポーリングに切り替える必要があるかどうか。