# Сгенерировать видео `POST https://api.souz.ai/v1/videos` Ролик — минуты, поэтому ответ всегда `202` с задачей в работе. Результат — `GET /v1/jobs/{id}` (или `GET /v1/videos/{id}`), поток событий или вебхук. ## Авторизация - `BearerAuth`: API-ключ из кабинета souz.ai — запускает модели. Ключ управления здесь не подходит: `403 forbidden` с `detail[].reason: requires_api_key`. ## Параметры | Имя | Где | Обязательно | Тип | Описание | |---|---|---|---|---| | `Idempotency-Key` | header | нет | `string` | Строка до 255 символов, уникальная для аккаунта. Повтор с тем же ключом и параметрами возвращает ту же задачу с текущим статусом без новой задачи и повторного списания, в том числе при одновременных запросах, даже если настройки аккаунта за это время изменились: сравниваются только поля запроса. Другие параметры — `409 idempotency_key_conflict`; store и callback_url в сравнение не входят. У изображений, видео и музыки также не сравнивается response_format; у синтеза речи формат звука сравнивается. Ключ хранится вместе с задачей, сейчас без ограничения срока. Повтор задачи со статусом failed не запускает её заново: для новой попытки нужен новый ключ. Срок хранения файлов результата — `retention.files_days` из `GET /v1/key`; повтор его не продлевает. Поддерживается для генерации изображений, видео и музыки, транскрибации, синтеза речи и чата. У чата сравнивается тело запроса целиком; повтор дожидается идущего вызова и получает тот же ответ (и поток), что первый; ответ хранится сутки. | ## Тело запроса (`application/json`) Схема `VideoGenerationRequest`. | Поле | Обязательно | Тип | Описание | |---|---|---|---| | `aspect_ratio` | нет | `string` | | | `audio` | нет | `boolean | null` | Сгенерировать звуковую дорожку. | | `background_source` | нет | `string` | | | `callback_url` | нет | `string, uri` | | | `character_orientation` | нет | `string` | | | `duration_seconds` | нет | `integer` | | | `elements` | нет | `array` | Именованные сущности, на которые промпт ссылается как `@name`. | | `first_frame` | нет | схема `MediaSource` | | | `last_frame` | нет | схема `MediaSource` | | | `max_price_multiplier` | нет | | | | `model` | да | `string` | | | `output_format` | нет | `string`; значения: `mp4`, `mov` | | | `prompt` | да | `string` | | | `reference_audio` | нет | `array` | Звук — `https://…` или `file_…`. | | `reference_videos` | нет | `array` | Клипы — `https://…` или `file_…`. | | `references` | нет | `array` | | | `resolution` | нет | `string` | | | `return_last_frame` | нет | `boolean | null` | Вернуть последний кадр вторым файлом (`role: last_frame`). | | `routing` | нет | схема `Routing` | | | `routing_options` | нет | | | | `seconds` | нет | | Длительность в секундах, как в `videos.create` SDK OpenAI (`"8"`); то же, что `duration_seconds`. | | `shots` | нет | `array` | Сцены вместо одного промпта; сумма длительностей — в пределах ролика. | | `size` | нет | `string` | `ШxВ`, как в `videos.create` SDK OpenAI (`1280x720`): соотношение сторон — ближайшее из `aspect_ratio` модели, разрешение — по короткой стороне. Вместе с `aspect_ratio` или `resolution` не передаётся. | | `store` | нет | `boolean | null` | `false` — запрос без хранения: тексты запроса и ответа не сохраняются; файлы живут обычный срок. По умолчанию тексты хранятся; `true` не отменяет режим без хранения аккаунта. | | `user` | нет | `string` | Поле OpenAI (id конечного пользователя); принимается, ни на что не влияет и не хранится. | | `web_search` | нет | `boolean | null` | | ## Тело запроса (`multipart/form-data`) Схема `VideoGenerationForm`. | Поле | Обязательно | Тип | Описание | |---|---|---|---| | `input_reference` | нет | `string, binary` | | | `model` | да | `string` | | | `prompt` | да | `string` | | | `seconds` | нет | `string` | | | `size` | нет | `string` | | ## Пример запроса ```bash curl -X POST 'https://api.souz.ai/v1/videos' \ -H "Authorization: Bearer $SOUZ_API_KEY" \ -H 'Content-Type: application/json' \ -F 'model=' \ -F 'prompt=' \ --data '{ "callback_url": "https://example.com/hooks/souz", "duration_seconds": 5, "model": "seedance-2", "prompt": "Рассвет над морем, камера медленно поднимается" }' ``` ```python import os import requests response = requests.post( "https://api.souz.ai/v1/videos", headers={"Authorization": f"Bearer {os.environ['SOUZ_API_KEY']}"}, json={ "callback_url": "https://example.com/hooks/souz", "duration_seconds": 5, "model": "seedance-2", "prompt": "Рассвет над морем, камера медленно поднимается", }, data={"model": "", "prompt": ""}, ) print(response.json()) ``` ```ts const form = new FormData(); form.append("model", ""); form.append("prompt", ""); const response = await fetch("https://api.souz.ai/v1/videos", { method: "POST", headers: { Authorization: `Bearer ${process.env.SOUZ_API_KEY}`, "Content-Type": "application/json" }, body: JSON.stringify({ "callback_url": "https://example.com/hooks/souz", "duration_seconds": 5, "model": "seedance-2", "prompt": "Рассвет над морем, камера медленно поднимается" }), body: form, }); console.log(await response.json()); ``` ## Ответы ### 202 Задача принята и выполняется. - `application/json`, схема `Job` ```json { "attempt_count": 0, "completed_at": null, "created": 1758801600, "created_at": "2026-09-25T12:00:00Z", "currency": "RUB", "data": [], "error": null, "id": "job_1a2b3c4d5e6f", "max_price_multiplier": null, "modality": "video", "model": "seedance-2", "object": "job", "price": null, "routing": "cheap", "routing_options": null, "status": "queued", "usage": null } ``` ### 400 Запрос отклонён; `error.detail[]` называет поля и допустимые значения. - `application/json`, схема `Error` ```json { "error": { "code": "capability_mismatch", "detail": [ { "allowed": [ "1:1", "16:9", "9:16" ], "path": "aspect_ratio", "reason": "unsupported_value" } ], "message": "the model does not support this value", "type": "invalid_request_error" } } ``` ### 401 Нет ключа или ключ недействителен. - `application/json`, схема `Error` ### 402 Баланса не хватает на самый дешёвый канал с учётом запросов, которые ещё выполняются (`insufficient_balance`), или исчерпан лимит трат ключа (`key_spend_limit_exceeded`) либо участника, которому он выдан (`member_spend_limit_exceeded`). Повтор не поможет, пока баланс не пополнят, а лимит не начнётся заново или его не поднимут: потолок ключа со `spend_limit_reset: none` — на всё время ключа. - `application/json`, схема `Error` ```json { "error": { "code": "insufficient_balance", "message": "insufficient balance", "type": "billing_error" } } ``` ### 403 Нельзя: у ключа не тот вид (модели запускает API-ключ, аккаунт — ключ управления), у роли участника нет права или подпись ссылки на файл не сходится. `detail[].reason` говорит, что именно: `requires_api_key`, `requires_management_key`, `cabinet_only` (только в кабинете), `insufficient_role` (в `allowed` — роли, которым можно), `not_key_author` (секрет ключа открывает только тот, кто его создал). - `application/json`, схема `Error` ```json { "error": { "code": "forbidden", "detail": [ { "reason": "requires_api_key" } ], "message": "this endpoint takes an API key; a management key manages the account only", "type": "permission_error" } } ``` ### 404 Нет такого объекта у этого аккаунта. - `application/json`, схема `Error` ### 409 Тот же `Idempotency-Key` с другим телом. - `application/json`, схема `Error` ### 413 Тело или файл больше предела (`invalid_input`, `detail[].reason: too_large`) или — только у `POST /v1/files` — загрузки аккаунта заняли квоту (`storage_limit_exceeded`). - `application/json`, схема `Error` ### 415 Тип тела не тот, что принимает метод: `Content-Type: application/json` (у загрузки файла и транскрибации — `multipart/form-data`). В `detail[]` — `{"path": "body", "reason": "unsupported_format"}` и принимаемые типы. - `application/json`, схема `Error` ### 429 Слишком часто — повторите через `Retry-After` секунд. Запуск моделей, задачи и файлы результатов частотой не ограничены (их ограничивают баланс и лимиты трат); здесь 429 — на поток запросов с ключом, который сервер не знает, с одного адреса, и на потоки сверх 1000 одновременных на аккаунт (события задачи, чат с `stream: true`). Пределы — раздел «Лимиты» руководства. - `application/json`, схема `Error` ### 503 Модель сейчас некому исполнить — повторите через `Retry-After`. На плановых работах — `maintenance` (ответ `Maintenance`). - `application/json`, схема `Error` --- Оглавление документации: https://souz.ai/llms.txt. Всё руководство одним файлом: https://souz.ai/llms-full.txt. Справочник методов: https://souz.ai/docs/api-reference.md.