FECINE OPEN API v1.1.0

เอกสารอ้างอิง API

เชื่อมต่อกระบวนการผลิตตั้งแต่บทจนถึงวิดีโอสำเร็จด้วย FECINE API

การยืนยันตัวตน

ใช้คีย์ FECINE เป็น Bearer token อ่านเอกสารได้โดยไม่ต้องมีบัญชี

สร้างและเริ่มทำงาน

สร้างผลงาน อัปโหลดบทและสื่อ แล้วเพิ่มตัวละคร ฉากหลัง อุปกรณ์ประกอบฉากและกริด สร้างตอนและฉาก เชื่อมโยงภาพอ้างอิงแล้วสร้างวิดีโอ เลือกเทคสำหรับแต่ละฉากก่อนส่งออกฉบับสุดท้าย รอให้งานสร้างเสร็จและส่ง revision ล่าสุดเมื่อแก้ไข หากต้องการสร้างโครงสร้างจากบทที่อัปโหลด ให้เรียกงานสร้างโครงสร้างแยกต่างหาก

รับผลลัพธ์

ตรวจสอบสถานะหรือรับ Webhook ใช้ ID ของไฟล์เพื่อรับลิงก์ดาวน์โหลดที่มีลายเซ็น

คำขอแรก

curl -X GET 'https://YOUR_FECINE_HOST/api/v1/capabilities' \
  -H 'Authorization: Bearer YOUR_FECINE_API_KEY'

GET /api/v1/capabilities

REFERENCE

เอกสาร API

FECINE API Key

ข้อผิดพลาด 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

การตอบกลับจากเซิร์ฟเวอร์

โปรเจกต์และทรัพยากร

GET/api/v1/worksดูรายการโปรเจกต์ของคุณ

ดูรายการผลงานที่เข้าถึงได้ กรองด้วย state และแบ่งหน้าด้วย cursor และ limit

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100
`state`query	string	—	Allowed values: active, archived

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

cursor query limit query state query

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/worksสร้างโปรเจกต์ใหม่

สร้างผลงานตาม name ใช้ ID ที่ได้รับเพื่อเพิ่มสื่อและเริ่มการผลิต

สิทธิ์ที่ต้องใช้: projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`name`	string	*	Minimum length: 1 characters Maximum length: 80 characters
`client_reference`	string	—	Maximum length: 128 characters

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{project_id}ดูข้อมูลโปรเจกต์

ดูชื่อ สถานะ และ revision ปัจจุบันของผลงานก่อนแก้ไขหรือส่งคำขอผลิต

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *

การตอบกลับจากเซิร์ฟเวอร์

PATCH/api/v1/works/{project_id}แก้ไขข้อมูลโปรเจกต์

เปลี่ยนชื่อหรือสถานะ active และ archived ของผลงาน โดยส่ง ETag ล่าสุดใน If-Match

สิทธิ์ที่ต้องใช้: projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`If-Match`header	string	*	ใช้ ETag ล่าสุดรวมเครื่องหมายคำพูด

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`state`	string	—	Allowed values: active, archived

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *If-Match header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{project_id}/resourcesดูรายการไฟล์ที่อัปโหลดไว้

ดูบท ตัวละคร ฉาก อุปกรณ์ประกอบ ตอน และช็อตของผลงาน เลือกประเภทด้วย kind

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100
`kind`query	string	—	Allowed values: script, character, scene, prop, episode, shot

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *cursor query limit query kind query

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{project_id}/resourcesเพิ่มบทหรือรูปภาพ

เพิ่มข้อมูลการผลิต เช่น เนื้อหาบทหรือช็อตด้วย kind และ data ใช้ /uploads สำหรับไฟล์

สิทธิ์ที่ต้องใช้: projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`kind`	string	*	kind = script Fixed value: script
`name`	string	*	kind = script Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = scriptระบุเพียง text หรือ source_asset_id อย่างใดอย่างหนึ่ง
`data.text`	string	—	kind = script Minimum length: 1 characters Maximum length: 900000 characters
`data.source_asset_id`	string	—	kind = script Format: UUID
`data.language`	string	*	kind = script Minimum length: 2 characters Maximum length: 16 characters
`kind`	string	*	kind = character Fixed value: character
`name`	string	*	kind = character Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = character
`data.description`	string	*	kind = character Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = character Default: [] Maximum items: 8 items
`kind`	string	*	kind = scene Fixed value: scene
`name`	string	*	kind = scene Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = scene
`data.description`	string	*	kind = scene Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = scene Default: [] Maximum items: 8 items
`kind`	string	*	kind = prop Fixed value: prop
`name`	string	*	kind = prop Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = prop
`data.description`	string	*	kind = prop Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = prop Default: [] Maximum items: 8 items
`kind`	string	*	kind = episode Fixed value: episode
`name`	string	*	kind = episode Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = episode
`data.script_resource_id`	string	*	kind = episode Format: UUID
`data.sequence`	integer	*	kind = episode Minimum: 1 Maximum: 100
`data.raw_content`	string	—	kind = episode Maximum length: 20000 characters
`data.description`	string	—	kind = episode Maximum length: 4000 characters
`kind`	string	*	kind = shot Fixed value: shot
`name`	string	*	kind = shot Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = shot
`data.episode_id`	string	*	kind = shot Format: UUID
`data.scene_id`	string	—	kind = shot Format: UUID
`data.character_ids`	array	—	kind = shot Default: [] Maximum items: 8 items
`data.prop_ids`	array	—	kind = shot Default: [] Maximum items: 8 items
`data.description`	string	*	kind = shot Maximum length: 4000 characters
`data.video_prompt`	oneOf	—	kind = shot
`data.sequence`	integer	—	kind = shot Minimum: 1 Maximum: 100
`data.duration_seconds`	integer	*	kind = shot Minimum: 1 Maximum: 60
`data.selected_image_asset_id`	string	—	kind = shot Format: UUID
`data.selected_video_asset_id`	string	—	kind = shot Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{project_id}/resources/{resource_id}ดูไฟล์ทีละรายการ

ดูประเภท เนื้อหา และ revision ของข้อมูลที่ระบุด้วย resource_id ในผลงาน

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`resource_id`path	string	*	Format: UUID

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *resource_id path *

การตอบกลับจากเซิร์ฟเวอร์

PATCH/api/v1/works/{project_id}/resources/{resource_id}แก้ไขไฟล์

แก้ไข kind และ data ของข้อมูล ส่ง ETag ล่าสุดใน If-Match เพื่อป้องกันการแก้ไขชนกัน

สิทธิ์ที่ต้องใช้: projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`resource_id`path	string	*	Format: UUID
`If-Match`header	string	*	ใช้ ETag ล่าสุดรวมเครื่องหมายคำพูด

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`kind`	string	*	kind = script Fixed value: script
`name`	string	*	kind = script Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = scriptระบุเพียง text หรือ source_asset_id อย่างใดอย่างหนึ่ง
`data.text`	string	—	kind = script Minimum length: 1 characters Maximum length: 900000 characters
`data.source_asset_id`	string	—	kind = script Format: UUID
`data.language`	string	*	kind = script Minimum length: 2 characters Maximum length: 16 characters
`kind`	string	*	kind = character Fixed value: character
`name`	string	*	kind = character Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = character
`data.description`	string	*	kind = character Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = character Default: [] Maximum items: 8 items
`kind`	string	*	kind = scene Fixed value: scene
`name`	string	*	kind = scene Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = scene
`data.description`	string	*	kind = scene Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = scene Default: [] Maximum items: 8 items
`kind`	string	*	kind = prop Fixed value: prop
`name`	string	*	kind = prop Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = prop
`data.description`	string	*	kind = prop Maximum length: 4000 characters
`data.reference_asset_ids`	array	—	kind = prop Default: [] Maximum items: 8 items
`kind`	string	*	kind = episode Fixed value: episode
`name`	string	*	kind = episode Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = episode
`data.script_resource_id`	string	*	kind = episode Format: UUID
`data.sequence`	integer	*	kind = episode Minimum: 1 Maximum: 100
`data.raw_content`	string	—	kind = episode Maximum length: 20000 characters
`data.description`	string	—	kind = episode Maximum length: 4000 characters
`kind`	string	*	kind = shot Fixed value: shot
`name`	string	*	kind = shot Minimum length: 1 characters Maximum length: 80 characters
`data`	object	*	kind = shot
`data.episode_id`	string	*	kind = shot Format: UUID
`data.scene_id`	string	—	kind = shot Format: UUID
`data.character_ids`	array	—	kind = shot Default: [] Maximum items: 8 items
`data.prop_ids`	array	—	kind = shot Default: [] Maximum items: 8 items
`data.description`	string	*	kind = shot Maximum length: 4000 characters
`data.video_prompt`	oneOf	—	kind = shot
`data.sequence`	integer	—	kind = shot Minimum: 1 Maximum: 100
`data.duration_seconds`	integer	*	kind = shot Minimum: 1 Maximum: 60
`data.selected_image_asset_id`	string	—	kind = shot Format: UUID
`data.selected_video_asset_id`	string	—	kind = shot Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *resource_id path *If-Match header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{project_id}/workflowดูข้อมูลการผลิตใน Studio

ดูบท ตอน งานออกแบบ ฉาก สื่อ เทค และการเลือกคัตของผลงานพร้อม revision ล่าสุดในครั้งเดียว

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{project_id}/script/analysesวิเคราะห์บทใน Studio

วิเคราะห์บทเพื่อสร้างโครงสร้างการผลิต ส่ง script_text เพื่อแก้บทก่อนวิเคราะห์ หรือเว้นไว้เพื่อใช้บทที่บันทึก ติดตามด้วย getJob

สิทธิ์ที่ต้องใช้: jobs:create

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`model`	string	—	Minimum length: 1 characters Maximum length: 200 characters
`script_text`	string	—	Minimum length: 1 characters Maximum length: 5000000 characters

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`model`	string	—	Minimum length: 1 characters Maximum length: 200 characters
`script_asset_ids`	array	—	Default: []
`material_scope`	string	—	Allowed values: unclassified, all Default: "unclassified"
`preprocess`	object	—
`preprocess.ignoreAttachments`	boolean	—	Default: true
`preprocess.discardKeywords`	array	—	Default: ["提示词","prompt","Midjourney","Stable Diffusion","DALL-E","Image1","Image2","正向提示词","负向提示词","视觉描述","出图要求","技术规格","画面描述","镜头提示词","请生成","角色三视图","服装本体展示","局部材质与细节放大"] Maximum items: 100 items
`preprocess.keepLabels`	array	—	Default: ["资产名称","资产ID","资产版本","关联角色资产名称","关联角色资产ID","关联场景资产名称","关联场景资产ID","关联道具资产名称","关联道具资产ID","服装变体ID","服装名称","道具资产ID","道具名称","场景资产ID","场景名称","宫格图ID","集数","主题","场景","角色名称","用途"] Maximum items: 100 items
`rebuild_policy`	string	*	Fixed value: full_rebuild

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{project_id}/libraryดูสื่อในคลังที่ใช้ร่วมกัน

ดูสื่อที่นำเข้าผลงานได้ scope=personal คือคลังส่วนตัว ค่าเริ่มต้น scope=studio คือคลังร่วม

สิทธิ์ที่ต้องใช้: assets:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`limit`	integer	—	Minimum: 1 Maximum: 100
`cursor`	string	—
`scope`	string	—	Allowed values: studio, personal

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *limit cursor scope

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{project_id}/importsนำเข้าสื่อในผลงาน

คัดลอกสื่อส่วนตัวหรือสื่อร่วมตาม asset_id เป็นสำเนาของผลงาน การแก้ไขหรือลบต้นฉบับภายหลังไม่กระทบสำเนา

สิทธิ์ที่ต้องใช้: assets:write, assets:read, projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`asset_id`	string	*	Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`model`	string	—	Minimum length: 1 characters Maximum length: 200 characters
`instructions`	string	*	Minimum length: 1 characters Maximum length: 8000 characters
`source_text`	string	—	Maximum length: 50000 characters
`max_output_tokens`	integer	—	Default: 2048 Minimum: 256 Maximum: 8192

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{work_id}/charactersตัวละคร · ดู (list)

ตัวละคร · ดู (list). GET /api/v1/works/{work_id}/characters. GET

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{work_id}/charactersตัวละคร · สร้าง

ตัวละคร · สร้าง. POST /api/v1/works/{work_id}/characters. revision + Idempotency-Key

สิทธิ์ที่ต้องใช้: projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{work_id}/characters/{reference_id}ตัวละคร · ดู

ตัวละคร · ดู. GET /api/v1/works/{work_id}/characters/{reference_id}. GET

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`asset_id`	string	*	Format: UUID
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`variants`	integer	—	Default: 1 Minimum: 1 Maximum: 4
`model`	string	—	Default: "image-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 20000 characters
`aspect_ratio`	string	—
`image_size`	string	—	Maximum length: 40 characters
`quality`	string	—	Allowed values: low, medium, high
`background`	string	—	Allowed values: auto, opaque, transparent
`output_format`	string	—	Allowed values: png, jpeg
`reference_asset_ids`	array	—	Default: [] Maximum items: 16 items
`slot`	string	—	Allowed values: primary, variant Default: "primary"
`variant_name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`current_asset_id`	string	—	Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *scene_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *scene_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{work_id}/background-scenesฉากพื้นหลัง · ดู (list)

ฉากพื้นหลัง · ดู (list). GET /api/v1/works/{work_id}/background-scenes. GET

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{work_id}/background-scenesฉากพื้นหลัง · สร้าง

ฉากพื้นหลัง · สร้าง. POST /api/v1/works/{work_id}/background-scenes. revision + Idempotency-Key

สิทธิ์ที่ต้องใช้: projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`asset_id`	string	*	Format: UUID
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`variants`	integer	—	Default: 1 Minimum: 1 Maximum: 4
`model`	string	—	Default: "image-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 20000 characters
`aspect_ratio`	string	—
`image_size`	string	—	Maximum length: 40 characters
`quality`	string	—	Allowed values: low, medium, high
`background`	string	—	Allowed values: auto, opaque, transparent
`output_format`	string	—	Allowed values: png, jpeg
`reference_asset_ids`	array	—	Default: [] Maximum items: 16 items
`slot`	string	—	Allowed values: primary, variant Default: "primary"
`variant_name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`current_asset_id`	string	—	Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *scene_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *scene_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{work_id}/propsอุปกรณ์ประกอบฉาก · ดู (list)

อุปกรณ์ประกอบฉาก · ดู (list). GET /api/v1/works/{work_id}/props. GET

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{work_id}/propsอุปกรณ์ประกอบฉาก · สร้าง

อุปกรณ์ประกอบฉาก · สร้าง. POST /api/v1/works/{work_id}/props. revision + Idempotency-Key

สิทธิ์ที่ต้องใช้: projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{work_id}/props/{reference_id}อุปกรณ์ประกอบฉาก · ดู

อุปกรณ์ประกอบฉาก · ดู. GET /api/v1/works/{work_id}/props/{reference_id}. GET

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`asset_id`	string	*	Format: UUID
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`variants`	integer	—	Default: 1 Minimum: 1 Maximum: 4
`model`	string	—	Default: "image-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 20000 characters
`aspect_ratio`	string	—
`image_size`	string	—	Maximum length: 40 characters
`quality`	string	—	Allowed values: low, medium, high
`background`	string	—	Allowed values: auto, opaque, transparent
`output_format`	string	—	Allowed values: png, jpeg
`reference_asset_ids`	array	—	Default: [] Maximum items: 16 items
`slot`	string	—	Allowed values: primary, variant Default: "primary"
`variant_name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`current_asset_id`	string	—	Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *scene_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *scene_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{work_id}/gridsกริด · ดู (list)

กริด · ดู (list). GET /api/v1/works/{work_id}/grids. GET

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{work_id}/gridsกริด · สร้าง

กริด · สร้าง. POST /api/v1/works/{work_id}/grids. revision + Idempotency-Key

สิทธิ์ที่ต้องใช้: projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{work_id}/grids/{reference_id}กริด · ดู

กริด · ดู. GET /api/v1/works/{work_id}/grids/{reference_id}. GET

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`name`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`description`	string	—	Maximum length: 4000 characters
`tags`	array	—	Maximum items: 8 items
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`asset_id`	string	*	Format: UUID
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`variants`	integer	—	Default: 1 Minimum: 1 Maximum: 4
`model`	string	—	Default: "image-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 20000 characters
`aspect_ratio`	string	—
`image_size`	string	—	Maximum length: 40 characters
`quality`	string	—	Allowed values: low, medium, high
`background`	string	—	Allowed values: auto, opaque, transparent
`output_format`	string	—	Allowed values: png, jpeg
`reference_asset_ids`	array	—	Default: [] Maximum items: 16 items
`slot`	string	—	Allowed values: primary, variant Default: "primary"
`variant_name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`current_asset_id`	string	—	Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *scene_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`reference_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *scene_id path *reference_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{work_id}/episodesตอน · ดู (list)

ตอน · ดู (list). GET /api/v1/works/{work_id}/episodes. GET

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{work_id}/episodesสร้างตอน

สร้างตอน. POST /api/v1/works/{work_id}/episodes. revision + Idempotency-Key

สิทธิ์ที่ต้องใช้: projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`title`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`number`	integer	—
`raw_content`	string	—	Maximum length: 20000 characters
`description`	string	—	Maximum length: 4000 characters
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/works/{work_id}/episodes/{episode_id}ตอน · ดู

ตอน · ดู. GET /api/v1/works/{work_id}/episodes/{episode_id}. GET

สิทธิ์ที่ต้องใช้: projects:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *episode_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`title`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`number`	integer	—
`raw_content`	string	—	Maximum length: 20000 characters
`description`	string	—	Maximum length: 4000 characters
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *episode_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *episode_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *episode_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`heading`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`number`	integer	—
`description`	string	—	Maximum length: 4000 characters
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *episode_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *episode_id path *scene_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`heading`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`number`	integer	—
`description`	string	—	Maximum length: 4000 characters
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *episode_id path *scene_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{work_id}/archive-importsนำเข้าไฟล์ ZIP

นำเข้าไฟล์ 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_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`asset_id`	string	*	Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`import_id`path	string	*	Format: UUID

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *import_id path *

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`files`	array	*	Maximum items: 20 items
`files[].filename`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`files[].mime_type`	string	*	Allowed values: text/plain, text/markdown, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/png, image/jpeg, image/webp, image/avif, audio/wav, application/zip
`files[].size_bytes`	integer	*	Maximum: 1073741824
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *scene_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`episode_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`scene_ids`	array	*	Maximum items: 500 items
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *episode_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

PUT/api/v1/works/{work_id}/scriptบันทึกบท

บันทึกบท. PUT /api/v1/works/{work_id}/script. revision + Idempotency-Key

สิทธิ์ที่ต้องใช้: projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`work_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`text`	string	*	Maximum length: 5000000 characters
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`anchor_asset_id`	string	—	Format: UUID
`reference_asset_ids`	array	—	Maximum items: 12 items
`model`	string	—	Default: "video-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 10000 characters
`duration_seconds`	integer	*	Minimum: 1 Maximum: 60
`resolution`	string	*	Minimum length: 1 characters Maximum length: 20 characters
`aspect_ratio`	string	*	Minimum length: 1 characters Maximum length: 20 characters
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *scene_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`scene_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *scene_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`allow_partial`	boolean	—	Default: true
`selections`	array	—	Maximum items: 200 items
`selections[].scene_id`	string	*	Format: UUID
`selections[].asset_id`	string	*	Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

work_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

API ??????????????????????

POST/api/v1/works/{project_id}/plansดูแผนงานและเครดิตที่จะใช้

ดูก่อนว่าจะผลิตอะไรและใช้เครดิตเท่าไร โดยยังไม่เริ่มผลิตจริง

สิทธิ์ที่ต้องใช้: runs:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`template_id`	string	*	Fixed value: episode-production
`template_version`	number	*	Fixed value: 1
`project_revision`	integer	*
`episode_ids`	array	*	ID ของตอนต้องไม่ซ้ำกัน Maximum items: 10 items
`mode`	string	*	Allowed values: reviewed, automatic
`output_profile`	string	*	Allowed values: sandbox-episode-v1, episode-standard-v1

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{project_id}/runsเริ่มการผลิต

เริ่มผลิตตาม plan_id ที่เตรียมไว้และคืน ID การทำงาน ใช้ getRun เพื่อติดตามสถานะและผลลัพธ์

สิทธิ์ที่ต้องใช้: runs:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`plan_id`	string	*	Format: UUID
`client_reference`	string	—	Maximum length: 128 characters

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{project_id}/workflow/commandsแก้ไขการผลิตใน Studio

แก้ไขข้อมูลการผลิต เช่น บท ฉาก งานออกแบบ หรือเทค เลือก operation แล้วส่ง input พร้อม revision ล่าสุด

สิทธิ์ที่ต้องใช้: projects:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*	operation = design.asset.set
`operation`	string	*	operation = design.asset.set Fixed value: design.asset.set
`input`	object	*	operation = design.asset.set
`input.id`	string	*	operation = design.asset.set Format: UUID
`input.asset_id`	string	*	operation = design.asset.set Format: UUID
`input.kind`	string	*	operation = design.asset.set Allowed values: primary, variant
`input.current_asset_id`	oneOf	*	operation = design.asset.set
`input.name`	string	—	operation = design.asset.set Minimum length: 1 characters Maximum length: 80 characters
`revision`	integer	*	operation = asset.delete
`operation`	string	*	operation = asset.delete Fixed value: asset.delete
`input`	object	*	operation = asset.delete
`input.id`	string	*	operation = asset.delete Format: UUID
`revision`	integer	*	operation = trash.restore
`operation`	string	*	operation = trash.restore Fixed value: trash.restore
`input`	object	*	operation = trash.restore
`input.id`	string	*	operation = trash.restore Format: UUID
`input.entity_type`	string	*	operation = trash.restore Allowed values: asset, design
`revision`	integer	*	operation = scene.duplicate
`operation`	string	*	operation = scene.duplicate Fixed value: scene.duplicate
`input`	object	*	operation = scene.duplicate
`input.id`	string	*	operation = scene.duplicate Format: UUID
`revision`	integer	*	operation = project.settings.update
`operation`	string	*	operation = project.settings.update Fixed value: project.settings.update
`input`	object	*	operation = project.settings.update
`input.title`	string	*	operation = project.settings.update Minimum length: 1 characters Maximum length: 120 characters
`input.tags`	array	*	operation = project.settings.update Maximum items: 8 items
`input.cover`	string	*	operation = project.settings.update Allowed values: amber, indigo, teal, rust, moss, ink, sage, bone, wine, wash, blush, void
`input.aspect`	string	*	operation = project.settings.update Allowed values: 16:9, 9:16, 1:1, 4:3, 21:9
`input.resolution`	string	*	operation = project.settings.update Allowed values: 480p, 720p, 1080p, 2k
`input.style`	string	*	operation = project.settings.update Allowed values: realistic_general, realistic_urban, realistic_cinematic, 2d_japanese_manga, 2d_korean_urban, 2d_korean, 2d_otome, 2d_chinese_manga, 2d_classical, 3d_chinese, 3d_xianxia, 3d_cartoon, cg_general, cg_cyberpunk, ink_gongbi, custom
`input.style_prompt`	string	*	operation = project.settings.update Maximum length: 1000 characters
`revision`	integer	*	operation = project.rename
`operation`	string	*	operation = project.rename Fixed value: project.rename
`input`	object	*	operation = project.rename
`input.title`	string	*	operation = project.rename Minimum length: 1 characters Maximum length: 120 characters
`revision`	integer	*	operation = project.state.set
`operation`	string	*	operation = project.state.set Fixed value: project.state.set
`input`	object	*	operation = project.state.set
`input.state`	string	*	operation = project.state.set Allowed values: active, archived
`revision`	integer	*	operation = script.update
`operation`	string	*	operation = script.update Fixed value: script.update
`input`	object	*	operation = script.update
`input.text`	string	*	operation = script.update Maximum length: 5000000 characters
`revision`	integer	*	operation = script.bible.update
`operation`	string	*	operation = script.bible.update Fixed value: script.bible.update
`input`	object	*	operation = script.bible.update
`input.logline`	string	*	operation = script.bible.update Maximum length: 500 characters
`input.synopsis`	string	*	operation = script.bible.update Maximum length: 4000 characters
`revision`	integer	*	operation = episode.save
`operation`	string	*	operation = episode.save Fixed value: episode.save
`input`	object	*	operation = episode.save
`input.id`	string	—	operation = episode.save Format: UUID
`input.title`	string	*	operation = episode.save Minimum length: 1 characters Maximum length: 200 characters
`input.number`	integer	—	operation = episode.save
`input.raw_content`	string	—	operation = episode.save Maximum length: 20000 characters
`input.description`	string	—	operation = episode.save Maximum length: 4000 characters
`revision`	integer	*	operation = episode.delete
`operation`	string	*	operation = episode.delete Fixed value: episode.delete
`input`	object	*	operation = episode.delete
`input.id`	string	*	operation = episode.delete Format: UUID
`revision`	integer	*	operation = scene.save
`operation`	string	*	operation = scene.save Fixed value: scene.save
`input`	object	*	operation = scene.save
`input.id`	string	—	operation = scene.save Format: UUID
`input.episode_id`	string	*	operation = scene.save Format: UUID
`input.heading`	string	*	operation = scene.save Minimum length: 1 characters Maximum length: 200 characters
`input.number`	integer	—	operation = scene.save
`input.description`	string	—	operation = scene.save Maximum length: 4000 characters
`input.video_prompt`	oneOf	—	operation = scene.save
`revision`	integer	*	operation = scene.delete
`operation`	string	*	operation = scene.delete Fixed value: scene.delete
`input`	object	*	operation = scene.delete
`input.id`	string	*	operation = scene.delete Format: UUID
`revision`	integer	*	operation = scene.reorder
`operation`	string	*	operation = scene.reorder Fixed value: scene.reorder
`input`	object	*	operation = scene.reorder
`input.episode_id`	string	*	operation = scene.reorder Format: UUID
`input.scene_ids`	array	*	operation = scene.reorder Maximum items: 500 items
`revision`	integer	*	operation = design.save
`operation`	string	*	operation = design.save Fixed value: design.save
`input`	object	*	operation = design.save
`input.id`	string	—	operation = design.save Format: UUID
`input.kind`	string	*	operation = design.save Allowed values: character, scene, prop, grid
`input.name`	string	*	operation = design.save Minimum length: 1 characters Maximum length: 200 characters
`input.description`	string	—	operation = design.save Maximum length: 4000 characters
`input.tags`	array	—	operation = design.save Maximum items: 8 items
`revision`	integer	*	operation = design.delete
`operation`	string	*	operation = design.delete Fixed value: design.delete
`input`	object	*	operation = design.delete
`input.id`	string	*	operation = design.delete Format: UUID
`revision`	integer	*	operation = design.voice.set
`operation`	string	*	operation = design.voice.set Fixed value: design.voice.set
`input`	object	*	operation = design.voice.set
`input.id`	string	*	operation = design.voice.set Format: UUID
`input.asset_id`	oneOf	*	operation = design.voice.set
`revision`	integer	*	operation = design.asset.detach
`operation`	string	*	operation = design.asset.detach Fixed value: design.asset.detach
`input`	object	*	operation = design.asset.detach
`input.id`	string	*	operation = design.asset.detach Format: UUID
`input.asset_id`	string	*	operation = design.asset.detach Format: UUID
`input.kind`	string	*	operation = design.asset.detach Allowed values: primary, variant, voice
`revision`	integer	*	operation = design.asset.restore
`operation`	string	*	operation = design.asset.restore Fixed value: design.asset.restore
`input`	object	*	operation = design.asset.restore
`input.id`	string	*	operation = design.asset.restore Format: UUID
`input.current_asset_id`	string	*	operation = design.asset.restore Format: UUID
`input.restore_asset_id`	string	*	operation = design.asset.restore Format: UUID
`input.kind`	string	*	operation = design.asset.restore Allowed values: primary, variant
`revision`	integer	*	operation = design.variant.rename
`operation`	string	*	operation = design.variant.rename Fixed value: design.variant.rename
`input`	object	*	operation = design.variant.rename
`input.id`	string	*	operation = design.variant.rename Format: UUID
`input.asset_id`	string	*	operation = design.variant.rename Format: UUID
`input.name`	string	*	operation = design.variant.rename Minimum length: 1 characters Maximum length: 80 characters
`revision`	integer	*	operation = scene.design.attach
`operation`	string	*	operation = scene.design.attach Fixed value: scene.design.attach
`input`	object	*	operation = scene.design.attach
`input.scene_id`	string	*	operation = scene.design.attach Format: UUID
`input.design_id`	string	*	operation = scene.design.attach Format: UUID
`revision`	integer	*	operation = scene.design.detach
`operation`	string	*	operation = scene.design.detach Fixed value: scene.design.detach
`input`	object	*	operation = scene.design.detach
`input.scene_id`	string	*	operation = scene.design.detach Format: UUID
`input.design_id`	string	*	operation = scene.design.detach Format: UUID
`revision`	integer	*	operation = cut.take.select
`operation`	string	*	operation = cut.take.select Fixed value: cut.take.select
`input`	object	*	operation = cut.take.select
`input.scene_id`	string	*	operation = cut.take.select Format: UUID
`input.asset_id`	oneOf	*	operation = cut.take.select
`revision`	integer	*	operation = take.delete
`operation`	string	*	operation = take.delete Fixed value: take.delete
`input`	object	*	operation = take.delete
`input.scene_id`	string	*	operation = take.delete Format: UUID
`input.asset_id`	string	*	operation = take.delete Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{project_id}/cut/exportsส่งออกการตัดต่อ Studio

รวมวิดีโอตามลำดับตอนและฉาก ใช้ selections เลือกเทค และ allow_partial อนุญาตให้ข้ามฉากที่ไม่มีวิดีโอ ติดตามด้วย getJob

สิทธิ์ที่ต้องใช้: jobs:create

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`allow_partial`	boolean	—	Default: true
`selections`	array	—	Maximum items: 200 items
`selections[].scene_id`	string	*	Format: UUID
`selections[].asset_id`	string	*	Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{project_id}/storyboard/videosสร้างวิดีโอฉากสตอรีบอร์ด

สร้างวิดีโอของ scene_id ตามโมเดล ความยาว และความละเอียดที่เลือก ระบุภาพเริ่มต้นด้วย anchor_asset_id ได้ ติดตามด้วย getJob

สิทธิ์ที่ต้องใช้: jobs:create

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`scene_id`	string	*	Format: UUID
`anchor_asset_id`	string	—	Format: UUID
`reference_asset_ids`	array	—	Maximum items: 12 items
`model`	string	—	Default: "video-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 10000 characters
`duration_seconds`	integer	*	Minimum: 1 Maximum: 60
`resolution`	string	*	Minimum length: 1 characters Maximum length: 20 characters
`aspect_ratio`	string	*	Minimum length: 1 characters Maximum length: 20 characters
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/works/{project_id}/designs/imagesสร้างภาพตัวละคร ฉาก อุปกรณ์ประกอบฉาก หรือกริด

สร้างภาพ 1–4 ภาพสำหรับ design_id ระบุพรอมป์ต์และภาพอ้างอิง เลือกภาพหลักหรือภาพแปรผัน แล้วติดตามด้วย getJob

สิทธิ์ที่ต้องใช้: jobs:create

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`revision`	integer	*
`design_id`	string	*	Format: UUID
`variants`	integer	—	Default: 1 Minimum: 1 Maximum: 4
`model`	string	—	Default: "image-standard" Minimum length: 1 characters Maximum length: 200 characters
`prompt`	string	—	Minimum length: 1 characters Maximum length: 20000 characters
`aspect_ratio`	string	—
`image_size`	string	—	Maximum length: 40 characters
`quality`	string	—	Allowed values: low, medium, high
`background`	string	—	Allowed values: auto, opaque, transparent
`output_format`	string	—	Allowed values: png, jpeg
`reference_asset_ids`	array	—	Default: [] Maximum items: 16 items
`slot`	string	—	Allowed values: primary, variant Default: "primary"
`variant_name`	string	—	Minimum length: 1 characters Maximum length: 80 characters
`current_asset_id`	string	—	Format: UUID

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

project_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

อัปโหลด

POST/api/v1/uploadsขอที่อยู่สำหรับอัปโหลดไฟล์

ลงทะเบียนข้อมูลไฟล์และรับ upload_url ส่งไฟล์ด้วย PUT แล้วเรียก API ยืนยันการอัปโหลด รองรับ TXT, Markdown, DOCX, PNG, JPEG, WebP, AVIF, WAV และ ZIP ใช้ขีดจำกัดขนาดร่วมกับ Studio ดู upload_limits จาก GET /capabilities บทสูงสุด 5,000,000 ตัวอักษร ชื่อไฟล์ห้ามมีตัวคั่นพาธ WAV ต้องเป็น PCM หรือ IEEE float

สิทธิ์ที่ต้องใช้: assets:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`	string	*	Format: UUID
`filename`	string	*	Minimum length: 1 characters Maximum length: 200 characters
`mime_type`	string	*	Allowed values: text/plain, text/markdown, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/png, image/jpeg, image/webp, image/avif, audio/wav, application/zip
`size_bytes`	integer	*	Maximum: 1073741824
`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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/uploads/{upload_id}/completeแจ้งว่าอัปโหลดไฟล์เสร็จแล้ว

ตรวจสอบไฟล์ที่อัปโหลดกับข้อมูลที่ลงทะเบียน และคืนข้อมูลสื่อสำหรับใช้ในการผลิต

สิทธิ์ที่ต้องใช้: assets:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`upload_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

upload_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

PUT/api/v1/uploads/{upload_id}/contentอัปโหลดเนื้อหาไฟล์

ส่งข้อมูลไฟล์แบบ application/octet-stream ไปยังที่อยู่อัปโหลดที่ได้รับ แล้วเรียก completeUpload เมื่อสำเร็จ

สิทธิ์ที่ต้องใช้: assets:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`upload_id`path	string	*	Format: UUID

การตอบกลับ

HTTP 200 สำเร็จ

คำขอแรก · JSON

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "data": {
    "uploaded": true
  }
}

เฮดเดอร์การตอบกลับ: X-Request-Id · ETag

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

upload_id path * application/octet-stream

การตอบกลับจากเซิร์ฟเวอร์

ไฟล์และผลลัพธ์

GET/api/v1/assets/{asset_id}ดูข้อมูลผลงานและลิงก์ดาวน์โหลด

ดูข้อมูลสื่อและ download_url ที่ลงนามเมื่อพร้อมดาวน์โหลด ใช้ลิงก์ก่อนหมดอายุ

สิทธิ์ที่ต้องใช้: assets:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`asset_id`path	string	*	Format: UUID

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

asset_id path *

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/downloads/{asset_id}ดาวน์โหลดไฟล์ที่เสร็จแล้ว

ดาวน์โหลดไฟล์ด้วย download_url ที่ลงนามจาก getAsset โดยใช้ URL เต็ม ลิงก์หมดอายุในห้านาที

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`asset_id`path	string	*	Format: UUID
`expires`query	string	*
`signature`query	string	*

การตอบกลับ

HTTP 200 ไบต์ของไฟล์

application/octet-stream · ไบต์ของไฟล์

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

asset_id path *expires query *signature query *

การตอบกลับจากเซิร์ฟเวอร์

การผลิต

GET/api/v1/runsดูรายการงานผลิต

ดูรายการการผลิต โดยกรองตามผลงาน สถานะ client_reference และช่วงเวลา

สิทธิ์ที่ต้องใช้: runs:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100
`project_id`query	string	—	Format: UUID
`state`query	string	—	Allowed values: queued, running, awaiting_review, stopping, paused, needs_attention, partially_succeeded, succeeded, failed, cancelled
`client_reference`query	string	—	Minimum length: 1 characters Maximum length: 128 characters
`from`query	string	—	Format: Date and time with timezone
`to`query	string	—	Format: Date and time with timezone

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

cursor query limit query project_id query state query client_reference query from query to query

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/runs/{run_id}ดูความคืบหน้าของงานผลิต

ดูสถานะ เวอร์ชัน และผลลัพธ์ที่พร้อมของการผลิต ใช้เวอร์ชันนี้เมื่อส่งการตัดสินใจ

สิทธิ์ที่ต้องใช้: runs:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`run_id`path	string	*	Format: UUID

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

run_id path *

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/runs/{run_id}/stepsดูความคืบหน้าทีละขั้น

ดูขั้นตอนและสถานะของการผลิต เพื่อดูว่าขั้นตอนใดรอ กำลังทำ หรือเสร็จแล้ว

สิทธิ์ที่ต้องใช้: runs:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`run_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

run_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/runs/{run_id}/eventsดูบันทึกระหว่างการผลิต

ดูเหตุการณ์ระหว่างการผลิต เช่น การเปลี่ยนสถานะและคำขอตรวจสอบ เพื่อติดตามสิ่งที่เกิดขึ้น

สิทธิ์ที่ต้องใช้: runs:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`run_id`path	string	*	Format: UUID
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

run_id path *cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

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_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	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. Allowed values: approve, stop, resume, cancel_remaining, retry_result
`expected_version`	integer	*
`step_id`	string	—	Format: UUID
`selected_asset_ids`	array	—	Maximum items: 10 items

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

run_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

ฟังก์ชันกระบวนการ

GET/api/v1/jobs/{job_id}ดูสถานะและผลของงาน

ดูสถานะปัจจุบันและ ID สื่อผลลัพธ์ของงาน เมื่อเสร็จแล้วใช้ getAsset เพื่อรับไฟล์

สิทธิ์ที่ต้องใช้: jobs:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`job_id`path	string	*	Format: UUID

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

job_id path *

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/jobs/{job_id}/buildดูความคืบหน้าและแหล่งข้อมูล

ดูขั้นตอน ข้อความความคืบหน้า เอกสารต้นฉบับ และข้อความที่เตรียมประมวลผลของงานสร้างโครงสร้างบท

สิทธิ์ที่ต้องใช้: jobs:read, assets:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`job_id`path	string	*	Format: UUID

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

job_id path *

การตอบกลับจากเซิร์ฟเวอร์

API ??????????????????????

POST/api/v1/jobsสั่งทำทีละฟีเจอร์ทันที

เลือกทำทีละฟีเจอร์ได้ทันที ไม่ต้องรันทั้งกระบวนการ analyze_script อ่านบทแล้วสร้างช็อต generate_image สร้างภาพตัวละคร ฉาก พร็อพ และช็อต generate_video สร้างวิดีโอของช็อตที่เลือกภาพไว้แล้ว ส่วน assemble_video ต่อเป็นตอนเมื่อทุกช็อตมีวิดีโอครบ ให้ส่ง revision ล่าสุดของโปรเจกต์เสมอ คำขอแบบ Live จะกันเครดิตไว้ล่วงหน้า

สิทธิ์ที่ต้องใช้: jobs:create

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`project_id`	string	*	Format: UUID
`project_revision`	integer	*
`target_id`	string	*	Format: UUID
`type`	string	*	Allowed values: analyze_script, generate_image, generate_video, assemble_video
`profile_id`	string	*	Maximum length: 100 characters
`client_reference`	string	—	Maximum length: 128 characters

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

บันทึกคำขอ

GET/api/v1/requestsดูประวัติคำขอที่ส่งไป

ดูประวัติคำขอ API พร้อมสถานะ HTTP และเวลาประมวลผล กรองตามผลงานและช่วงเวลาได้

สิทธิ์ที่ต้องใช้: requests:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100
`from`query	string	—	Format: Date and time with timezone
`to`query	string	—	Format: Date and time with timezone
`project_id`query	string	—	Format: UUID
`run_id`query	string	—	Format: UUID
`job_id`query	string	—	Format: UUID
`key_id`query	string	—	Format: UUID
`status_code`query	integer	—	Minimum: 100 Maximum: 599
`method`query	string	—	Allowed values: GET, POST, PATCH, PUT
`route_template`query	string	—	Minimum length: 1 characters Maximum length: 300 characters

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

cursor query limit query from query to query project_id query run_id query job_id query key_id query status_code query method query route_template query

การตอบกลับจากเซิร์ฟเวอร์

GET/api/v1/requests/{request_id}ดูประวัติคำขอทีละรายการ

ค้นหาคำขอ API ด้วย request_id เพื่อดูสถานะ HTTP เวลา และงานที่เกี่ยวข้อง

สิทธิ์ที่ต้องใช้: requests:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`request_id`path	string	*	Format: UUID

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

request_id path *

การตอบกลับจากเซิร์ฟเวอร์

การใช้งาน

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

การตอบกลับจากเซิร์ฟเวอร์

Webhook

GET/api/v1/webhook-endpointsดูรายการที่อยู่แจ้งเตือน Webhook

ดู URL ของ Webhook ที่ลงทะเบียน เหตุการณ์ที่ติดตาม และสถานะเปิดใช้งาน

สิทธิ์ที่ต้องใช้: webhooks:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/webhook-endpointsเพิ่มที่อยู่แจ้งเตือน Webhook

ลงทะเบียน URL ของ Webhook เพื่อรับเหตุการณ์การผลิตที่เลือกจากผลงานที่ระบุ

สิทธิ์ที่ต้องใช้: webhooks:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`url`	string	*	Format: uri Maximum length: 2000 characters
`project_ids`	array	*	Maximum items: 100 items
`events`	array	*	Maximum items: 4 items

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

PATCH/api/v1/webhook-endpoints/{endpoint_id}แก้ไขที่อยู่แจ้งเตือน Webhook

เปิดหรือปิด Webhook หรือเปลี่ยนประเภทเหตุการณ์ที่รับ

สิทธิ์ที่ต้องใช้: webhooks:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`endpoint_id`path	string	*	Format: UUID
`If-Match`header	string	*	ใช้ ETag ล่าสุดรวมเครื่องหมายคำพูด

เนื้อหาคำขอ

ชื่อ	Type	จำเป็น	คำอธิบาย
`enabled`	boolean	—
`events`	array	—	Maximum items: 4 items

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

endpoint_id path *If-Match header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

การส่ง Webhook

GET/api/v1/webhook-deliveriesดูประวัติการส่ง Webhook

ดูประวัติและสถานะการส่ง Webhook เพื่อตรวจสอบว่าการแจ้งเตือนส่งถึงหรือไม่

สิทธิ์ที่ต้องใช้: webhooks:read

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`cursor`query	string	—	Minimum length: 1 characters Maximum length: 500 characters
`limit`query	integer	—	Default: 20 Minimum: 1 Maximum: 100

การตอบกลับ

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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

cursor query limit query

การตอบกลับจากเซิร์ฟเวอร์

POST/api/v1/webhook-deliveries/{delivery_id}/redeliverส่ง Webhook อีกครั้ง

ขอส่งการแจ้งเตือน Webhook เดิมที่ระบุด้วย delivery_id อีกครั้ง

สิทธิ์ที่ต้องใช้: webhooks:write

พารามิเตอร์

ชื่อ	Type	จำเป็น	คำอธิบาย
`delivery_id`path	string	*	Format: UUID
`Idempotency-Key`header	string	*	ส่งซ้ำด้วย Idempotency-Key และเนื้อหาคำขอเดิม Minimum length: 16 characters Maximum length: 128 characters

เนื้อหาคำขอ

คำขอแรก · 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

การตอบกลับข้อผิดพลาด · error.code ↗

ทดลองเรียก

delivery_id path *Idempotency-Key header * เนื้อหาคำขอ application/json

การตอบกลับจากเซิร์ฟเวอร์

ข้อกำหนด

GET/api/v1/openapi.jsonดาวน์โหลดข้อกำหนด API

ดาวน์โหลดข้อกำหนด OpenAPI ที่มีเส้นทาง API ฟิลด์คำขอ และโครงสร้างการตอบกลับ

พารามิเตอร์

ไม่มีพารามิเตอร์

การตอบกลับ

HTTP 200 ข้อกำหนด OpenAPI

คำขอแรก · JSON

{}

ทดลองเรียก

การตอบกลับจากเซิร์ฟเวอร์

การตอบกลับข้อผิดพลาด · error.code 71

สถานะ 2xx แปลว่าคำขอผ่านแล้ว 201 คือสร้างใหม่เรียบร้อย ส่วน 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.