# Сгенерировать картинку `POST https://api.souz.ai/v1/images/generations` Ждёт результат и отвечает `200` с завершённой задачей — это же ответ `images.generate` SDK OpenAI (`created`, `data[].url`, `data[].b64_json`). Не успело за 9 минут или прислан `Prefer: respond-async` — `202` с задачей в работе. Задача, провалившаяся во время ожидания, отвечает статусом по причине (`400` `invalid_input`/`content_policy`/`capability_mismatch`, `502 generation_failed` или `unknown_error`, `503 model_unavailable`) и телом — объектом задачи с `error`. ## Авторизация - `BearerAuth`: API-ключ из кабинета souz.ai — запускает модели. Ключ управления здесь не подходит: `403 forbidden` с `detail[].reason: requires_api_key`. ## Параметры | Имя | Где | Обязательно | Тип | Описание | |---|---|---|---|---| | `Prefer` | header | нет | `string` | RFC 7240. Понимаем `respond-async` — не ждать результат, сразу ответить `202` с задачей; остальные предпочтения игнорируются. Долгим моделям — вместе с `Idempotency-Key` и вебхуком (`callback_url`): ответ всегда `202`, один путь кода. | | `Idempotency-Key` | header | нет | `string` | Строка до 255 символов, уникальная для аккаунта. Повтор с тем же ключом и параметрами возвращает ту же задачу с текущим статусом без новой задачи и повторного списания, в том числе при одновременных запросах, даже если настройки аккаунта за это время изменились: сравниваются только поля запроса. Другие параметры — `409 idempotency_key_conflict`; store и callback_url в сравнение не входят. У изображений, видео и музыки также не сравнивается response_format; у синтеза речи формат звука сравнивается. Ключ хранится вместе с задачей, сейчас без ограничения срока. Повтор задачи со статусом failed не запускает её заново: для новой попытки нужен новый ключ. Срок хранения файлов результата — `retention.files_days` из `GET /v1/key`; повтор его не продлевает. Поддерживается для генерации изображений, видео и музыки, транскрибации, синтеза речи и чата. У чата сравнивается тело запроса целиком; повтор дожидается идущего вызова и получает тот же ответ (и поток), что первый; ответ хранится сутки. | ## Тело запроса (`application/json`) Схема `ImageGenerationRequest`. | Поле | Обязательно | Тип | Описание | |---|---|---|---| | `aspect_ratio` | нет | `string` | Соотношение сторон или `auto` — умолчание модели. | | `background` | нет | `string`; значения: `auto`, `transparent`, `opaque` | | | `callback_url` | нет | `string, uri` | Куда прислать вебхук — https на публичный хост; без поля — адрес по умолчанию из настроек аккаунта. | | `max_price_multiplier` | нет | | | | `model` | да | `string` | | | `moderation` | нет | `string`; значения: `auto`, `low` | Поле OpenAI; принимается, модель отвечает со своей модерацией. | | `n` | нет | `integer`; по умолчанию `1` | Поле OpenAI — сколько картинок; больше одной — у моделей, чья карточка это объявляет. | | `output_compression` | нет | `integer` | Поле OpenAI; принимается, сжатие файла — как у модели. | | `output_format` | нет | `string`; значения: `png`, `jpeg`, `webp` | Формат файла; переводим сами, у любой модели. | | `partial_images` | нет | `integer` | Поле OpenAI; промежуточных кадров нет — в потоке приходит только итог. | | `prompt` | да | `string` | | | `quality` | нет | `string`; значения: `auto`, `low`, `medium`, `high`, `xhigh`, `max` | Конкретный уровень качества по схеме модели. Без поля используется medium; auto — только при явном выборе. Явный уровень ограничивает каналы, которые гарантируют его выполнение. Допустимые значения канала — parameters.quality в GET /v1/models/{id}/channels. | | `references` | нет | `array` | Референсы — картинки. | | `resolution` | нет | `string` | | | `response_format` | нет | `string`; значения: `url`, `b64_json`; по умолчанию `"url"` | Поле OpenAI; `b64_json` — картинка ещё и base64 в `data[].b64_json`. | | `routing` | нет | схема `Routing` | | | `routing_options` | нет | | | | `size` | нет | `string` | Поле OpenAI: размер `ШxВ` или `auto`. Переводится в `aspect_ratio` и `resolution` модели; вместе с ними не присылается (`mutually_exclusive`). | | `store` | нет | `boolean | null` | `false` — запрос без хранения: тексты запроса и ответа не сохраняются; файлы живут обычный срок. По умолчанию тексты хранятся; `true` не отменяет режим без хранения аккаунта. | | `stream` | нет | `boolean | null` | Поле OpenAI; `true` — ответ `text/event-stream`: событие `image_generation.completed` с картинкой base64 на каждую картинку, затем поток закрывается. Ошибка и задача, не успевшая за 9 минут, — обычным JSON со статусом. | | `style` | нет | `string`; значения: `vivid`, `natural` | Поле OpenAI; принимается, стиль задаёт промпт. | | `user` | нет | `string` | Поле OpenAI (id конечного пользователя); принимается, ни на что не влияет и не хранится. | | `web_search` | нет | `boolean | null` | Модель может сверяться с интернетом. | ## Пример запроса ```bash curl -X POST 'https://api.souz.ai/v1/images/generations' \ -H "Authorization: Bearer $SOUZ_API_KEY" \ -H 'Content-Type: application/json' \ --data '{ "model": "nano-banana-pro", "prompt": "Кот-космонавт на Луне" }' ``` ```python import os import requests response = requests.post( "https://api.souz.ai/v1/images/generations", headers={"Authorization": f"Bearer {os.environ['SOUZ_API_KEY']}"}, json={ "model": "nano-banana-pro", "prompt": "Кот-космонавт на Луне", }, ) print(response.json()) ``` ```ts const response = await fetch("https://api.souz.ai/v1/images/generations", { method: "POST", headers: { Authorization: `Bearer ${process.env.SOUZ_API_KEY}`, "Content-Type": "application/json" }, body: JSON.stringify({ "model": "nano-banana-pro", "prompt": "Кот-космонавт на Луне" }), }); console.log(await response.json()); ``` ## Ответы ### 200 Задача завершена, результат в `data`; с `stream:true` — поток событий. - `application/json`, схема `Job` - `text/event-stream`, схема `ImageGenerationStreamEvent` ### 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`; задача провалилась во время ожидания — объект задачи с `error` (то же поле, что у `Error`, поэтому разбирается одним кодом). `503` на плановых работах — `Error` с кодом `maintenance` (ответ `Maintenance`). - `application/json` ### 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` ### 502 Запрос не принят — `Error`; задача провалилась во время ожидания — объект задачи с `error` (то же поле, что у `Error`, поэтому разбирается одним кодом). `503` на плановых работах — `Error` с кодом `maintenance` (ответ `Maintenance`). - `application/json` ### 503 Запрос не принят — `Error`; задача провалилась во время ожидания — объект задачи с `error` (то же поле, что у `Error`, поэтому разбирается одним кодом). `503` на плановых работах — `Error` с кодом `maintenance` (ответ `Maintenance`). - `application/json` --- Оглавление документации: https://souz.ai/llms.txt. Всё руководство одним файлом: https://souz.ai/llms-full.txt. Справочник методов: https://souz.ai/docs/api-reference.md.