FECINE OPEN API v1.1.0

Справочник API

От сценария до готового видео — объедините производство с FECINE API.

Аутентификация

Используйте ключ FECINE как Bearer-токен. Для чтения документации аккаунт не нужен.

Создать и запустить

Создайте произведение, загрузите сценарии и материалы, добавьте персонажей, локации, реквизит и сетки. Создайте эпизоды и сцены, прикрепите референсы и сгенерируйте видео сцен. Выберите дубль каждой сцены и экспортируйте итоговый монтаж. Дождитесь завершения генерации; при редактировании передавайте актуальную 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Создать изображение персонажа, локации, реквизита или сетки

Создаёт от одного до четырёх изображений для 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, затем вызовите завершение загрузки. Поддерживаются 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. Ссылка действует пять минут.

Параметры

Имя	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}Посмотреть один отправленный запрос

Находит вызов по 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. Исключения — скачивание файлов и документ спецификации. При ошибке все эндпоинты возвращают 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.