Каталог моделей

GEThttps://api.souz.ai/v1/models

Совместим с models.list SDK OpenAI. У каждой модели — итоги статистики за 7 дней (stats_7d), почасовой ряд — в GET /v1/models/{id}/stats; итоги обновляются раз в час. Гостевой ответ — Cache-Control: public, max-age=30, stale-while-revalidate=300 и ETag: с If-None-Match того же ETag — 304 без тела. С авторизацией возвращает цены текущего аккаунта; такой ответ — Cache-Control: private, no-cache с тем же ETag.

Авторизация

BearerAuth

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

ManagementKey

Ключ управления из кабинета souz.ai (выдают владелец и администратор аккаунта — себе или участнику). Даёт ровно то, что его держатель видит и может в кабинете: баланс, историю операций и запросов, расходы, обычные ключи, настройки аккаунта — с той же ролью, лимитами и цифрами. Модели не запускает. Обычный API-ключ здесь не подходит: 403 forbidden с detail[].reason: requires_management_key.

ClientSession

Сессия кабинета souz.ai в браузере — те же ручки, что у ключа управления.

Параметры запроса

modalityModality

Только модели этой модальности.

Ответы

200Все модели каталога.

application/json

Схема ModelList

dataarray[Model]обязательно

generated_atstring · date-timeобязательно

Когда собран каталог (до часа).

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

Значение: "list"

304Не изменилось с прошлого раза: `If-None-Match` совпал с `ETag`.

400Запрос отклонён; `error.detail[]` называет поля и допустимые значения.

application/json

Error

401Нет ключа или ключ недействителен.

application/json

Error

403Нельзя: у ключа не тот вид (модели запускает API-ключ, аккаунт — ключ управления), у роли

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

application/json

Error

429Слишком часто — повторите через `Retry-After` секунд. Запуск моделей, задачи и файлы результатов частотой не ограничены (их ограничивают баланс и лимиты трат); здесь 429 — на поток запросов с ключом, который сервер не знает, с одного адреса, и на потоки сверх 1000 одновременных на аккаунт (события задачи, чат с `stream: true`). Пределы — раздел «Лимиты» руководства.

application/json

Error

Бесплатно, со своим ключом

Запрос

curl -X GET 'https://api.souz.ai/v1/models' \
  -H "Authorization: Bearer $SOUZ_API_KEY"

import os
import requests

response = requests.get(
    "https://api.souz.ai/v1/models",
    headers={"Authorization": f"Bearer {os.environ['SOUZ_API_KEY']}"},
)
print(response.json())

const response = await fetch("https://api.souz.ai/v1/models", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.SOUZ_API_KEY}` },
});
console.log(await response.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"
  }
}

{
  "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"
  }
}