Баланс аккаунта

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

Зачисленные средства за вычетом списаний за завершённые запросы, в микроединицах валюты из поля currency; не меньше нуля. Превышение расчётной цены запроса над остатком покрывает Союз. У аккаунта без баланса (has_balance: false в /v1/auth/me) — 403 account_without_balance.

Авторизация

ManagementKey

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

ClientSession

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

Ответы

200OK

application/json

Схема BalanceResponse

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

Пример: 10000000

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

Пример: "RUB"

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

Есть ли на этом сервере тестовое пополнение баланса; в рабочем API всегда false.

Пример: false

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

Разрешённая сумма минуса в микроединицах валюты аккаунта.

Минимум: 0

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

Сумма, доступная для новых запросов с учётом овердрафта и текущих обязательств.

Минимум: 0

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

Сколько аккаунт потратил за всё время: сумма списаний за успешные запросы в микроединицах currency. Обновляется в течение минуты после завершения запроса.

Пример: 125000000

Минимум: 0

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/balance' \
  -H "Authorization: Bearer $SOUZ_MANAGEMENT_KEY"

import os
import requests

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

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