Сгенерировать картинку
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.
Авторизация
BearerAuthAPI-ключ из кабинета souz.ai — запускает модели. Ключ управления здесь не подходит: 403 forbidden с detail[].reason: requires_api_key.
Заголовки
PreferstringRFC 7240. Понимаем respond-async — не ждать результат, сразу ответить 202 с
задачей; остальные предпочтения игнорируются. Долгим моделям — вместе с
Idempotency-Key и вебхуком (callback_url): ответ всегда 202, один путь кода.
"respond-async"Idempotency-KeystringСтрока до 255 символов, уникальная для аккаунта. Повтор с тем же ключом и параметрами
возвращает ту же задачу с текущим статусом без новой задачи и повторного списания,
в том числе при одновременных запросах, даже если настройки аккаунта за это время
изменились: сравниваются только поля запроса. Другие параметры — 409 idempotency_key_conflict;
store и callback_url в сравнение не входят. У изображений, видео и музыки
также не сравнивается response_format; у синтеза речи формат звука сравнивается.
Ключ хранится вместе с задачей, сейчас без ограничения срока.
Повтор задачи со статусом failed не запускает её заново: для новой попытки нужен новый ключ.
Срок хранения файлов результата — retention.files_days из GET /v1/key; повтор его не продлевает.
Поддерживается для генерации изображений, видео и музыки, транскрибации, синтеза речи и
чата. У чата сравнивается тело запроса целиком; повтор дожидается идущего вызова и
получает тот же ответ (и поток), что первый; ответ хранится сутки.
255Тело запроса обязательно
application/jsonaspect_ratiostringСоотношение сторон или auto — умолчание модели.
"16:9"^(auto|[0-9]+:[0-9]+)$backgroundstringauto, transparent, opaquecallback_urlstring · uriКуда прислать вебхук — https на публичный хост; без поля — адрес по умолчанию из настроек аккаунта.
max_price_multiplierMaxPriceMultiplier | nullmodelstringобязательно"nano-banana-pro"moderationstringПоле OpenAI; принимается, модель отвечает со своей модерацией.
auto, lownintegerПоле OpenAI — сколько картинок; больше одной — у моделей, чья карточка это объявляет.
11output_compressionintegerПоле OpenAI; принимается, сжатие файла — как у модели.
0100output_formatstringФормат файла; переводим сами, у любой модели.
png, jpeg, webppartial_imagesintegerПоле OpenAI; промежуточных кадров нет — в потоке приходит только итог.
03promptstringобязательно1qualitystringКонкретный уровень качества по схеме модели. Без поля используется medium; auto — только при явном выборе. Явный уровень ограничивает каналы, которые гарантируют его выполнение. Допустимые значения канала — parameters.quality в GET /v1/models/{id}/channels.
auto, low, medium, high, xhigh, maxreferencesarray[MediaSource]Референсы — картинки.
resolutionstring"2K"response_formatstringПоле OpenAI; b64_json — картинка ещё и base64 в data[].b64_json.
url, b64_json"url"routingRoutingrouting_optionsRoutingOptions | nullsizestringПоле OpenAI: размер ШxВ или auto. Переводится в aspect_ratio и resolution
модели; вместе с ними не присылается (mutually_exclusive).
"1024x1024"^(auto|[0-9]+x[0-9]+)$storeboolean | nullfalse — запрос без хранения: тексты запроса и ответа не сохраняются; файлы живут обычный срок. По умолчанию тексты хранятся; true не отменяет режим без хранения аккаунта.
streamboolean | nullПоле OpenAI; true — ответ text/event-stream: событие image_generation.completed
с картинкой base64 на каждую картинку, затем поток закрывается. Ошибка и задача, не
успевшая за 9 минут, — обычным JSON со статусом.
stylestringПоле OpenAI; принимается, стиль задаёт промпт.
vivid, naturaluserstringПоле OpenAI (id конечного пользователя); принимается, ни на что не влияет и не хранится.
web_searchboolean | nullМодель может сверяться с интернетом.
Ответы
200Задача завершена, результат в `data`; с `stream:true` — поток событий.
application/jsonactionstringВыполненное действие с аудио.
channelChannelId | nullФактический цвет канала запроса: при успехе — канал, который выполнил запрос; пока
запрос идёт — канал, которому он уже отправлен; при ошибке — последний вызванный канал.
null — запрос ещё не отправлялся ни одному каналу или запись старше каналов.
Название и HEX цвета — GET /v1/channels.
completed_atstring | null · date-timeобязательноКогда задача завершилась; null, пока идёт.
createdinteger · int64обязательноТо же время, что created_at, в unix-секундах — как created у OpenAI.
created_atstring · date-timeобязательноФайлы результата; data[0] — сам результат. У музыкальной модели, которая за запрос даёт
два варианта трека, оба — role: result, по порядку. Пустой, пока задача не завершена, и
у чата.
durationnumber | null · doubleТранскрибация — длительность звука в секундах.
Почему задача не удалась; null, если не провалилась.
idstringобязательноjob_…; у чата — chatcmpl-… из его ответа.
"job_1a2b3c4d5e6f"languageLanguageCode | nullТранскрибация — язык записи, код ISO 639-1 (ru, en) у любой модели: названный
моделью или, если она его не назвала, из подсказки language запроса. Язык неизвестен
— поля нет.
Потолок цены, с которым задача принята: из запроса или из настроек аккаунта на момент
приёма. null — без потолка.
modelstringобязательно"nano-banana-pro"model_versionstringВерсия музыкальной модели; используйте её при продолжении исходного трека.
objectstringобязательно"job"persona_idstringID этой задачи для повторного использования созданной персоны.
priceinteger | null · int64обязательноИтог в микроединицах currency — фактический объём × цены сработавшего канала
на момент приёма; null, пока задача не завершена. У проваленной — 0.
0resultMusicResultНастройки каналов, с которыми задача принята: из запроса или из настроек аккаунта на
момент приёма. null — каналы выбирает Авто-роутинг.
segmentsarray[TranscriptionSegment]Транскрибация, verbose_json у модели с таймкодами — фразы: предложение или отрезок
речи до паузы в секунду и дольше, не длиннее 30 с. Начало фразы — начало её первого
слова, конец — конец последнего; одинаково у всех моделей.
textstring | nullТранскрибация — расшифровка; у остальных задач поля нет.
Объём выполненного — токены, символы, секунды; null, где мерить нечего.
voice_idstringID этой задачи для повторного использования созданного голоса.
webhookJobWebhookwordsarray[TranscriptionWord]Транскрибация — слова с таймкодами, если запрошена детализация по словам.
text/event-streamb64_jsonstringобязательноbackgroundstringобязательноcreated_atintegerобязательноoutput_formatstringобязательно"png"qualitystringобязательноsizestringобязательно"1024x1024"typestringобязательно"image_generation.completed"202Задача принята и выполняется.
application/jsonactionstringВыполненное действие с аудио.
channelChannelId | nullФактический цвет канала запроса: при успехе — канал, который выполнил запрос; пока
запрос идёт — канал, которому он уже отправлен; при ошибке — последний вызванный канал.
null — запрос ещё не отправлялся ни одному каналу или запись старше каналов.
Название и HEX цвета — GET /v1/channels.
completed_atstring | null · date-timeобязательноКогда задача завершилась; null, пока идёт.
createdinteger · int64обязательноТо же время, что created_at, в unix-секундах — как created у OpenAI.
created_atstring · date-timeобязательноФайлы результата; data[0] — сам результат. У музыкальной модели, которая за запрос даёт
два варианта трека, оба — role: result, по порядку. Пустой, пока задача не завершена, и
у чата.
durationnumber | null · doubleТранскрибация — длительность звука в секундах.
Почему задача не удалась; null, если не провалилась.
idstringобязательноjob_…; у чата — chatcmpl-… из его ответа.
"job_1a2b3c4d5e6f"languageLanguageCode | nullТранскрибация — язык записи, код ISO 639-1 (ru, en) у любой модели: названный
моделью или, если она его не назвала, из подсказки language запроса. Язык неизвестен
— поля нет.
Потолок цены, с которым задача принята: из запроса или из настроек аккаунта на момент
приёма. null — без потолка.
modelstringобязательно"nano-banana-pro"model_versionstringВерсия музыкальной модели; используйте её при продолжении исходного трека.
objectstringобязательно"job"persona_idstringID этой задачи для повторного использования созданной персоны.
priceinteger | null · int64обязательноИтог в микроединицах currency — фактический объём × цены сработавшего канала
на момент приёма; null, пока задача не завершена. У проваленной — 0.
0resultMusicResultНастройки каналов, с которыми задача принята: из запроса или из настроек аккаунта на
момент приёма. null — каналы выбирает Авто-роутинг.
segmentsarray[TranscriptionSegment]Транскрибация, verbose_json у модели с таймкодами — фразы: предложение или отрезок
речи до паузы в секунду и дольше, не длиннее 30 с. Начало фразы — начало её первого
слова, конец — конец последнего; одинаково у всех моделей.
textstring | nullТранскрибация — расшифровка; у остальных задач поля нет.
Объём выполненного — токены, символы, секунды; null, где мерить нечего.
voice_idstringID этой задачи для повторного использования созданного голоса.
webhookJobWebhookwordsarray[TranscriptionWord]Транскрибация — слова с таймкодами, если запрошена детализация по словам.
400Запрос не принят — `Error`; задача провалилась во время ожидания — объект задачи с
401Нет ключа или ключ недействителен.
application/json402Баланса не хватает на самый дешёвый канал с учётом запросов, которые ещё
Баланса не хватает на самый дешёвый канал с учётом запросов, которые ещё
выполняются (insufficient_balance), или исчерпан лимит трат ключа
(key_spend_limit_exceeded) либо участника, которому он выдан
(member_spend_limit_exceeded). Повтор не поможет, пока баланс не пополнят, а лимит не
начнётся заново или его не поднимут: потолок ключа со spend_limit_reset: none — на
всё время ключа.
application/json403Нельзя: у ключа не тот вид (модели запускает API-ключ, аккаунт — ключ управления), у роли
Нельзя: у ключа не тот вид (модели запускает API-ключ, аккаунт — ключ управления), у роли
участника нет права или подпись ссылки на файл не сходится. detail[].reason говорит,
что именно: requires_api_key, requires_management_key, cabinet_only (только в
кабинете), insufficient_role (в allowed — роли, которым можно), not_key_author
(секрет ключа открывает только тот, кто его создал).
application/json404Нет такого объекта у этого аккаунта.
application/json409Тот же `Idempotency-Key` с другим телом.
application/json413Тело или файл больше предела (`invalid_input`, `detail[].reason: too_large`) или — только у `POST /v1/files` — загрузки аккаунта заняли квоту (`storage_limit_exceeded`).
application/json415Тип тела не тот, что принимает метод: `Content-Type: application/json` (у загрузки файла и транскрибации — `multipart/form-data`). В `detail[]` — `{"path": "body", "reason": "unsupported_format"}` и принимаемые типы.
application/json429Слишком часто — повторите через `Retry-After` секунд. Запуск моделей, задачи и файлы результатов частотой не ограничены (их ограничивают баланс и лимиты трат); здесь 429 — на поток запросов с ключом, который сервер не знает, с одного адреса, и на потоки сверх 1000 одновременных на аккаунт (события задачи, чат с `stream: true`). Пределы — раздел «Лимиты» руководства.
application/json