Creative Generation

動画を生成

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

POST
/v1/creative/video-router/generate
Alpha
curl --request POST 'https://api.orchestor.io/v1/creative/video-router/generate' \  --header "Authorization: Bearer $ORCHESTOR_API_KEY" \  --header 'Content-Type: application/json' \  --header 'Idempotency-Key: 9816bc88-9791-43a1-86c2-876dc7c544e8' \  --data-raw '{"model": "seedance-2.5", "prompt": "草原を流れる雲を固定カメラで撮影", "duration_seconds": 5, "resolution": "480p", "aspect_ratio": "16:9", "mode": "async"}'
{  "data": {    "request_id": "job_7513b52d-3669-4ffe-b317-8b02000715eb",    "job": {      "id": "job_7513b52d-3669-4ffe-b317-8b02000715eb",      "type": "video_generation",      "status": "queued",      "model": "seedance-2.5",      "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": "seedance-2.5",        "prompt": "草原を流れる雲を固定カメラで撮影",        "duration_seconds": 5,        "resolution": "480p",        "aspect_ratio": "16:9",        "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  }}

Authorizations

Satisfy one of these options:

  • bearerAuth
  • x-api-key
  • Session cookie

Authentication details

bearer
Authorization

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

Headers

Idempotency-Keystringheader

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

String length
≥ 1, ≤ 255
Pattern
^[ -~]+$

Bodyapplication/jsonrequired

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

{  "model": "seedance-2.5",  "prompt": "草原を流れる雲を固定カメラで撮影",  "duration_seconds": 5,  "resolution": "480p",  "aspect_ratio": "16:9",  "mode": "async"}
Additional properties
Not allowed
modelstringenum<string>bodyrequired

カタログのモデル ID、または auto- を指定します。auto- は入力に応じてモデルを選ぶため、カタログの個別モデル行には含まれません。

Allowed
higgsfield-genjutsuhiggsfield-genjutsu-object-swaphiggsfield-genjutsu-lighthiggsfield-genjutsu-light-object-swapseedance-2.5seedance-2-miniseedance-2seedance-2-fastkling-3wan-3.0grok-imagine-video-1.5minimax-h3minimax-h3-maxminimax-h3-liteminimax-h3-highspeedwan-2.5-fastgemini-omni-flash-1-2-extendgemini-omni-flash-1.1gemini-omni-flash-1.2vidu-q4vidu-q4-referenceveo-3.1veo-3.1-fastveo-3.1-litekling-4kling-4-omnikling-o1-videoflux-3-video-editminimax-02-fastminimax-02kling-3-omni-editkling-o1-video-editwan-2.2wan-2.2-fastgrok-video-editkling-4-0-flashflux-3-videokling-2.5-turbowan-2.7wan-2.6wan-2.5seedance-proseedance-pro-fastgrok-imagine-videogrok-imagine-video-1.5-litekling-motion-controlkling-3-motion-controlgemini-omni-flash-1-2-editseedance-2.5-editvidu-q3-providu-q3-turbovidu-q3vidu-q3-mixpixverse-c1pixverse-v6wand-vega-1.0-litewand-vega-1.0-prowand-vega-1.5-promingmou-1hailuo-h3-regenheygen-video-1kling-2.6kling-3-turbokling-3-omnihailuo-2.3hailuo-2.3-fasthappy-horse-1.0happy-horse-1.1wan-3.0-primehiggsfield-cinema-studio-4veed-fabric-1.0kling-avatar-2.0-prokling-avatar-2.0omnihuman-1.5omnihuman-2wan-2.2-speech-to-videosync-lipsync-3sync-lipsync-2-prosync-lipsync-2kling-lipsynclatentsyncveed-lipsyncpixverse-lipsyncveed-subtitlesveed-dubbingtopaz-videosam-3.1-videoluma-ray-3.2-reframeorchestor/depth-anything-videoorchestor/depth-anything-v3-videoorchestor/wandauto-
promptstringbody

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

String length
≥ 1
image_urlstringbodyformat:uri

動画の最初のフレーム、または顔画像に使う公開 HTTPS URL。

end_image_urlstringbodyformat:uri

動画の最後のフレームの公開 HTTPS URL。image_url と組み合わせて指定します。

video_urlstringbodyformat:uri

編集・延長などの入力動画の公開 HTTPS URL。

motion_video_urlstringbodyformat:uri

モーション元の動画。motion control モデルのみ

character_orientationstringenum<string>body

video は動作参照動画、image は静止画の構図を優先します。

Allowed
imagevideo
keep_original_soundbooleanbody

true では動作参照動画の音声を残し、false では無音にします。

reference_images(string | object)[]body

参照画像を URL または種類付きのオブジェクトで指定します。モデルごとの上限は capabilities を確認してください。

Item count
≤ 30
reference_images[]string | objectbody

Match at least one of the following

Variant 1: string

reference_images[]stringbodyformat:uri
String length
≤ 2048

Variant 2: object

reference_images[].typestringenum<string>bodyrequired

参照入力の渡し方。URL、アセット ID、Base64 を区別します。

Allowed
urlasset_idbase64
reference_images[].urlstringbodyformat:uri

参照メディアを取得できる URL。URL 形式で渡す場合に使用します。

String length
≤ 2048
reference_videos(string | object)[]body

参照動画を URL または種類付きのオブジェクトで指定します。モデルごとの上限は capabilities を確認してください。

Item count
≤ 10
reference_videos[]string | objectbody

Match at least one of the following

Variant 1: string

reference_videos[]stringbodyformat:uri
String length
≤ 2048

Variant 2: object

reference_videos[].typestringenum<string>bodyrequired

参照入力の渡し方。URL、アセット ID、Base64 を区別します。

Allowed
urlasset_idbase64
reference_videos[].urlstringbodyformat:uri

参照メディアを取得できる URL。URL 形式で渡す場合に使用します。

String length
≤ 2048
reference_audio(string | object)[]body

参照音声を URL または種類付きのオブジェクトで指定します。モデルごとの上限と合計上限は capabilities を確認してください。

Item count
≤ 50
reference_audio[]string | objectbody

Match at least one of the following

Variant 1: string

reference_audio[]stringbodyformat:uri
String length
≤ 2048

Variant 2: object

reference_audio[].typestringenum<string>bodyrequired

参照入力の渡し方。URL、アセット ID、Base64 を区別します。

Allowed
urlasset_idbase64
reference_audio[].urlstringbodyformat:uri

参照メディアを取得できる URL。URL 形式で渡す場合に使用します。

String length
≤ 2048
resolutionstringenum<string>body

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

Allowed
360p480p540p720p768p1080p2K2k4K4k8Khdfhd
duration_secondsintegerbody

生成する動画の長さを秒で指定します。共通範囲は 1〜600 秒で、モデルごとの範囲も適用されます。

Value range
≥ 1, ≤ 600
aspect_ratiostringenum<string>body

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

Allowed
autoadaptive21:92:116:94:31:13:49:163:22:39:21
generate_audiobooleanbody

対応するモデルで動画と同時に音声を生成するかどうか。

metadataobjectbody

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

modestringenum<string>bodydefault:async

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

Allowed
asyncsyncsubscribewebhooktext_to_videoimage_to_videoreference_to_videot2vi2vref2va
webhook_urlstringbodyformat:uri

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

String length
≤ 2048
wait_timeout_secondsintegerbody

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

Value range
≥ 0, ≤ 30
project_idstringbody

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

String length
≤ 200
seedintegerbody

再現性の調整に使う乱数シード。0〜4,294,967,295。

Value range
≥ 0, ≤ 4294967295
taskstringbody

auto- の自動モデル選択に渡す制作意図。名前を指定したモデルでは使用しません。

audio_urlstringbodyformat:uri

リップシンク用の音声の公開 HTTPS URL。顔画像には image_url、顔動画には video_url を使い、duration_seconds も指定します。

model_paramsobjectbody

モデル固有設定の予約領域。現在は省略するか空オブジェクトを指定します。追加のキーは受け付けません。

Additional properties
Not allowed
prompt_enhancementstringenum<string>body

heygen-video-1 の文章補正。15 秒超では turbo、quality、default を使います。default は turbo と同じ指定です。

Allowed
turboqualityultraqualitydisableddefault
end_user_idstringbody

heygen-video-1 に渡す利用者の不透明な ID。1〜128 文字、空白と個人情報を含めません。

String length
≥ 1, ≤ 128
callback_idstringbody

heygen-video-1 の追跡用 ID。最大 256 文字で metadata.callback_id に保存し、通知にも含めます。

String length
≤ 256
draftbooleanbody

seedance-2.5 で 480p の下書きを作成します。duration_seconds が必須で、video_url、extend、source_duration、draft_job_id は併用できません。

draft_job_idstringbody

seedance-2.5 の完了済み下書きの ID。model と、この ID と任意の resolution: 1080p だけを送り、元の入力を引き継ぎます。作成後 14 日以内に使用します。

extendbooleanbody

seedance-2.5 で video_url の続きを生成します。duration_seconds は追加部分の 4〜30 秒です。

source_durationintegerbody

延長する元動画の秒数を切り上げた整数。1〜30。seedance-2.5 の extend で使用し、省略時は 15 秒として料金を計算します。

Value range
≥ 1, ≤ 30
dubbingobjectbody

veed-dubbing の翻訳吹替設定。video_url と 2〜600 秒の duration_seconds が必要で、prompt・resolution・aspect_ratio は指定しません。

Additional properties
Not allowed
dubbing.target_languagestringbodyrequired

吹替先の言語。ko などの BCP 47 基本言語タグで、地域付きのタグは指定できません。

dubbing.source_languagestringbody

入力動画の言語。省略または auto で自動判定します。

captionsobjectbody

veed-subtitles の字幕設定。video_url と 2〜600 秒の duration_seconds が必要です。課金対象は最低 60 秒、既定の resolution は 1080p です。

Additional properties
Not allowed
captions.stylestringbodyrequired

モデルカタログにある字幕のスタイル。動的なスタイルは通常の 2 倍の料金です。

captions.srtstringbody

字幕として使う SRT 文字列。最大 100,000 文字。省略時は動画の音声を文字起こしします。

String length
≤ 100000
captions.positionstringenum<string>body

字幕の表示位置。top は上、center は中央、bottom は下。

Allowed
topcenterbottom
captions.shadowstringenum<string>body

字幕の影の強さ。省略すると選択したスタイルの設定を使います。

Allowed
noneminmidmax
upscaleobjectbody

topaz-video の拡大・補間設定。video_url と切り上げた 2〜60 秒の duration_seconds が必要です。30 fps 超、または fps の省略時は料金が 2 倍になります。

Additional properties
Not allowed
upscale.factornumberbody

縦横それぞれの拡大倍率。1〜4、既定は 2。1 と fps の組み合わせでフレームレートだけを変更できます。

Value range
≥ 1, ≤ 4
upscale.fpsintegerbody

補間後のフレームレート。16〜60。省略すると入力の値を維持します。

Value range
≥ 16, ≤ 60
upscale.modelstringbody

Topaz の補正モデル名。既定は Proteus。対応値はカタログで確認します。

backgroundobjectbody

sam-3.1-video の背景除去設定。prompt で残す対象を示し、video_url と切り上げた 2〜60 秒の duration_seconds を指定します。

Additional properties
Not allowed
background.outputstringenum<string>body

背景除去の結果。sam-3.1-video は cutout(元動画にマスクを適用)のみ対応し、mask は 400 を返します。既定は cutout。

Allowed
cutoutmask
depthobjectbody

対応モデルの動画深度マップの描画設定。元動画の秒数を切り上げた duration_seconds と video_url を指定します。

Additional properties
Not allowed
depth.colormapstringenum<string>body

深度の色付け。既定の grayscale は近くを白、遠くを黒にし、inferno と turbo は色で区別します。

Allowed
grayscaleinfernoturbo
bitrate_modestringenum<string>body

出力のビットレート設定。standard または high を対応モデルで使用します。

Allowed
standardhigh
frame_imagesobject[]body

auto- で使用する開始・終了フレーム。最大 2 件で、image_url と併用できます。

Item count
≤ 2
frame_images[]objectbody
Additional properties
Not allowed
frame_images[].typestringenum<string>bodyrequired

入力メディアの種類。対応する名前のオブジェクトに URL を指定します。

Allowed
image_url
frame_images[].image_urlobjectbodyrequired

参照画像の URL を持つオブジェクト。

Additional properties
Not allowed
frame_images[].image_url.urlstringbodyrequiredformat:uri

認証なしで取得でき、ジョブが終わるまで有効な公開 HTTPS URL。

frame_images[].frame_typestringenum<string>bodyrequired

この画像を first_frame(開始)と last_frame(終了)のどちらに使うか。

Allowed
first_framelast_frame
input_referencesobject[]body

auto- で使用する参照メディア。最大 20 件で、type と同じ種類の URL オブジェクトを指定します。

Item count
≤ 20
input_references[]objectbody
Additional properties
Not allowed
input_references[].typestringenum<string>bodyrequired

入力メディアの種類。対応する名前のオブジェクトに URL を指定します。

Allowed
image_urlaudio_urlvideo_url
input_references[].image_urlobjectbody

参照画像の URL を持つオブジェクト。

Additional properties
Not allowed
input_references[].image_url.urlstringbodyrequiredformat:uri

認証なしで取得でき、ジョブが終わるまで有効な公開 HTTPS URL。

input_references[].audio_urlobjectbody

参照音声の URL を持つオブジェクト。

Additional properties
Not allowed
input_references[].audio_url.urlstringbodyrequiredformat:uri

認証なしで取得でき、ジョブが終わるまで有効な公開 HTTPS URL。

input_references[].video_urlobjectbody

参照動画の URL を持つオブジェクト。

Additional properties
Not allowed
input_references[].video_url.urlstringbodyrequiredformat:uri

認証なしで取得でき、ジョブが終わるまで有効な公開 HTTPS URL。

Response

application/json

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

Headers

x-orchestor-request-idstringheader

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

ratelimit-limitintegerheader

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

ratelimit-remainingintegerheader

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

ratelimit-resetintegerheader

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

retry-afterintegerheader

再試行までの待機秒数。

x-orchestor-poll-afterintegerheader

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

Value range
≥ 0
{  "data": {    "request_id": "job_7513b52d-3669-4ffe-b317-8b02000715eb",    "job": {      "id": "job_7513b52d-3669-4ffe-b317-8b02000715eb",      "type": "video_generation",      "status": "queued",      "model": "seedance-2.5",      "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": "seedance-2.5",        "prompt": "草原を流れる雲を固定カメラで撮影",        "duration_seconds": 5,        "resolution": "480p",        "aspect_ratio": "16:9",        "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  }}
dataobjectrequired

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

data.request_idstringrequired

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

data.jobJobrequired

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

data.job.idstringrequired

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

data.job.typestringrequired

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

data.job.statusstringenum<string>required

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

Allowed
queuedprocessingcompletedfailedcanceled
data.job.modelstring | nullrequired

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

data.job.idempotency_keystring | nullrequired

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

data.job.communication_modestringenum<string>required

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

Allowed
asyncsyncsubscribewebhook
data.job.created_atstringrequiredformat:date-time

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

data.job.updated_atstringrequiredformat:date-time

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

data.job.started_atstring | nullrequiredformat:date-time

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

data.job.completed_atstring | nullrequiredformat:date-time

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

data.job.canceled_atstring | nullrequiredformat:date-time

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

data.job.resultJobResultPayload | nullrequired

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

data.job.result.artifactsArtifact[]

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

data.job.result.artifacts[]Artifact
data.job.result.artifacts[].idstringrequired

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

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>required

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

Allowed
imagevideoaudiomodelfile
data.job.result.artifacts[].urlstringrequiredformat:uri

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

data.job.result.artifacts[].content_typestring | nullrequired

ファイルの 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進数。

Pattern
^[a-f0-9]{64}$
data.job.result.transcript_receiptobject

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

Additional properties
Not allowed
data.job.result.transcript_receipt.job_idstringrequired

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

data.job.result.transcript_receipt.script_revision_idstringrequired

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

data.job.result.transcript_receipt.sentence_idsstring[]required

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

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

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

Allowed
nfc-lf-sentence-v1
data.job.result.transcript_receipt.submitted_transcript_sha256stringrequired

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

Pattern
^[a-f0-9]{64}$
data.job.result.transcript_receipt.input_integritystringenum<string>required

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

Allowed
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_urlstringformat:uri

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

data.job.result.video_urlstringformat:uri

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

data.job.result.model_idstring

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

data.job.result.voiceobject

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

Additional properties
Not allowed
data.job.result.voice.modestringenum<string>default:id

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

Allowed
id
data.job.result.voice.idstring

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

String length
≥ 1, ≤ 128
data.job.result.languagestring

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

data.job.result.output_formatobject

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

Additional properties
Not allowed
data.job.result.output_format.containerstringenum<string>

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

Allowed
mp3wavraw
data.job.result.output_format.sample_rateintegerenum<integer>

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

Allowed
8000160002205024000320004410048000
data.job.result.output_format.bit_rateintegerenum<integer>

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

Allowed
320006400096000128000192000
data.job.result.output_format.encodingstringenum<string>

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

Allowed
pcm_f32lepcm_s16lepcm_mulawpcm_alaw
data.job.result.preview_image_urlstring | nullformat:uri

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

data.job.result.sceneobject | null

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

Additional properties
Not allowed
data.job.result.scene.typestringenum<string>required

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

Allowed
promptphotonone
data.job.result.scene.statusstringenum<string>required

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

Allowed
queuedprocessingreadyfailedcanceled
data.job.result.scene.preview_image_urlstring | nullrequiredformat:uri

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

data.job.result.scene.image_urlstringformat:uri

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

data.job.result.scene_previewsAvatarVideoScenePreview[]

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

data.job.result.scene_previews[]AvatarVideoScenePreview
Additional properties
Not allowed
data.job.result.scene_previews[].indexintegerrequired

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

Value range
≥ 0
data.job.result.scene_previews[].idstring

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

data.job.result.scene_previews[].statusstringenum<string>required

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

Allowed
queuedprocessingreadyfailedcanceled
data.job.result.scene_previews[].preview_image_urlstring | nullrequiredformat:uri

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

data.job.result.scene_previews[].sceneAvatarVideoScenePreviewReferencerequired

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

Additional properties
Not allowed
data.job.result.scene_previews[].scene.typestringenum<string>required

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

Allowed
promptphotonone
data.job.result.scene_previews[].scene.image_urlstringformat:uri

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

data.job.result.scene_previews[].avatar_handlestring

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

data.job.result.scene_previews[].start_time_secondsnumber

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

Value range
≥ 0
data.job.result.scene_previews[].end_time_secondsnumber

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

Value range
≥ 0
data.job.result.scene_previews[].duration_secondsnumber

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

Value range
≥ 0
data.job.errorJobError | nullrequired

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

data.job.error.codeCreativeErrorCodeenum<CreativeErrorCode>

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

Allowed
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>required

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

Allowed
validationauthquotaqueuegeneration_unavailablegeneration_rejectedgeneration_timeoutruntime_unavailableworker_timeoutinternal
data.job.error.stagestringenum<string>required

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

Allowed
validationqueueusage_reservationgeneration_submitgeneration_processingusage_settlementwebhook_deliverycancellationinternal
data.job.error.retryablebooleanrequired

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

data.job.error.retry_after_secondsinteger | nullrequired

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

data.job.error.public_reasonstringrequired

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

data.job.error.next_actionstringenum<string>required

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

Allowed
fix_inputauthenticateadd_fundsretry_laterpoll_statusinspect_eventscontact_support
data.job.error.detailsobject

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

Additional properties
Not allowed
data.job.error.details.alignment_reasonstringenum<string>

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

Allowed
invalid_alignment_payloadempty_aligned_wordsinvalid_stt_spanoverlapping_stt_spansnon_monotonic_timingsscript_coverage_mismatch
data.job.error.details.script_word_countinteger

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

Value range
≥ 0
data.job.error.details.stt_word_countinteger

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

Value range
≥ 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 始まりの位置。

Value range
≥ 0
data.job.error.details.source_slotstring

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

data.job.error.details.source_statusinteger

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

data.job.error.details.source_hoststring

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

data.job.usage_summaryJobUsageSummary | nullrequired

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

data.job.usage_summary.statusstringenum<string>required

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

Allowed
reservedcapturedrefunded
data.job.usage_summary.reserved_creditsnumberrequired

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

Value range
≥ 0
data.job.usage_summary.captured_creditsnumberrequired

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

Value range
≥ 0
data.job.usage_summary.refunded_creditsnumberrequired

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

Value range
≥ 0
data.job.usage_summary.released_creditsnumberrequired

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

Value range
≥ 0
data.job.usage_summary.reserved_usd_centsinteger

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

Value range
≥ 0
data.job.usage_summary.captured_usd_centsinteger

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

Value range
≥ 0
data.job.usage_summary.refunded_usd_centsinteger

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

Value range
≥ 0
data.job.usage_summary.released_usd_centsinteger

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

Value range
≥ 0
data.job.usage_summary.finalbooleanrequired

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

data.job.usage_summary.updated_atstringrequiredformat:date-time

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

data.job.webhook_deliveryWebhookDelivery | nullrequired

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

data.job.webhook_delivery.urlstring | nullrequiredformat:uri

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

data.job.webhook_delivery.event_typestring | nullenum<string | null>required

配信した通知の種類。

Allowed
job.completedjob.failedjob.cancelednull
data.job.webhook_delivery.statusstringenum<string>required

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

Allowed
pendingdeliveringdeliveredretryingfailedexhausted
data.job.webhook_delivery.attemptsintegerrequired

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

data.job.webhook_delivery.max_attemptsintegerrequired

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

data.job.webhook_delivery.next_attempt_atstring | nullrequiredformat:date-time

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

data.job.webhook_delivery.last_attempt_atstring | nullrequiredformat:date-time

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

data.job.webhook_delivery.delivered_atstring | nullrequiredformat:date-time

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

data.job.webhook_delivery.last_status_codeinteger | nullrequired

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

data.job.webhook_delivery.last_errorstring | nullrequired

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

data.job.webhook_delivery.signature_versionstringrequired

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

data.job.webhook_delivery.signing_secret_fingerprintstring | nullrequired

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

data.job.webhook_delivery.manual_redeliveriesinteger

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

Value range
≥ 0
data.job.inputobject

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

data.job.preview_image_urlstring | nullformat:uri

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

data.job.sceneobject | null

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

Additional properties
Not allowed
data.job.scene.typestringenum<string>required

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

Allowed
promptphotonone
data.job.scene.statusstringenum<string>required

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

Allowed
queuedprocessingreadyfailedcanceled
data.job.scene.preview_image_urlstring | nullrequiredformat:uri

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

data.job.scene.image_urlstringformat:uri

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

data.job.scene_previewsAvatarVideoScenePreview[] | null

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

data.job.scene_previews[]AvatarVideoScenePreview
Additional properties
Not allowed
data.job.scene_previews[].indexintegerrequired

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

Value range
≥ 0
data.job.scene_previews[].idstring

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

data.job.scene_previews[].statusstringenum<string>required

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

Allowed
queuedprocessingreadyfailedcanceled
data.job.scene_previews[].preview_image_urlstring | nullrequiredformat:uri

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

data.job.scene_previews[].sceneAvatarVideoScenePreviewReferencerequired

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

Additional properties
Not allowed
data.job.scene_previews[].scene.typestringenum<string>required

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

Allowed
promptphotonone
data.job.scene_previews[].scene.image_urlstringformat:uri

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

data.job.scene_previews[].avatar_handlestring

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

data.job.scene_previews[].start_time_secondsnumber

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

Value range
≥ 0
data.job.scene_previews[].end_time_secondsnumber

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

Value range
≥ 0
data.job.scene_previews[].duration_secondsnumber

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

Value range
≥ 0
data.job.transcript_receiptobject

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

Additional properties
Not allowed
data.job.transcript_receipt.job_idstringrequired

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

data.job.transcript_receipt.script_revision_idstringrequired

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

data.job.transcript_receipt.sentence_idsstring[]required

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

data.job.transcript_receipt.sentence_ids[]string
data.job.transcript_receipt.canonicalization_versionstringenum<string>required

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

Allowed
nfc-lf-sentence-v1
data.job.transcript_receipt.submitted_transcript_sha256stringrequired

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

Pattern
^[a-f0-9]{64}$
data.job.transcript_receipt.input_integritystringenum<string>required

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

Allowed
source_bound
data.job.auth_sourcestring | nullenum<string | null>

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

Allowed
api_keynull
data.status_urlstringrequiredformat:uri

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

data.result_urlstringrequiredformat:uri

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

data.events_urlstringrequiredformat:uri

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

data.cancel_urlstring | nullrequiredformat:uri

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

data.cancelablebooleanrequired

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

data.next_actionstringenum<string>required

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

Allowed
poll_statusfetch_resultinspect_events
data.next_poll_after_secondsinteger | nullrequired

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

data.recommended_poll_interval_secondsinteger | nullrequired

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

data.retry_after_secondsinteger | nullrequired

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

data.result_readybooleanrequired

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

data.terminalbooleanrequired

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

data.idempotency_hitbooleanrequired

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

data.usageobjectrequired

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

data.usage.creditsnumber | nullrequired

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

Value range
≥ 0
data.usage.usdstring

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

Pattern
^\d+\.\d{2}$
data.usage.costnumber

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

Value range
≥ 0
data.usage.cost_detailsobject

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

Additional properties
Not allowed
data.usage.cost_details.list_costnumberrequired

割引前の通常料金。

Value range
≥ 0
data.usage.cost_details.discountnumberrequired

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

Value range
≥ 0
data.usage.cost_details.discount_sourcestring | nullenum<string | null>required

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

Allowed
generation_ticketnull
data.generation_limitsGenerationLimits | null

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

data.generation_limits.tierstringenum<string>required

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

Allowed
freeprostartupscaleenterprisetier_10tier_100tier_500tier_1000
data.generation_limits.plan_idstringenum<string>required

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

Allowed
freeprostartupscaleenterprise
data.generation_limits.limit_sourcestringenum<string>required

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

Allowed
planadmin_override
data.generation_limits.purchased_credits_last_4_weeksintegerrequired

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

Value range
≥ 0
data.generation_limits.purchased_concurrency_limitintegerrequired

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

Value range
≥ 1
data.generation_limits.purchased_queued_jobs_limitintegerrequired

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

Value range
≥ 1
data.generation_limits.plan_concurrency_limitintegerrequired

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

Value range
≥ 1
data.generation_limits.plan_queued_jobs_limitintegerrequired

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

Value range
≥ 1
data.generation_limits.concurrency_limitintegerrequired

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

Value range
≥ 1
data.generation_limits.queued_jobs_limitintegerrequired

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

Value range
≥ 0
data.generation_limits.admin_override_expires_atstring | nullrequiredformat:date-time

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

data.generation_limits.accepted_generation_jobs_limitintegerrequired

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

Value range
≥ 1
data.generation_limits.active_generation_jobsintegerrequired

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

Value range
≥ 0
data.generation_limits.queued_generation_jobsintegerrequired

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

Value range
≥ 0
data.generation_limits.accepted_generation_jobsintegerrequired

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

Value range
≥ 0
data.generation_limits.queue_capacity_remainingintegerrequired

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

Value range
≥ 0
data.generation_limits.wave_size_hintintegerrequired

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

Value range
≥ 1
data.syncobject | null

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

data.sync.wait_timeout_secondsintegerrequired

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

data.sync.completedbooleanrequired

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

data.sync.terminalbooleanrequired

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

data.sync.succeededbooleanrequired

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

data.sync.failedbooleanrequired

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

data.sync.canceledbooleanrequired

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

data.sync.result_readybooleanrequired

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

data.sync.timed_outbooleanrequired

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

data.sync.capacity_exhaustedbooleanrequired

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