認証
FECINE API Key を Bearer トークンとして使用します。閲覧にアカウントは不要です。
FECINE OPEN API v1.1.0
API リファレンス
脚本から完成映像まで。FECINE API で制作ワークフローをつなぎましょう。
作成と実行
作品を作成して脚本・素材をアップロードし、キャラクター・背景・小道具・グリッドを登録します。エピソードとシーンを作成し、参照を関連付けて動画を生成します。各シーンのテイクを選択して最終版を書き出します。生成完了を待って次へ進み、編集時は最新の revision を送信してください。アップロードした脚本から構成する場合は、別途ビルドを実行します。
結果の取得
状態を照会するか Webhook を受信します。アセット ID から署名付きダウンロードリンクを取得できます。
最初のリクエスト
curl -X GET 'https://YOUR_FECINE_HOST/api/v1/capabilities' \
-H 'Authorization: Bearer YOUR_FECINE_API_KEY'REFERENCE
API リファレンス
一致するエンドポイントはありません
FECINE エラー。お問い合わせには request_id を添えてください。
JSON の例をコピーし、ID・URL・内容を実際の値に置き換えてください。
利用可能な機能
GET/api/v1/capabilitiesいま使える機能を見る
現在の API 環境で利用できる機能・モデル・アップロード形式と制作上限を取得します。
必要な権限: projects:read
パラメーター
パラメーターなし
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"items": [
{
"studio_workflow": {
"equivalent": false,
"stages": [
"script"
],
"project_access": "read_only",
"gaps": [
"example"
]
},
"template_id": "example",
"template_version": 1,
"enabled": false,
"stages": [
"example"
],
"output_profiles": [
"example"
],
"unsupported_reasons": [
"example"
],
"max_shots": 1,
"max_episode_seconds": 1,
"upload_mime_types": [
"example"
],
"max_upload_bytes": 1
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
プロジェクト・資料
GET/api/v1/worksプロジェクト一覧を見る
アクセス可能な作品を取得します。state で状態を絞り込み、cursor と limit でページを指定します。
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
cursorquery | string | — |
|
limitquery | integer | — |
|
statequery | string | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"name": "example",
"revision": 1,
"state": "active",
"created_at": "2026-09-20T00:00:00Z",
"client_reference": "example"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works新しいプロジェクトを作る
name を指定して作品を作成します。返された作品 ID で素材を追加し、制作を進めます。
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
name | string | * |
|
client_reference | string | — |
|
最初のリクエスト · JSON
{
"name": "example"
}レスポンス
HTTP 201 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"name": "example",
"revision": 1,
"state": "active",
"created_at": "2026-09-20T00:00:00Z",
"client_reference": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{project_id}プロジェクトの情報を見る
作品名・状態・現在の revision を取得します。編集や制作のリクエスト前に最新版を確認できます。
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"name": "example",
"revision": 1,
"state": "active",
"created_at": "2026-09-20T00:00:00Z",
"client_reference": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PATCH/api/v1/works/{project_id}プロジェクトの情報を変更する
作品名や active・archived の状態を変更します。最新の ETag を If-Match に指定してください。
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
If-Matchheader | string | * | 最新の ETag を引用符も含めて入力してください。 |
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
name | string | — |
|
state | string | — |
|
最初のリクエスト · JSON
{}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"name": "example",
"revision": 1,
"state": "active",
"created_at": "2026-09-20T00:00:00Z",
"client_reference": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{project_id}/resourcesアップロードした資料の一覧を見る
作品の脚本・キャラクター・シーン・小道具・エピソード・ショットを取得します。kind で種類を選べます。
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
kindquery | string | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"content": {
"kind": "script",
"name": "example",
"data": {
"language": "example"
}
},
"created_at": "2026-09-20T00:00:00Z"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{project_id}/resources脚本や画像などの資料を登録する
kind と data で脚本文やショット情報を作品に登録します。ファイル本体は /uploads で送信します。
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
kind | string | * | kind = script
|
name | string | * | kind = script
|
data | object | * | kind = scripttext と source_asset_id のどちらか一方だけを指定してください。 |
data.text | string | — | kind = script
|
data.source_asset_id | string | — | kind = script
|
data.language | string | * | kind = script
|
kind | string | * | kind = character
|
name | string | * | kind = character
|
data | object | * | kind = character |
data.description | string | * | kind = character
|
data.reference_asset_ids | array | — | kind = character
|
kind | string | * | kind = scene
|
name | string | * | kind = scene
|
data | object | * | kind = scene |
data.description | string | * | kind = scene
|
data.reference_asset_ids | array | — | kind = scene
|
kind | string | * | kind = prop
|
name | string | * | kind = prop
|
data | object | * | kind = prop |
data.description | string | * | kind = prop
|
data.reference_asset_ids | array | — | kind = prop
|
kind | string | * | kind = episode
|
name | string | * | kind = episode
|
data | object | * | kind = episode |
data.script_resource_id | string | * | kind = episode
|
data.sequence | integer | * | kind = episode
|
data.raw_content | string | — | kind = episode
|
data.description | string | — | kind = episode
|
kind | string | * | kind = shot
|
name | string | * | kind = shot
|
data | object | * | kind = shot |
data.episode_id | string | * | kind = shot
|
data.scene_id | string | — | kind = shot
|
data.character_ids | array | — | kind = shot
|
data.prop_ids | array | — | kind = shot
|
data.description | string | * | kind = shot
|
data.video_prompt | oneOf | — | kind = shot |
data.sequence | integer | — | kind = shot
|
data.duration_seconds | integer | * | kind = shot
|
data.selected_image_asset_id | string | — | kind = shot
|
data.selected_video_asset_id | string | — | kind = shot
|
最初のリクエスト · JSON
{
"kind": "script",
"name": "example",
"data": {
"language": "example"
}
}レスポンス
HTTP 201 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"content": {
"kind": "script",
"name": "example",
"data": {
"language": "example"
}
},
"created_at": "2026-09-20T00:00:00Z"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{project_id}/resources/{resource_id}資料を 1 件見る
作品内の resource_id で指定した資料の種類・内容・revision を取得します。
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
resource_idpath | string | * |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"content": {
"kind": "script",
"name": "example",
"data": {
"language": "example"
}
},
"created_at": "2026-09-20T00:00:00Z"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PATCH/api/v1/works/{project_id}/resources/{resource_id}資料を修正する
資料の kind と data を更新します。編集の競合を防ぐため、最新 ETag を If-Match に指定してください。
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
resource_idpath | string | * |
|
If-Matchheader | string | * | 最新の ETag を引用符も含めて入力してください。 |
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
kind | string | * | kind = script
|
name | string | * | kind = script
|
data | object | * | kind = scripttext と source_asset_id のどちらか一方だけを指定してください。 |
data.text | string | — | kind = script
|
data.source_asset_id | string | — | kind = script
|
data.language | string | * | kind = script
|
kind | string | * | kind = character
|
name | string | * | kind = character
|
data | object | * | kind = character |
data.description | string | * | kind = character
|
data.reference_asset_ids | array | — | kind = character
|
kind | string | * | kind = scene
|
name | string | * | kind = scene
|
data | object | * | kind = scene |
data.description | string | * | kind = scene
|
data.reference_asset_ids | array | — | kind = scene
|
kind | string | * | kind = prop
|
name | string | * | kind = prop
|
data | object | * | kind = prop |
data.description | string | * | kind = prop
|
data.reference_asset_ids | array | — | kind = prop
|
kind | string | * | kind = episode
|
name | string | * | kind = episode
|
data | object | * | kind = episode |
data.script_resource_id | string | * | kind = episode
|
data.sequence | integer | * | kind = episode
|
data.raw_content | string | — | kind = episode
|
data.description | string | — | kind = episode
|
kind | string | * | kind = shot
|
name | string | * | kind = shot
|
data | object | * | kind = shot |
data.episode_id | string | * | kind = shot
|
data.scene_id | string | — | kind = shot
|
data.character_ids | array | — | kind = shot
|
data.prop_ids | array | — | kind = shot
|
data.description | string | * | kind = shot
|
data.video_prompt | oneOf | — | kind = shot |
data.sequence | integer | — | kind = shot
|
data.duration_seconds | integer | * | kind = shot
|
data.selected_image_asset_id | string | — | kind = shot
|
data.selected_video_asset_id | string | — | kind = shot
|
最初のリクエスト · JSON
{
"kind": "script",
"name": "example",
"data": {
"language": "example"
}
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"content": {
"kind": "script",
"name": "example",
"data": {
"language": "example"
}
},
"created_at": "2026-09-20T00:00:00Z"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{project_id}/workflowスタジオ制作データを取得
作品の脚本・エピソード・デザイン・シーン・アセット・テイク・カット選択と最新 revision をまとめて取得します。
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"api_runs": [
{
"id": "11111111-1111-4111-8111-111111111111",
"state": "example",
"created_at": "example",
"completed_at": "example",
"total_steps": 0,
"completed_steps": 0,
"error_code": "example"
}
],
"work_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example",
"trash": [
{
"id": "11111111-1111-4111-8111-111111111111",
"entity_type": "asset",
"name": "example",
"deleted_at": "example"
}
],
"assets": [
{
"id": "11111111-1111-4111-8111-111111111111",
"name": "example",
"kind": "example",
"media_type": "example",
"status": "example",
"mime": "example",
"lineage_id": "11111111-1111-4111-8111-111111111111",
"version": 1,
"is_current_version": false
}
],
"settings": {
"title": "example",
"tags": [
"example"
],
"cover": "example",
"aspect": "example",
"resolution": "example",
"style": "example",
"style_prompt": "example",
"state": "example"
},
"script": {
"text": "example",
"logline": "example",
"synopsis": "example"
},
"episodes": [
{
"id": "11111111-1111-4111-8111-111111111111",
"number": 1,
"title": "example",
"raw_content": "example",
"description": "example"
}
],
"designs": [
{
"id": "11111111-1111-4111-8111-111111111111",
"kind": "character",
"name": "example",
"description": "example",
"tags": [
"example"
],
"primary_asset_id": "11111111-1111-4111-8111-111111111111"
}
],
"scenes": [
{
"id": "11111111-1111-4111-8111-111111111111",
"episode_id": "11111111-1111-4111-8111-111111111111",
"number": 1,
"heading": "example",
"description": "example",
"video_prompt": "example"
}
],
"scene_designs": [
{
"scene_id": "11111111-1111-4111-8111-111111111111",
"design_id": "11111111-1111-4111-8111-111111111111",
"kind": "example",
"position": 1
}
],
"takes": [
{
"scene_id": "11111111-1111-4111-8111-111111111111",
"asset_id": "11111111-1111-4111-8111-111111111111",
"position": 1
}
],
"cut_selections": [
{
"scene_id": "11111111-1111-4111-8111-111111111111",
"asset_id": "11111111-1111-4111-8111-111111111111"
}
],
"design_assets": [
{
"design_id": "11111111-1111-4111-8111-111111111111",
"asset_id": "11111111-1111-4111-8111-111111111111",
"kind": "example",
"name": "example",
"position": 1
}
]
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{project_id}/script/analysesスタジオの脚本を分析
作品の脚本を分析して制作構造を抽出します。script_text を指定すると更新後に分析し、省略時は保存済み脚本を使います。getJob で進捗を確認します。
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
model | string | — |
|
script_text | string | — |
|
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
POST/api/v1/works/{project_id}/script/builds脚本から制作全体を構成
検証済みの script_asset_ids と revision で脚本・参照項目・絵コンテを構成します。full_rebuild は既存の構成を置き換えます。画像と動画は別途生成します。 Studioと同じ料金で、報告された実際の入力・出力トークンを精算します。リクエストごとのクレジット上限は指定しません。 GET /jobs/{job_id} → output_asset_ids.
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
model | string | — |
|
script_asset_ids | array | — |
|
material_scope | string | — |
|
preprocess | object | — | |
preprocess.ignoreAttachments | boolean | — |
|
preprocess.discardKeywords | array | — |
|
preprocess.keepLabels | array | — |
|
rebuild_policy | string | * |
|
最初のリクエスト · JSON
{
"revision": 1,
"rebuild_policy": "full_rebuild"
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
GET/api/v1/works/{project_id}/library共有ライブラリ素材を取得
作品に取り込める資料を取得します。scope=personal は個人ライブラリ、既定の scope=studio は共有ライブラリです。
必要な権限: assets:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
limit | integer | — |
|
cursor | string | — | |
scope | string | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"name": "example",
"kind": "example",
"media_type": "example",
"mime": "example",
"version": 1,
"is_current_version": false
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{project_id}/imports素材を作品に取り込む
asset_id の個人・共有資料を作品のコピーとして取り込みます。元資料の変更や削除はコピーに影響しません。
必要な権限: assets:write, assets:read, projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
asset_id | string | * |
|
最初のリクエスト · JSON
{
"revision": 1,
"asset_id": "11111111-1111-4111-8111-111111111111"
}レスポンス
HTTP 201 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"state": "pending",
"mime_type": "example",
"size_bytes": 0,
"download_url": "example",
"expires_at": "2026-09-20T00:00:00Z"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{project_id}/script/drafts脚本の下書きを生成
instructions、任意の source_text、revision、max_output_tokens を送信します。既存の脚本を上書きせず新規資料として保存します。 Studioと同じ料金で、報告された実際の入力・出力トークンを精算します。リクエストごとのクレジット上限は指定しません。 GET /jobs/{job_id} → output_asset_ids.
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
model | string | — |
|
instructions | string | * |
|
source_text | string | — |
|
max_output_tokens | integer | — |
|
最初のリクエスト · JSON
{
"revision": 1,
"instructions": "example"
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
GET/api/v1/works/{work_id}/charactersキャラクター · 取得 (list)
キャラクター · 取得 (list). GET /api/v1/works/{work_id}/characters. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"kind": "character",
"name": "example",
"description": "example",
"tags": [
"example"
],
"primary_asset_id": "11111111-1111-4111-8111-111111111111"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/charactersキャラクター · 登録
キャラクター · 登録. POST /api/v1/works/{work_id}/characters. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
name | string | * |
|
description | string | — |
|
tags | array | — |
|
revision | integer | * |
最初のリクエスト · JSON
{
"name": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{work_id}/characters/{reference_id}キャラクター · 取得
キャラクター · 取得. GET /api/v1/works/{work_id}/characters/{reference_id}. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"kind": "character",
"name": "example",
"description": "example",
"tags": [
"example"
],
"primary_asset_id": "11111111-1111-4111-8111-111111111111"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PATCH/api/v1/works/{work_id}/characters/{reference_id}キャラクター · 更新
キャラクター · 更新. PATCH /api/v1/works/{work_id}/characters/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
name | string | * |
|
description | string | — |
|
tags | array | — |
|
revision | integer | * |
最初のリクエスト · JSON
{
"name": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
DELETE/api/v1/works/{work_id}/characters/{reference_id}キャラクター · 削除
キャラクター · 削除. DELETE /api/v1/works/{work_id}/characters/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PUT/api/v1/works/{work_id}/characters/{reference_id}/primary-imageキャラクター · 参照画像を設定
キャラクター · 参照画像を設定. PUT /api/v1/works/{work_id}/characters/{reference_id}/primary-image. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
asset_id | string | * |
|
current_asset_id | oneOf | * | |
revision | integer | * |
最初のリクエスト · JSON
{
"asset_id": "11111111-1111-4111-8111-111111111111",
"current_asset_id": "11111111-1111-4111-8111-111111111111",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/characters/{reference_id}/image-generationsキャラクター · 参照画像を生成
キャラクター · 参照画像を生成. POST /api/v1/works/{work_id}/characters/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
variants | integer | — |
|
model | string | — |
|
prompt | string | — |
|
aspect_ratio | string | — | |
image_size | string | — |
|
quality | string | — |
|
background | string | — |
|
output_format | string | — |
|
reference_asset_ids | array | — |
|
slot | string | — |
|
variant_name | string | — |
|
current_asset_id | string | — |
|
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}キャラクター · シーンに関連付け
キャラクター · シーンに関連付け. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
scene_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}キャラクター · シーンから解除
キャラクター · シーンから解除. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/characters/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
scene_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{work_id}/background-scenes背景シーン · 取得 (list)
背景シーン · 取得 (list). GET /api/v1/works/{work_id}/background-scenes. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"kind": "character",
"name": "example",
"description": "example",
"tags": [
"example"
],
"primary_asset_id": "11111111-1111-4111-8111-111111111111"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/background-scenes背景シーン · 登録
背景シーン · 登録. POST /api/v1/works/{work_id}/background-scenes. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
name | string | * |
|
description | string | — |
|
tags | array | — |
|
revision | integer | * |
最初のリクエスト · JSON
{
"name": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{work_id}/background-scenes/{reference_id}背景シーン · 取得
背景シーン · 取得. GET /api/v1/works/{work_id}/background-scenes/{reference_id}. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"kind": "character",
"name": "example",
"description": "example",
"tags": [
"example"
],
"primary_asset_id": "11111111-1111-4111-8111-111111111111"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PATCH/api/v1/works/{work_id}/background-scenes/{reference_id}背景シーン · 更新
背景シーン · 更新. PATCH /api/v1/works/{work_id}/background-scenes/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
name | string | * |
|
description | string | — |
|
tags | array | — |
|
revision | integer | * |
最初のリクエスト · JSON
{
"name": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
DELETE/api/v1/works/{work_id}/background-scenes/{reference_id}背景シーン · 削除
背景シーン · 削除. DELETE /api/v1/works/{work_id}/background-scenes/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PUT/api/v1/works/{work_id}/background-scenes/{reference_id}/primary-image背景シーン · 参照画像を設定
背景シーン · 参照画像を設定. PUT /api/v1/works/{work_id}/background-scenes/{reference_id}/primary-image. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
asset_id | string | * |
|
current_asset_id | oneOf | * | |
revision | integer | * |
最初のリクエスト · JSON
{
"asset_id": "11111111-1111-4111-8111-111111111111",
"current_asset_id": "11111111-1111-4111-8111-111111111111",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/background-scenes/{reference_id}/image-generations背景シーン · 参照画像を生成
背景シーン · 参照画像を生成. POST /api/v1/works/{work_id}/background-scenes/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
variants | integer | — |
|
model | string | — |
|
prompt | string | — |
|
aspect_ratio | string | — | |
image_size | string | — |
|
quality | string | — |
|
background | string | — |
|
output_format | string | — |
|
reference_asset_ids | array | — |
|
slot | string | — |
|
variant_name | string | — |
|
current_asset_id | string | — |
|
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}背景シーン · シーンに関連付け
背景シーン · シーンに関連付け. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
scene_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}背景シーン · シーンから解除
背景シーン · シーンから解除. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/background-scenes/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
scene_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{work_id}/props小道具 · 取得 (list)
小道具 · 取得 (list). GET /api/v1/works/{work_id}/props. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"kind": "character",
"name": "example",
"description": "example",
"tags": [
"example"
],
"primary_asset_id": "11111111-1111-4111-8111-111111111111"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/props小道具 · 登録
小道具 · 登録. POST /api/v1/works/{work_id}/props. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
name | string | * |
|
description | string | — |
|
tags | array | — |
|
revision | integer | * |
最初のリクエスト · JSON
{
"name": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{work_id}/props/{reference_id}小道具 · 取得
小道具 · 取得. GET /api/v1/works/{work_id}/props/{reference_id}. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"kind": "character",
"name": "example",
"description": "example",
"tags": [
"example"
],
"primary_asset_id": "11111111-1111-4111-8111-111111111111"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PATCH/api/v1/works/{work_id}/props/{reference_id}小道具 · 更新
小道具 · 更新. PATCH /api/v1/works/{work_id}/props/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
name | string | * |
|
description | string | — |
|
tags | array | — |
|
revision | integer | * |
最初のリクエスト · JSON
{
"name": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
DELETE/api/v1/works/{work_id}/props/{reference_id}小道具 · 削除
小道具 · 削除. DELETE /api/v1/works/{work_id}/props/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PUT/api/v1/works/{work_id}/props/{reference_id}/primary-image小道具 · 参照画像を設定
小道具 · 参照画像を設定. PUT /api/v1/works/{work_id}/props/{reference_id}/primary-image. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
asset_id | string | * |
|
current_asset_id | oneOf | * | |
revision | integer | * |
最初のリクエスト · JSON
{
"asset_id": "11111111-1111-4111-8111-111111111111",
"current_asset_id": "11111111-1111-4111-8111-111111111111",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/props/{reference_id}/image-generations小道具 · 参照画像を生成
小道具 · 参照画像を生成. POST /api/v1/works/{work_id}/props/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
variants | integer | — |
|
model | string | — |
|
prompt | string | — |
|
aspect_ratio | string | — | |
image_size | string | — |
|
quality | string | — |
|
background | string | — |
|
output_format | string | — |
|
reference_asset_ids | array | — |
|
slot | string | — |
|
variant_name | string | — |
|
current_asset_id | string | — |
|
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}小道具 · シーンに関連付け
小道具 · シーンに関連付け. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
scene_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}小道具 · シーンから解除
小道具 · シーンから解除. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/props/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
scene_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{work_id}/gridsグリッド · 取得 (list)
グリッド · 取得 (list). GET /api/v1/works/{work_id}/grids. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"kind": "character",
"name": "example",
"description": "example",
"tags": [
"example"
],
"primary_asset_id": "11111111-1111-4111-8111-111111111111"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/gridsグリッド · 登録
グリッド · 登録. POST /api/v1/works/{work_id}/grids. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
name | string | * |
|
description | string | — |
|
tags | array | — |
|
revision | integer | * |
最初のリクエスト · JSON
{
"name": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{work_id}/grids/{reference_id}グリッド · 取得
グリッド · 取得. GET /api/v1/works/{work_id}/grids/{reference_id}. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"kind": "character",
"name": "example",
"description": "example",
"tags": [
"example"
],
"primary_asset_id": "11111111-1111-4111-8111-111111111111"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PATCH/api/v1/works/{work_id}/grids/{reference_id}グリッド · 更新
グリッド · 更新. PATCH /api/v1/works/{work_id}/grids/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
name | string | * |
|
description | string | — |
|
tags | array | — |
|
revision | integer | * |
最初のリクエスト · JSON
{
"name": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
DELETE/api/v1/works/{work_id}/grids/{reference_id}グリッド · 削除
グリッド · 削除. DELETE /api/v1/works/{work_id}/grids/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PUT/api/v1/works/{work_id}/grids/{reference_id}/primary-imageグリッド · 参照画像を設定
グリッド · 参照画像を設定. PUT /api/v1/works/{work_id}/grids/{reference_id}/primary-image. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
asset_id | string | * |
|
current_asset_id | oneOf | * | |
revision | integer | * |
最初のリクエスト · JSON
{
"asset_id": "11111111-1111-4111-8111-111111111111",
"current_asset_id": "11111111-1111-4111-8111-111111111111",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/grids/{reference_id}/image-generationsグリッド · 参照画像を生成
グリッド · 参照画像を生成. POST /api/v1/works/{work_id}/grids/{reference_id}/image-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
variants | integer | — |
|
model | string | — |
|
prompt | string | — |
|
aspect_ratio | string | — | |
image_size | string | — |
|
quality | string | — |
|
background | string | — |
|
output_format | string | — |
|
reference_asset_ids | array | — |
|
slot | string | — |
|
variant_name | string | — |
|
current_asset_id | string | — |
|
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
PUT/api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}グリッド · シーンに関連付け
グリッド · シーンに関連付け. PUT /api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
scene_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
DELETE/api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}グリッド · シーンから解除
グリッド · シーンから解除. DELETE /api/v1/works/{work_id}/scenes/{scene_id}/references/grids/{reference_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
scene_idpath | string | * |
|
reference_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{work_id}/episodesエピソード · 取得 (list)
エピソード · 取得 (list). GET /api/v1/works/{work_id}/episodes. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"number": 1,
"title": "example",
"raw_content": "example",
"description": "example"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/episodesエピソードを作成
エピソードを作成. POST /api/v1/works/{work_id}/episodes. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
title | string | * |
|
number | integer | — | |
raw_content | string | — |
|
description | string | — |
|
revision | integer | * |
最初のリクエスト · JSON
{
"title": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{work_id}/episodes/{episode_id}エピソード · 取得
エピソード · 取得. GET /api/v1/works/{work_id}/episodes/{episode_id}. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
episode_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"number": 1,
"title": "example",
"raw_content": "example",
"description": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PATCH/api/v1/works/{work_id}/episodes/{episode_id}エピソード · 更新
エピソード · 更新. PATCH /api/v1/works/{work_id}/episodes/{episode_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
episode_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
title | string | * |
|
number | integer | — | |
raw_content | string | — |
|
description | string | — |
|
revision | integer | * |
最初のリクエスト · JSON
{
"title": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
DELETE/api/v1/works/{work_id}/episodes/{episode_id}エピソード · 削除
エピソード · 削除. DELETE /api/v1/works/{work_id}/episodes/{episode_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
episode_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{work_id}/episodes/{episode_id}/scenesシーン · 取得 (list)
シーン · 取得 (list). GET /api/v1/works/{work_id}/episodes/{episode_id}/scenes. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
episode_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"episode_id": "11111111-1111-4111-8111-111111111111",
"number": 1,
"heading": "example",
"description": "example",
"video_prompt": "example"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/episodes/{episode_id}/scenesシーンを作成
シーンを作成. POST /api/v1/works/{work_id}/episodes/{episode_id}/scenes. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
episode_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
heading | string | * |
|
number | integer | — | |
description | string | — |
|
video_prompt | oneOf | — | |
revision | integer | * |
最初のリクエスト · JSON
{
"heading": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}シーン · 取得
シーン · 取得. GET /api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}. GET
必要な権限: projects:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
episode_idpath | string | * |
|
scene_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"episode_id": "11111111-1111-4111-8111-111111111111",
"number": 1,
"heading": "example",
"description": "example",
"video_prompt": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PATCH/api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}シーン · 更新
シーン · 更新. PATCH /api/v1/works/{work_id}/episodes/{episode_id}/scenes/{scene_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
episode_idpath | string | * |
|
scene_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
heading | string | * |
|
number | integer | — | |
description | string | — |
|
video_prompt | oneOf | — | |
revision | integer | * |
最初のリクエスト · JSON
{
"heading": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/archive-importsZIP資料の取り込み
ZIP資料の取り込み. POST /api/v1/works/{work_id}/archive-imports. Use a verified ZIP asset_id and current revision. Preserves the archive and uses the same name-based material update rules as Studio. Check imported, failed and asset_ids on completion. Creation requires jobs:create, assets:read, assets:write and projects:write. Idempotency-Key; GET /api/v1/works/{work_id}/archive-imports/{import_id}
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
asset_id | string | * |
|
最初のリクエスト · JSON
{
"revision": 1,
"asset_id": "11111111-1111-4111-8111-111111111111"
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"progress": {
"phase": "extracting",
"current": 0,
"total": 0
},
"imported": 0,
"failed": 0,
"asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
GET/api/v1/works/{work_id}/archive-imports/{import_id}ZIP取り込み状況の取得
ZIP取り込み状況の取得. GET /api/v1/works/{work_id}/archive-imports/{import_id}. Use a verified ZIP asset_id and current revision. Preserves the archive and uses the same name-based material update rules as Studio. Check imported, failed and asset_ids on completion. Creation requires jobs:create, assets:read, assets:write and projects:write. jobs:read
必要な権限: jobs:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
import_idpath | string | * |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"progress": {
"phase": "extracting",
"current": 0,
"total": 0
},
"imported": 0,
"failed": 0,
"asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/uploadsファイル一括アップロードの準備
ファイル一括アップロードの準備. POST /api/v1/works/{work_id}/uploads. Idempotency-Key + files (1–20) → PUT upload_url → POST /api/v1/uploads/{upload_id}/complete
必要な権限: assets:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
files | array | * |
|
files[].filename | string | * |
|
files[].mime_type | string | * |
|
files[].size_bytes | integer | * |
|
files[].sha256 | string | * |
最初のリクエスト · JSON
{
"files": [
{
"filename": "example",
"mime_type": "text/plain",
"size_bytes": 1,
"sha256": "example"
}
]
}レスポンス
HTTP 201 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"items": [
{
"filename": "example",
"ticket": {
"id": "11111111-1111-4111-8111-111111111111",
"asset_id": "11111111-1111-4111-8111-111111111111",
"upload_url": "example",
"method": "PUT",
"content_type": "example",
"expires_at": "2026-09-20T00:00:00Z"
}
}
]
}
}応答ヘッダー: X-Request-Id · ETag
試す
DELETE/api/v1/works/{work_id}/scenes/{scene_id}シーン · 削除
シーン · 削除. DELETE /api/v1/works/{work_id}/scenes/{scene_id}. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
scene_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * |
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PUT/api/v1/works/{work_id}/episodes/{episode_id}/scene-orderシーンを並べ替え
シーンを並べ替え. PUT /api/v1/works/{work_id}/episodes/{episode_id}/scene-order. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
episode_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
scene_ids | array | * |
|
revision | integer | * |
最初のリクエスト · JSON
{
"scene_ids": [
"11111111-1111-4111-8111-111111111111"
],
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PUT/api/v1/works/{work_id}/script脚本を保存
脚本を保存. PUT /api/v1/works/{work_id}/script. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
text | string | * |
|
revision | integer | * |
最初のリクエスト · JSON
{
"text": "example",
"revision": 1
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/scenes/{scene_id}/video-generationsシーン動画を生成
シーン動画を生成. POST /api/v1/works/{work_id}/scenes/{scene_id}/video-generations. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
scene_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
anchor_asset_id | string | — |
|
reference_asset_ids | array | — |
|
model | string | — |
|
prompt | string | — |
|
duration_seconds | integer | * |
|
resolution | string | * |
|
aspect_ratio | string | * |
|
generate_audio | boolean | — |
最初のリクエスト · JSON
{
"revision": 1,
"duration_seconds": 1,
"resolution": "example",
"aspect_ratio": "example"
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
PUT/api/v1/works/{work_id}/scenes/{scene_id}/selected-take最終テイクを選択
最終テイクを選択. PUT /api/v1/works/{work_id}/scenes/{scene_id}/selected-take. revision + Idempotency-Key
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
scene_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
take_id | oneOf | * |
最初のリクエスト · JSON
{
"revision": 1,
"take_id": "11111111-1111-4111-8111-111111111111"
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{work_id}/exports最終動画を書き出す
最終動画を書き出す. POST /api/v1/works/{work_id}/exports. revision + Idempotency-Key → GET /api/v1/jobs/{job_id}
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
work_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
allow_partial | boolean | — |
|
selections | array | — |
|
selections[].scene_id | string | * |
|
selections[].asset_id | string | * |
|
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
?????API
POST/api/v1/works/{project_id}/plans制作プランと必要クレジットを確認する
実際の制作は始めずに、何を作るのかと必要なクレジットだけを先に確認します。
必要な権限: runs:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
template_id | string | * |
|
template_version | number | * |
|
project_revision | integer | * | |
episode_ids | array | * | エピソード ID は重複できません。
|
mode | string | * |
|
output_profile | string | * |
|
最初のリクエスト · JSON
{
"template_id": "episode-production",
"template_version": 1,
"project_revision": 1,
"episode_ids": [
"11111111-1111-4111-8111-111111111111"
],
"mode": "reviewed",
"output_profile": "sandbox-episode-v1"
}レスポンス
HTTP 201 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"project_revision": 1,
"template_id": "example",
"template_version": 1,
"executable": false,
"expires_at": "2026-09-20T00:00:00Z",
"budget_ceiling": {
"currency": "example",
"micro_units": "example"
},
"steps": [
{
"stage_key": "example",
"target_ids": [
"11111111-1111-4111-8111-111111111111"
],
"depends_on": [
"example"
],
"requires_review": false,
"max_cost": {
"currency": "example",
"micro_units": "example"
}
}
],
"unsupported_reasons": [
"example"
]
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{project_id}/runs制作を開始する
作成済みの plan_id の制作計画を実行し、実行 ID を返します。getRun で状態と結果を確認します。
必要な権限: runs:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
plan_id | string | * |
|
client_reference | string | — |
|
最初のリクエスト · JSON
{
"plan_id": "11111111-1111-4111-8111-111111111111"
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"plan_id": "11111111-1111-4111-8111-111111111111",
"version": 1,
"state": "queued",
"client_reference": "example",
"created_at": "2026-09-20T00:00:00Z",
"completed_at": "2026-09-20T00:00:00Z",
"budget_remaining": {
"currency": "example",
"micro_units": "example"
},
"committed_cost": {
"currency": "example",
"micro_units": "example"
},
"unresolved_cost": {
"currency": "example",
"micro_units": "example"
},
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
]
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
POST/api/v1/works/{project_id}/workflow/commandsスタジオ制作を編集
脚本・シーン・デザイン・テイク選択などを編集します。operation を選び、対応する input と最新 revision を送信します。
必要な権限: projects:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | operation = design.asset.set |
operation | string | * | operation = design.asset.set
|
input | object | * | operation = design.asset.set |
input.id | string | * | operation = design.asset.set
|
input.asset_id | string | * | operation = design.asset.set
|
input.kind | string | * | operation = design.asset.set
|
input.current_asset_id | oneOf | * | operation = design.asset.set |
input.name | string | — | operation = design.asset.set
|
revision | integer | * | operation = asset.delete |
operation | string | * | operation = asset.delete
|
input | object | * | operation = asset.delete |
input.id | string | * | operation = asset.delete
|
revision | integer | * | operation = trash.restore |
operation | string | * | operation = trash.restore
|
input | object | * | operation = trash.restore |
input.id | string | * | operation = trash.restore
|
input.entity_type | string | * | operation = trash.restore
|
revision | integer | * | operation = scene.duplicate |
operation | string | * | operation = scene.duplicate
|
input | object | * | operation = scene.duplicate |
input.id | string | * | operation = scene.duplicate
|
revision | integer | * | operation = project.settings.update |
operation | string | * | operation = project.settings.update
|
input | object | * | operation = project.settings.update |
input.title | string | * | operation = project.settings.update
|
input.tags | array | * | operation = project.settings.update
|
input.cover | string | * | operation = project.settings.update
|
input.aspect | string | * | operation = project.settings.update
|
input.resolution | string | * | operation = project.settings.update
|
input.style | string | * | operation = project.settings.update
|
input.style_prompt | string | * | operation = project.settings.update
|
revision | integer | * | operation = project.rename |
operation | string | * | operation = project.rename
|
input | object | * | operation = project.rename |
input.title | string | * | operation = project.rename
|
revision | integer | * | operation = project.state.set |
operation | string | * | operation = project.state.set
|
input | object | * | operation = project.state.set |
input.state | string | * | operation = project.state.set
|
revision | integer | * | operation = script.update |
operation | string | * | operation = script.update
|
input | object | * | operation = script.update |
input.text | string | * | operation = script.update
|
revision | integer | * | operation = script.bible.update |
operation | string | * | operation = script.bible.update
|
input | object | * | operation = script.bible.update |
input.logline | string | * | operation = script.bible.update
|
input.synopsis | string | * | operation = script.bible.update
|
revision | integer | * | operation = episode.save |
operation | string | * | operation = episode.save
|
input | object | * | operation = episode.save |
input.id | string | — | operation = episode.save
|
input.title | string | * | operation = episode.save
|
input.number | integer | — | operation = episode.save |
input.raw_content | string | — | operation = episode.save
|
input.description | string | — | operation = episode.save
|
revision | integer | * | operation = episode.delete |
operation | string | * | operation = episode.delete
|
input | object | * | operation = episode.delete |
input.id | string | * | operation = episode.delete
|
revision | integer | * | operation = scene.save |
operation | string | * | operation = scene.save
|
input | object | * | operation = scene.save |
input.id | string | — | operation = scene.save
|
input.episode_id | string | * | operation = scene.save
|
input.heading | string | * | operation = scene.save
|
input.number | integer | — | operation = scene.save |
input.description | string | — | operation = scene.save
|
input.video_prompt | oneOf | — | operation = scene.save |
revision | integer | * | operation = scene.delete |
operation | string | * | operation = scene.delete
|
input | object | * | operation = scene.delete |
input.id | string | * | operation = scene.delete
|
revision | integer | * | operation = scene.reorder |
operation | string | * | operation = scene.reorder
|
input | object | * | operation = scene.reorder |
input.episode_id | string | * | operation = scene.reorder
|
input.scene_ids | array | * | operation = scene.reorder
|
revision | integer | * | operation = design.save |
operation | string | * | operation = design.save
|
input | object | * | operation = design.save |
input.id | string | — | operation = design.save
|
input.kind | string | * | operation = design.save
|
input.name | string | * | operation = design.save
|
input.description | string | — | operation = design.save
|
input.tags | array | — | operation = design.save
|
revision | integer | * | operation = design.delete |
operation | string | * | operation = design.delete
|
input | object | * | operation = design.delete |
input.id | string | * | operation = design.delete
|
revision | integer | * | operation = design.voice.set |
operation | string | * | operation = design.voice.set
|
input | object | * | operation = design.voice.set |
input.id | string | * | operation = design.voice.set
|
input.asset_id | oneOf | * | operation = design.voice.set |
revision | integer | * | operation = design.asset.detach |
operation | string | * | operation = design.asset.detach
|
input | object | * | operation = design.asset.detach |
input.id | string | * | operation = design.asset.detach
|
input.asset_id | string | * | operation = design.asset.detach
|
input.kind | string | * | operation = design.asset.detach
|
revision | integer | * | operation = design.asset.restore |
operation | string | * | operation = design.asset.restore
|
input | object | * | operation = design.asset.restore |
input.id | string | * | operation = design.asset.restore
|
input.current_asset_id | string | * | operation = design.asset.restore
|
input.restore_asset_id | string | * | operation = design.asset.restore
|
input.kind | string | * | operation = design.asset.restore
|
revision | integer | * | operation = design.variant.rename |
operation | string | * | operation = design.variant.rename
|
input | object | * | operation = design.variant.rename |
input.id | string | * | operation = design.variant.rename
|
input.asset_id | string | * | operation = design.variant.rename
|
input.name | string | * | operation = design.variant.rename
|
revision | integer | * | operation = scene.design.attach |
operation | string | * | operation = scene.design.attach
|
input | object | * | operation = scene.design.attach |
input.scene_id | string | * | operation = scene.design.attach
|
input.design_id | string | * | operation = scene.design.attach
|
revision | integer | * | operation = scene.design.detach |
operation | string | * | operation = scene.design.detach
|
input | object | * | operation = scene.design.detach |
input.scene_id | string | * | operation = scene.design.detach
|
input.design_id | string | * | operation = scene.design.detach
|
revision | integer | * | operation = cut.take.select |
operation | string | * | operation = cut.take.select
|
input | object | * | operation = cut.take.select |
input.scene_id | string | * | operation = cut.take.select
|
input.asset_id | oneOf | * | operation = cut.take.select |
revision | integer | * | operation = take.delete |
operation | string | * | operation = take.delete
|
input | object | * | operation = take.delete |
input.scene_id | string | * | operation = take.delete
|
input.asset_id | string | * | operation = take.delete
|
最初のリクエスト · JSON
{
"revision": 1,
"operation": "design.asset.set",
"input": {
"id": "11111111-1111-4111-8111-111111111111",
"asset_id": "11111111-1111-4111-8111-111111111111",
"kind": "primary",
"current_asset_id": "11111111-1111-4111-8111-111111111111"
}
}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"work_id": "11111111-1111-4111-8111-111111111111",
"changed_id": "11111111-1111-4111-8111-111111111111",
"revision": 1,
"studio_url": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/works/{project_id}/cut/exportsスタジオのカットを書き出す
選択した動画をエピソード・シーン順に結合します。selections でテイク、allow_partial で未作成シーンの省略を指定します。getJob で確認します。
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
allow_partial | boolean | — |
|
selections | array | — |
|
selections[].scene_id | string | * |
|
selections[].asset_id | string | * |
|
最初のリクエスト · JSON
{
"revision": 1
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
POST/api/v1/works/{project_id}/storyboard/videos絵コンテのシーン動画を生成
scene_id の動画を指定モデル・長さ・解像度で生成します。anchor_asset_id で開始画像を指定できます。getJob で確認します。
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
scene_id | string | * |
|
anchor_asset_id | string | — |
|
reference_asset_ids | array | — |
|
model | string | — |
|
prompt | string | — |
|
duration_seconds | integer | * |
|
resolution | string | * |
|
aspect_ratio | string | * |
|
generate_audio | boolean | — |
最初のリクエスト · JSON
{
"revision": 1,
"scene_id": "11111111-1111-4111-8111-111111111111",
"duration_seconds": 1,
"resolution": "example",
"aspect_ratio": "example"
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
POST/api/v1/works/{project_id}/designs/imagesキャラクター・背景・小道具・グリッドの画像を生成
design_id に1〜4枚の画像を生成します。プロンプト・参照画像と基本画像またはバリアント枠を指定し、getJob で確認します。
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
revision | integer | * | |
design_id | string | * |
|
variants | integer | — |
|
model | string | — |
|
prompt | string | — |
|
aspect_ratio | string | — | |
image_size | string | — |
|
quality | string | — |
|
background | string | — |
|
output_format | string | — |
|
reference_asset_ids | array | — |
|
slot | string | — |
|
variant_name | string | — |
|
current_asset_id | string | — |
|
最初のリクエスト · JSON
{
"revision": 1,
"design_id": "11111111-1111-4111-8111-111111111111"
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
アップロード
POST/api/v1/uploadsファイルのアップロード先を受け取る
ファイル情報を登録し upload_url を取得します。その URL にファイルを PUT し、アップロード完了 API を呼び出してください。 TXT・Markdown・DOCX・PNG・JPEG・WebP・AVIF・WAV・ZIP に対応します。容量制限は Studio と共通です。GET /capabilities の upload_limits を確認してください。脚本は最大 5,000,000 文字です。ファイル名にパス区切り文字は使えません。WAV は PCM または IEEE float です。
必要な権限: assets:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_id | string | * |
|
filename | string | * |
|
mime_type | string | * |
|
size_bytes | integer | * |
|
sha256 | string | * |
最初のリクエスト · JSON
{
"project_id": "11111111-1111-4111-8111-111111111111",
"filename": "example",
"mime_type": "text/plain",
"size_bytes": 1,
"sha256": "example"
}レスポンス
HTTP 201 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"asset_id": "11111111-1111-4111-8111-111111111111",
"upload_url": "example",
"method": "PUT",
"content_type": "example",
"expires_at": "2026-09-20T00:00:00Z"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/uploads/{upload_id}/completeファイルを上げ終えたと知らせる
送信されたファイルを登録情報と照合し、制作に使えるアセット情報を返します。
必要な権限: assets:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
upload_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
最初のリクエスト · JSON
{}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"state": "pending",
"mime_type": "example",
"size_bytes": 0,
"download_url": "example",
"expires_at": "2026-09-20T00:00:00Z"
}
}応答ヘッダー: X-Request-Id · ETag
試す
PUT/api/v1/uploads/{upload_id}/contentファイルの中身をアップロードする
発行済みのアップロード先に application/octet-stream でファイル本体を送信します。成功後に completeUpload を呼び出します。
必要な権限: assets:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
upload_idpath | string | * |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"uploaded": true
}
}応答ヘッダー: X-Request-Id · ETag
試す
アセット・結果
GET/api/v1/assets/{asset_id}成果物の情報とダウンロードリンクを見る
アセット情報と、利用可能な場合は署名付き download_url を取得します。有効期限内にダウンロードしてください。
必要な権限: assets:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
asset_idpath | string | * |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"state": "pending",
"mime_type": "example",
"size_bytes": 0,
"download_url": "example",
"expires_at": "2026-09-20T00:00:00Z"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/downloads/{asset_id}完成したファイルをダウンロードする
getAsset が返す署名付き download_url 全体を使ってファイルを取得します。有効期限は5分です。
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
asset_idpath | string | * |
|
expiresquery | string | * | |
signaturequery | string | * |
レスポンス
HTTP 200 ファイルのバイト列
application/octet-stream · ファイルのバイト列
試す
制作実行
GET/api/v1/runs制作の一覧を見る
制作の実行一覧を取得します。作品・状態・client_reference・期間で絞り込めます。
必要な権限: runs:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
cursorquery | string | — |
|
limitquery | integer | — |
|
project_idquery | string | — |
|
statequery | string | — |
|
client_referencequery | string | — |
|
fromquery | string | — |
|
toquery | string | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"plan_id": "11111111-1111-4111-8111-111111111111",
"version": 1,
"state": "queued",
"client_reference": "example",
"created_at": "2026-09-20T00:00:00Z",
"completed_at": "2026-09-20T00:00:00Z",
"budget_remaining": {
"currency": "example",
"micro_units": "example"
},
"committed_cost": {
"currency": "example",
"micro_units": "example"
},
"unresolved_cost": {
"currency": "example",
"micro_units": "example"
},
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
]
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/runs/{run_id}制作の進み具合を見る
制作実行の現在の状態・バージョン・利用可能な結果を取得します。承認や停止の操作にはこのバージョンを使います。
必要な権限: runs:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
run_idpath | string | * |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"plan_id": "11111111-1111-4111-8111-111111111111",
"version": 1,
"state": "queued",
"client_reference": "example",
"created_at": "2026-09-20T00:00:00Z",
"completed_at": "2026-09-20T00:00:00Z",
"budget_remaining": {
"currency": "example",
"micro_units": "example"
},
"committed_cost": {
"currency": "example",
"micro_units": "example"
},
"unresolved_cost": {
"currency": "example",
"micro_units": "example"
},
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
]
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/runs/{run_id}/steps段階ごとの進行状況を見る
制作実行の各ステップと状態を取得し、待機中・実行中・完了の段階を確認できます。
必要な権限: runs:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
run_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"stage_key": "example",
"target_id": "11111111-1111-4111-8111-111111111111",
"job_id": "11111111-1111-4111-8111-111111111111",
"state": "blocked",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example",
"ordinal": 1
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/runs/{run_id}/events制作中に残った記録を見る
状態変更やレビュー依頼などの実行イベントを取得し、制作の経過を確認します。
必要な権限: runs:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
run_idpath | string | * |
|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"items": [
{
"event_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"sequence": 1,
"type": "run.state_changed",
"state": "queued",
"step_id": "11111111-1111-4111-8111-111111111111",
"created_at": "2026-09-20T00:00:00Z"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/runs/{run_id}/decisions続けるか止めるかを決める
制作実行に approve・stop・resume・cancel_remaining・retry_result の操作を送信します。最新バージョンを expected_version に指定します。 retry_result は保存済み動画タスクの結果照会のみ再開します。最新の expected_version と step_id を指定してください。元のジョブと予約クレジットを維持し、再生成しません。受付から24時間以内の復旧可能な動画のみ対応します。その他の結果・使用量不明のタスクは運営者の確認が必要です。
必要な権限: runs:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
run_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
action | string | * | retry_result resumes result polling for an accepted Studio video on the original reservation; requires step_id and expected_version. It never resubmits generation. Unconfirmed usage without a saved video task requires operator review.
|
expected_version | integer | * | |
step_id | string | — |
|
selected_asset_ids | array | — |
|
最初のリクエスト · JSON
{
"action": "approve",
"expected_version": 1
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"plan_id": "11111111-1111-4111-8111-111111111111",
"version": 1,
"state": "queued",
"client_reference": "example",
"created_at": "2026-09-20T00:00:00Z",
"completed_at": "2026-09-20T00:00:00Z",
"budget_remaining": {
"currency": "example",
"micro_units": "example"
},
"committed_cost": {
"currency": "example",
"micro_units": "example"
},
"unresolved_cost": {
"currency": "example",
"micro_units": "example"
},
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
]
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
ワークフロー機能
GET/api/v1/jobs/{job_id}実行したジョブの状態と結果を見る
ジョブの現在の状態と出力アセット ID を取得します。完了後、getAsset で結果ファイルを取得します。
必要な権限: jobs:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
job_idpath | string | * |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/jobs/{job_id}/build自動構成の進行状況と資料を取得
脚本の自動構成ジョブの段階・進行メッセージ・元資料・処理用テキストを取得します。
必要な権限: jobs:read, assets:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
job_idpath | string | * |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"state": "example",
"stage": "example",
"messages": [
{
"id": "11111111-1111-4111-8111-111111111111",
"role": "assistant",
"stage": "example",
"content": "example",
"status": "streaming",
"seq": 1,
"created_at": "example",
"updated_at": "example"
}
],
"sources": [
{
"id": "11111111-1111-4111-8111-111111111111",
"name": "example",
"filterMode": "prompt_index",
"sourceText": "example",
"llmText": "example",
"originalChars": 1,
"preparedChars": 1
}
]
}
}応答ヘッダー: X-Request-Id · ETag
試す
?????API
POST/api/v1/jobs機能を 1 つだけすぐ実行する
制作全体を動かさずに、機能を 1 つだけ選んですぐ実行します。analyze_script は脚本を読んでショットを作り、generate_image はキャラクター・シーン・小道具・ショットの画像を作ります。generate_video は画像を選んだショットの映像を作り、assemble_video はすべてのショットに映像がそろったエピソードをつなぎます。リクエストには必ずプロジェクトの最新 revision を入れてください。Live で送るとクレジットを先に確保します。
必要な権限: jobs:create
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
project_id | string | * |
|
project_revision | integer | * | |
target_id | string | * |
|
type | string | * |
|
profile_id | string | * |
|
client_reference | string | — |
|
最初のリクエスト · JSON
{
"project_id": "11111111-1111-4111-8111-111111111111",
"project_revision": 1,
"target_id": "11111111-1111-4111-8111-111111111111",
"type": "analyze_script",
"profile_id": "example"
}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"state": "queued",
"output_asset_ids": [
"11111111-1111-4111-8111-111111111111"
],
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
リクエストログ
GET/api/v1/requests送ったリクエストの履歴一覧を見る
HTTP ステータスや処理時間を含む API 呼び出し履歴を取得します。作品や期間で絞り込めます。
必要な権限: requests:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
cursorquery | string | — |
|
limitquery | integer | — |
|
fromquery | string | — |
|
toquery | string | — |
|
project_idquery | string | — |
|
run_idquery | string | — |
|
job_idquery | string | — |
|
key_idquery | string | — |
|
status_codequery | integer | — |
|
methodquery | string | — |
|
route_templatequery | string | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"items": [
{
"request_id": "11111111-1111-4111-8111-111111111111",
"created_at": "2026-09-20T00:00:00Z",
"method": "GET",
"route_template": "example",
"status_code": 100,
"duration_ms": 0,
"actor_kind": "api_key",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"job_id": "11111111-1111-4111-8111-111111111111",
"replayed": false,
"error_code": "example"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
GET/api/v1/requests/{request_id}送ったリクエストの履歴を 1 件見る
request_id で API 呼び出しの HTTP ステータス・処理時間・関連する実行やジョブを取得します。
必要な権限: requests:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
request_idpath | string | * |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"request_id": "11111111-1111-4111-8111-111111111111",
"created_at": "2026-09-20T00:00:00Z",
"method": "GET",
"route_template": "example",
"status_code": 100,
"duration_ms": 0,
"actor_kind": "api_key",
"work_id": "11111111-1111-4111-8111-111111111111",
"run_id": "11111111-1111-4111-8111-111111111111",
"job_id": "11111111-1111-4111-8111-111111111111",
"replayed": false,
"error_code": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
使用量
GET/api/v1/usageクレジットの使用量を見る
指定期間の使用量合計と、予約済み・精算済みの金額を取得します。
必要な権限: usage:read
パラメーター
パラメーターなし
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"period_start": "2026-09-20T00:00:00Z",
"period_end": "2026-09-20T00:00:00Z",
"as_of": "2026-09-20T00:00:00Z",
"http_requests": 0,
"runs": 0,
"jobs": 0,
"reserved": {
"currency": "example",
"micro_units": "example"
},
"committed": {
"currency": "example",
"micro_units": "example"
},
"unresolved": {
"currency": "example",
"micro_units": "example"
},
"remaining": {
"currency": "example",
"micro_units": "example"
},
"amount_basis": "partner_limit",
"billing_mode": "pilot"
}
}応答ヘッダー: X-Request-Id · ETag
試す
Webhook
GET/api/v1/webhook-endpointsWebhook 通知先の一覧を見る
登録済み Webhook の URL・購読イベント・有効状態を取得します。
必要な権限: webhooks:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"url": "example",
"work_ids": [
"11111111-1111-4111-8111-111111111111"
],
"events": [
"run.state_changed"
],
"enabled": false,
"verified": false,
"secret_version": 1,
"created_at": "2026-09-20T00:00:00Z"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/webhook-endpointsWebhook 通知先を登録する
指定作品で選択した制作イベントを受け取る Webhook URL を登録します。
必要な権限: webhooks:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
url | string | * |
|
project_ids | array | * |
|
events | array | * |
|
最初のリクエスト · JSON
{
"url": "example",
"project_ids": [
"11111111-1111-4111-8111-111111111111"
],
"events": [
"run.state_changed"
]
}レスポンス
HTTP 201 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"endpoint": {
"id": "11111111-1111-4111-8111-111111111111",
"url": "example",
"work_ids": [
"11111111-1111-4111-8111-111111111111"
],
"events": [
"run.state_changed"
],
"enabled": false,
"verified": false,
"secret_version": 1,
"created_at": "2026-09-20T00:00:00Z"
}
}
}応答ヘッダー: X-Request-Id · ETag
試す
PATCH/api/v1/webhook-endpoints/{endpoint_id}Webhook 通知先を変更する
Webhook を有効・無効にし、受信するイベントの種類を変更します。
必要な権限: webhooks:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
endpoint_idpath | string | * |
|
If-Matchheader | string | * | 最新の ETag を引用符も含めて入力してください。 |
リクエスト本文
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
enabled | boolean | — | |
events | array | — |
|
最初のリクエスト · JSON
{}レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"url": "example",
"work_ids": [
"11111111-1111-4111-8111-111111111111"
],
"events": [
"run.state_changed"
],
"enabled": false,
"verified": false,
"secret_version": 1,
"created_at": "2026-09-20T00:00:00Z"
}
}応答ヘッダー: X-Request-Id · ETag
試す
Webhook 配信
GET/api/v1/webhook-deliveriesWebhook を送った履歴を見る
Webhook の送信履歴と状態を取得し、通知が届いたか確認できます。
必要な権限: webhooks:read
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
cursorquery | string | — |
|
limitquery | integer | — |
|
レスポンス
HTTP 200 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"items": [
{
"id": "11111111-1111-4111-8111-111111111111",
"endpoint_id": "11111111-1111-4111-8111-111111111111",
"event_id": "11111111-1111-4111-8111-111111111111",
"state": "pending",
"attempt": 0,
"http_status": 1,
"next_attempt_at": "2026-09-20T00:00:00Z",
"created_at": "2026-09-20T00:00:00Z"
}
],
"next_cursor": "example"
}
}応答ヘッダー: X-Request-Id · ETag
試す
POST/api/v1/webhook-deliveries/{delivery_id}/redeliverWebhook を再送する
delivery_id で指定した既存の Webhook 通知の再送を依頼します。
必要な権限: webhooks:write
パラメーター
| 名前 | Type | 必須 | 説明 |
|---|---|---|---|
delivery_idpath | string | * |
|
Idempotency-Keyheader | string | * | 同じ Idempotency-Key とリクエスト本文で再試行してください。
|
リクエスト本文
最初のリクエスト · JSON
{}レスポンス
HTTP 202 成功
最初のリクエスト · JSON
{
"request_id": "11111111-1111-4111-8111-111111111111",
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"endpoint_id": "11111111-1111-4111-8111-111111111111",
"event_id": "11111111-1111-4111-8111-111111111111",
"state": "pending",
"attempt": 0,
"http_status": 1,
"next_attempt_at": "2026-09-20T00:00:00Z",
"created_at": "2026-09-20T00:00:00Z"
}
}応答ヘッダー: X-Request-Id · ETag · Retry-After
試す
仕様書
GET/api/v1/openapi.jsonAPI 仕様をダウンロードする
API パス・リクエスト項目・レスポンス構造を含む OpenAPI 仕様をダウンロードします。
パラメーター
パラメーターなし
レスポンス
HTTP 200 OpenAPI 仕様書
最初のリクエスト · JSON
{}試す
エラーレスポンス · error.code 71
2xx が返ればリクエストは受け付けられています。201 は新しく作成されたこと、202 は「受け付けて処理中」という意味で、まだ結果はありません。202 のときはジョブの状態を照会して完了を確認してください。 成功レスポンスには request_id と data が入ります。例外はファイルのダウンロードと API 仕様の応答だけです。 失敗した場合は、どのエンドポイントも同じ形の error を返します。プログラムの分岐には error.code を使い、message は原因と対処を人が読むための文章です。 送り直してよいかは retryable で判断します。true のときだけ自動再試行し、retry_after_seconds または Retry-After の秒数だけ待ってから送ってください。POST を再送するときは、最初と同じ Idempotency-Key と同じ本文を使うと二重課金や二重生成を防げます。 知らない error.code が来たら、HTTP ステータスと retryable だけで処理して問題ありません。問い合わせの際は request_id をお知らせください。ジョブ受付後に起きた失敗は、このレスポンスではなくジョブの状態と結果で確認できます。
{
"request_id": "11111111-1111-4111-8111-111111111111",
"error": {
"code": "INVALID_REQUEST",
"message": "Invalid input. Check the required fields, types and values.",
"retryable": false
}
}| error.code | HTTP | 説明 |
|---|---|---|
INVALID_REFERENCE | 422 | A selected reference is unavailable or does not belong to this project. Select a ready image from this project. |
MODEL_UNAVAILABLE | 422 | The selected model is unavailable. Refresh the model list and select another model. |
MODEL_POLICY_REQUIRED | 503 | No default model policy is configured. Specify a model or ask the administrator to configure the task policy. |
BUILD_REPLAY_CONFLICT | 409 | The build inputs changed. Review the saved build before continuing. |
INVALID_REQUEST | 400,422 | Invalid input. Check the required fields, types and values. |
INVALID_API_KEY | 401 | Invalid credentials or download signature. Check the API key or obtain a new download URL. |
INSUFFICIENT_SCOPE | 403 | Permission denied. Check the key scopes and project access. |
PARTNER_BLOCKED | 403 | Account blocked. Contact support. |
PARTNER_PAUSED | 403 | Account paused. Ask the administrator to resume access. |
RESOURCE_NOT_FOUND | 404 | Resource unavailable. Check its ID and access permissions. |
METHOD_NOT_ALLOWED | 405 | Unsupported HTTP method. Use the documented method. |
REQUEST_TIMEOUT | 408 | Request body timed out. Check the connection and upload size. |
IDEMPOTENCY_KEY_REQUIRED | 400 | Provide a valid Idempotency-Key header. |
IDEMPOTENCY_CONFLICT | 409 | This Idempotency-Key belongs to a different request. Reuse it only with the original request. |
IDEMPOTENCY_KEY_EXPIRED | 409 | Idempotency record expired. Check the original result before starting a new operation. |
PRECONDITION_FAILED | 412 | Provide the latest quoted ETag in If-Match. |
REVISION_CONFLICT | 409 | Resource changed. Read the latest revision before updating. |
RESOURCE_CONFLICT | 409 | Resource conflicts with existing data. Review the current resource. |
INVALID_TRANSITION | 409 | Action is unavailable in the current state. Read the latest state. |
RUN_IN_PROGRESS | 409 | A run is in progress. Check its status before starting another. |
JOB_RUNNING | 409 | A job is running. Wait for completion before editing. |
PLAN_EXPIRED | 409 | Plan expired. Create a new plan and review its quote. |
INSUFFICIENT_CREDITS | 402 | Insufficient credits. Check the balance and required credits. |
BUDGET_EXCEEDED | 409,429 | Budget limit exceeded. Review usage and the configured budget. |
RATE_LIMITED | 429 | Request rate exceeded. Follow retryable and Retry-After before retrying. |
CAPACITY_EXCEEDED | 429 | Capacity limit exceeded. Reduce the workload or wait for active work to finish. |
PAYLOAD_TOO_LARGE | 413 | Request body too large. Reduce it to the documented limit. |
UNSUPPORTED_MEDIA_TYPE | 415 | Unsupported content type or encoding. Use the documented Content-Type without Content-Encoding. |
UPLOAD_TOO_LARGE | 422 | Uploaded content exceeds its processing limit. Reduce the file size. |
UPLOAD_NOT_VERIFIED | 422 | Upload is incomplete, expired or invalid. Check the upload and verification steps. |
ASSET_KIND_MISMATCH | 422 | Asset type does not match the operation. Select a compatible asset. |
SELECTED_IMAGE_REQUIRED | 422 | Select a valid image before generating video. |
SELECTED_VIDEO_REQUIRED | 422 | Select valid videos for the requested shots before assembly. |
REFERENCE_LIMIT_EXCEEDED | 422 | Too many reference assets. Reduce them to the model limit. |
REFERENCE_IMAGE_REQUIRED | 422 | This model requires a reference image. Add an image or select a text-to-image model. |
INVALID_GENERATION_OPTIONS | 422 | Generation options are invalid. Check the model capabilities. |
PROMPT_REQUIRED | 422 | Provide a generation prompt. |
SCRIPT_TEXT_REQUIRED | 422 | Provide script text before starting this operation. |
SCENES_REQUIRED | 422 | Create scenes before starting this operation. |
VARIANT_NAME_REQUIRED | 422 | Provide a variant name. |
EPISODE_ALREADY_STRUCTURED | 409 | Episode already has shots. Review its existing structure. |
ONE_SCRIPT_PER_PROJECT | 409 | This project supports one script. Use the existing script. |
MULTIPLE_SCRIPTS_REQUIRE_REVIEW | 409 | Multiple scripts need review before continuing. |
NATIVE_CONTENT_ALREADY_EXISTS | 409 | Studio content already exists. Review it before continuing. |
LIVE_PROJECT_REQUIRED | 409 | This operation requires a live project. |
STUDIO_MIGRATION_REQUIRED | 409 | Project needs Studio migration. Contact support. |
UNSUPPORTED_CAPABILITY | 422 | Unsupported operation or profile. Check GET /capabilities. |
CAPABILITY_UNAVAILABLE | 503 | Capability currently unavailable. Check GET /capabilities. |
API_NOT_ACCEPTING | 503 | New requests are paused. Check service availability. |
DEPENDENCY_UNAVAILABLE | 503 | A required service is unavailable. Follow the retry guidance or contact support. |
PRICING_UNAVAILABLE | 503 | Pricing unavailable. A valid quote is required to proceed. |
MEDIA_TOOLS_UNAVAILABLE | 503 | Media processing unavailable. Contact support. |
STORAGE_READ_FAILED | 503 | Could not read the stored asset. Contact support with request_id. |
STORAGE_WRITE_FAILED | 503 | Could not save the asset. Check the result before retrying. |
INTERNAL_ERROR | 500 | Internal error. Follow retry guidance; include request_id when contacting support. |
RESPONSE_CONTRACT_VIOLATION | 500 | Server response validation failed. Contact support with request_id. |
INVALID_EXECUTION_CONTEXT | 500 | Execution context is invalid. Contact support. |
RETRY_TRANSACTION | 503 | Transaction could not complete. Follow the response retry guidance. |
CLAIM_LOST | 409 | Execution ownership changed. Check the current job state. |
PROVIDER_TIMEOUT | 504 | Generation service timed out. Check the existing job before submitting again. |
PROVIDER_TERMINAL_FAILURE | 422 | Generation failed. Review the job result and inputs. |
PROVIDER_RESULT_UNAVAILABLE | 502 | Generation result unavailable. Check the existing job and recovery options. |
INVALID_RESULT | 422,503 | Result failed validation. Review the job or contact support. |
RESULT_TOO_LARGE | 422 | Result exceeds the processing limit. Reduce the requested output. |
EXPORT_TOO_LARGE | 422 | Export exceeds the size limit. Reduce the export selection. |
RECOVERY_BACKOFF | 409 | Existing result recovery is delayed. Check again later; do not resubmit generation. |
VIDEO_RECOVERY_REVIEW_REQUIRED | 503 | The original video task needs scheduled recovery or operator review. Do not resubmit generation. |
RESULT_RECOVERY_REQUIRED | 409,503 | Existing result needs recovery. Check the run recovery options before resubmitting. |
RESULT_NOT_RECOVERABLE | 409 | Result cannot be recovered through this action. Review the run or contact support. |
RECOVERY_CAPACITY_EXCEEDED | 409 | Recovery limit reached. Contact support before further recovery attempts. |
USAGE_RECOVERY_REQUIRED | 503 | Usage needs reconciliation. Contact support; do not resubmit generation blindly. |