союз.ai

Ключ, которым сделан запрос

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

Сам ключ: его потолок трат (spend_limit), как потолок обновляется (spend_limit_reset) и сколько потрачено (spent), пресет роутинга и потолок цены по умолчанию и сроки хранения — то, что агенту полезно знать до первого запроса. Баланс и история аккаунта — GET /v1/balance и GET /v1/balance/history ключом управления (тег account); не хватает баланса или исчерпан лимит — запрос получит 402. Ключи создаются и настраиваются в кабинете или ключом управления.

Авторизация

BearerAuth

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

Ответы

200Ключ.
application/json
Схема APIKey
created_atstring · date-timeобязательно
currencyCurrencyобязательно
expires_atstring | null · date-timeобязательно
idstringобязательно
Пример: "key_1a2b3c4d5e6f7890"
kindstringобязательно

management — ключ управления: модели не запускает, у него нет трат.

Значения: user, playground, agent, management
last_used_atstring | null · date-timeобязательно
max_price_multiplierMaxPriceMultiplier | nullобязательно
namestring
no_storebooleanобязательно

Режим без хранения аккаунта (no_store в GET /v1/settings): тексты запросов не сохраняются; файлы живут обычный срок.

objectstringобязательно
Значение: "api_key"
retentionobjectобязательно
chat_content_daysintegerобязательно
files_daysintegerобязательно
routingRoutingобязательно
routing_optionsModelRoutingOptions | null
spend_limitinteger | null · int64обязательно

Потолок трат ключа; null — без потолка.

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

Как обновляется потолок: none — потолок на всё время ключа, сам не обновляется; daily / monthly — spent считается с 00:00 UTC текущего дня / с 1-го числа текущего месяца. У ключа без потолка (spend_limit: null) — тоже none.

Значения: none, daily, monthly
spentinteger · int64обязательно

Потрачено в текущем окне потолка (при none — за всё время ключа), только завершённые списания.

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