Получить решения

POSThttps://api.souz.ai/v1/decisions

Отвечает на типизированные вопросы о содержимом state: вероятность «да» (noul), выбор варианта (choice), место на шкале (score) и рамку на картинке (box, у моделей с этим типом в params). Формат совместим с TypeSafe POST /v1/systemone. Ответ синхронный, без потока; платный объём — входные токены, выход бесплатен. Если исход установить нельзя, API отвечает 502 generation_failed и ничего не списывает. Повтор с тем же Idempotency-Key и тем же телом получает ответ первого вызова без второго списания. Подробнее: https://souz.ai/docs/decisions.

Авторизация

BearerAuth

API-ключ из кабинета souz.ai, запускает модели. Ключ управления здесь не подходит: API отвечает 403 forbidden с detail[].reason: requires_api_key.

Заголовки

Idempotency-Keystring

Строка до 255 символов, уникальная в пределах аккаунта. Повтор с тем же ключом и параметрами возвращает ту же задачу с текущим статусом, без новой задачи и второго списания. Это работает и при одновременных запросах, и после смены настроек аккаунта: сравниваются только поля запроса. Тот же ключ с другими параметрами получает 409 idempotency_key_conflict. В сравнение не входят store и callback_url, у картинок, видео и музыки ещё и response_format; у синтеза речи формат звука сравнивается. Ключ хранится вместе с задачей без ограничения срока. Повтор проваленной задачи не запускает её заново: для новой попытки нужен новый ключ. Повтор не продлевает срок файлов результата (retention.files_days из GET /v1/key). Ключ работает для картинок, видео, музыки, транскрибации, синтеза речи и чата. У чата и POST /v1/responses сравнивается тело запроса целиком; повтор дожидается идущего вызова и получает тот же ответ (и поток), что первый. Ответ чата хранится сутки. Подробнее: https://souz.ai/docs/idempotency.

Максимальная длина: 255

Тело запроса обязательно

application/json
Схема DecisionRequest
Других полей нет.
assetsobject

Картинки по ключу. Укажите ключ в state, в instructions или в criteria там, где картинка нужна; ключ без упоминания получает 400.

Любой ключDecisionImage
max_price_multiplierMaxPriceMultiplier | null
modelstringобязательно
Пример: "jev-1.14"
questionsobjectобязательно

Вопросы по имени ответа.

Любой ключDecisionQuestion
routingRouting
routing_optionsRoutingOptions | null
stateDecisionContentобязательно

Содержимое, о котором вопросы.

storeboolean | null

false выключает хранение текстов запроса и ответа для этого запроса.

Ответы

200Ответы на все вопросы.
application/json
Схема Decision
answersobjectобязательно

Ответы по именам вопросов.

Любой ключDecisionAnswer
channelChannelId | nullобязательно

Цвет канала, который ответил. Название и HEX отдаёт GET /v1/channels.

idstringобязательно

job_…; тот же id открывает GET /v1/jobs/{id}.

modelstringобязательно
usageDecisionUsageобязательно
202Задача принята и выполняется.
application/json
Схема Job
actionstring

Выполненное действие с аудио.

attempt_countAttemptCountобязательно
channelChannelId | null

Нынешний цвет канала запроса. При успехе это канал, который выполнил запрос; пока запрос идёт — канал, которому он отправлен; при ошибке — последний вызванный канал. null значит, что запрос ещё не отправлялся ни одному каналу. Название и HEX цвета отдаёт GET /v1/channels; цвета нет в палитре — канал закрыт.

completed_atstring | null · date-timeобязательно

Когда задача завершилась; null, пока идёт.

createdinteger · int64обязательно

То же время, что created_at, в unix-секундах, как created у OpenAI.

created_atstring · date-timeобязательно
currencyCurrencyобязательно
dataarray[OutputFile]обязательно

Файлы результата; data[0] — сам результат. Музыкальная модель, которая за запрос даёт два варианта трека, возвращает оба с role: result по порядку. Список пуст, пока задача не завершена, и у чата.

durationnumber | null · double

Транскрибация: длительность звука в секундах.

errorErrorBody | nullобязательно

Почему задача не удалась; null, если не провалилась.

idstringобязательно

job_…; у чата — chatcmpl-… из его ответа.

Пример: "job_1a2b3c4d5e6f"
languageLanguageCode | null

Транскрибация: язык записи, код ISO 639-1 (ru, en) у любой модели. Язык называет модель, а если не назвала, он берётся из подсказки language запроса. Если язык неизвестен, поля нет.

max_price_multiplierMaxPriceMultiplier | nullобязательно

Потолок цены, с которым задача принята: из запроса или из настроек аккаунта на момент приёма. null значит без потолка.

modalityModalityобязательно
modelstringобязательно
Пример: "nano-banana-pro"
model_versionstring

Версия музыкальной модели; передайте её при продолжении исходного трека.

objectstringобязательно
Значение: "job"
persona_idstring

Id этой задачи для повторного использования созданной персоны.

priceinteger | null · int64обязательно

Итог в микроединицах currency: фактический объём × цены сработавшего канала на момент приёма. null, пока задача выполняется или уточняется цена готового результата; готовый результат доступен сразу, окончательная цена появится в этой же задаче. У проваленной задачи 0.

Минимум: 0
routingRoutingобязательно
routing_optionsRoutingOptions | nullобязательно

Настройки каналов, с которыми задача принята: из запроса или из настроек аккаунта на момент приёма. null значит, что каналы выбирает Авто-роутинг.

segmentsarray[TranscriptionSegment]

Транскрибация с verbose_json: отрезки речи с таймкодами. Если модель дала слова, фразы строятся из них и длятся не больше 30 секунд, а с diarize новая фраза начинается и со сменой говорящего; без слов возвращаются готовые сегменты ответа. Без меток поля нет.

statusJobStatusобязательно
textstring | null

Транскрибация: расшифровка. У остальных задач поля нет.

usageJobUsage | nullобязательно

Объём выполненного: токены, символы, секунды; null, где мерить нечего.

voice_idstring

Id этой задачи для повторного использования созданного голоса.

webhookJobWebhook
wordsarray[TranscriptionWord]

Транскрибация: слова с таймкодами, если запрошена детализация по словам. Без меток поля нет.

400Запрос отклонён; `error.detail[]` называет поля и допустимые значения.
application/json
401Нет ключа или ключ недействителен.
application/json
402Запрос не принят из-за денег. `insufficient_balance` значит, что баланса не хватает на

Запрос не принят из-за денег. insufficient_balance значит, что баланса не хватает на самый дешёвый канал с учётом запросов, которые ещё выполняются. key_spend_limit_exceeded значит, что исчерпан потолок трат ключа, member_spend_limit_exceeded — лимит участника, которому выдан ключ. Повтор не поможет, пока баланс не пополнят, лимит не начнётся заново или его не поднимут. Потолок ключа со spend_limit_reset: none действует на всё время ключа. Подробнее: https://souz.ai/docs/balance.

application/json
403Действие запрещено: у ключа не тот вид (модели запускает API-ключ, аккаунтом управляет

Действие запрещено: у ключа не тот вид (модели запускает API-ключ, аккаунтом управляет ключ управления), у роли участника нет права или подпись ссылки на файл не сходится. Причину называет detail[].reason: requires_api_key, requires_management_key, cabinet_only (только в кабинете), insufficient_role (в allowed перечислены роли с правом), not_key_author (секрет ключа открывает только его автор).

application/json
404Нет такого объекта у этого аккаунта.
application/json
409Конфликт с состоянием: тот же `Idempotency-Key` пришёл с другим телом

Конфликт с состоянием: тот же Idempotency-Key пришёл с другим телом (idempotency_key_conflict) или секрет ключа нельзя показать (secret_unavailable).

application/json
413Тело или файл больше предела (`invalid_input`, `detail[].reason: too_large`). У

Тело или файл больше предела (invalid_input, detail[].reason: too_large). У POST /v1/files так же отвечает переполненная квота загрузок аккаунта (storage_limit_exceeded).

application/json
415Тип тела не подходит методу. Методы принимают `Content-Type: application/json`, загрузка

Тип тела не подходит методу. Методы принимают Content-Type: application/json, загрузка файла и транскрибация — multipart/form-data, создание видео — оба типа. В detail[] приходит {"path": "body", "reason": "unsupported_format"} с принимаемыми типами.

application/json
429Слишком частые запросы: повторите через `Retry-After` секунд. Запуск моделей, задачи и

Слишком частые запросы: повторите через Retry-After секунд. Запуск моделей, задачи и файлы результатов частотой не ограничены, их ограничивают баланс и лимиты трат. 429 получает поток запросов с одного адреса с ключом, который сервер не знает, и потоки сверх 1000 одновременных на аккаунт (события задачи, чат с stream: true). Пределы: https://souz.ai/docs/limits.

application/json
502Модель не справилась или исход вызова неизвестен; ничего не списано.
application/json
503Модель сейчас некому исполнить: повторите через `Retry-After`. На плановых работах

Модель сейчас некому исполнить: повторите через Retry-After. На плановых работах приходит maintenance (ответ Maintenance).

application/json