Открытый API

Проверка баланса с помощью ключа API

Проверяйте остаток квоты текущего ключа с помощью ключа API sk-: GET /v1/user/balance возвращает is_active / balance / unit, а GET /v1/credits — total_credits / total_usage в стиле OpenRouter. Совместимо с периодическими запросами сторонних клиентов, таких как cc-switch.

С помощью ключа API, начинающегося с sk-, можно напрямую узнать остаток квоты и доступность этого ключа. Это подходит сторонним клиентам, показывающим баланс в интерфейсе, и скриптам, которые следят за балансом.

Эти эндпоинты только для чтения: они не тарифицируются и не расходуют квоту. Аутентификация проверяет только сам ключ, поэтому остаток квоты можно узнать даже тогда, когда квота исчерпана и рабочие запросы были бы отклонены (в этом случае is_active равно false).

1. Обзор эндпоинтов

ЭндпоинтПоддерживаемый формат клиентаВозвращает
GET /v1/user/balanceУниверсальный шаблон баланса cc-switchis_active / balance / unit, а также used / total, если у ключа есть общая квота
GET /user/balanceТо же, для Base URL без /v1Полностью совпадает со строкой выше
GET /v1/creditsСтиль OpenRouterdata.total_credits / data.total_usage
ПараметрЗначение
Base URLhttps://api.lmuai.com
АутентификацияAuthorization: Bearer <sk-...>
Формат ответаJSON
Нужен ли входНет, достаточно ключа API

/user/balance — это псевдоним /v1/user/balance (используется, когда Base URL клиента задан без /v1). У /v1/credits нет псевдонима в корневом пути, /v1 обязателен.

2. Какой баланс возвращается

balance — не обязательно баланс кошелька аккаунта; это остаток квоты, фактически доступный текущему ключу, определяемый в следующем порядке:

ПорядокСитуация с ключомЧто означает balance
1У ключа задана собственная общая квотаОстаток квоты этого ключа (total - used)
2Ключ относится к группе подпискиОстаток квоты подписки (unit равен requests, если подсчёт по запросам)
3Ни то, ни другоеБаланс кошелька аккаунта

Кроме того, is_active показывает, можно ли сейчас использовать ключ для рабочих запросов: true, если ключ активен, не истёк и его общая квота не исчерпана; также false, если ключ относится к группе подписки без действующей подписки.

3. GET /v1/user/balance

GET /v1/user/balance HTTP/1.1
Host: api.lmuai.com
Authorization: Bearer sk-xxxxxxxx

Ответ — режим баланса кошелька (у ключа нет квоты и он не в группе подписки):

{
  "is_active": true,
  "balance": 1575.13,
  "unit": "USD"
}

Ответ — у ключа есть общая квота (в этом случае дополнительно возвращаются used и total):

{
  "is_active": true,
  "balance": 6,
  "unit": "USD",
  "used": 4,
  "total": 10
}

Ответ — группа подписки с подсчётом по запросам:

{
  "is_active": true,
  "balance": 842,
  "unit": "requests"
}

Поля ответа

ПолеТипОписание
is_activeboolМожно ли сейчас использовать ключ для рабочих запросов
balancenumberОстаток квоты; единица измерения указана в unit
unitstringUSD (по умолчанию) или requests для групп подписки с подсчётом по запросам
usednumberПрисутствует только при наличии общей квоты у ключа: уже использованная квота этого ключа
totalnumberПрисутствует только при наличии общей квоты у ключа: общая квота этого ключа

used / total имеют осмысленные значения только в режиме квоты по ключу. В режимах баланса кошелька и подписки эти поля не возвращаются — ориентируйтесь на balance и не вычисляйте его как total - used.

4. GET /v1/credits

Формат баланса в стиле OpenRouter; клиенты показывают остаток квоты как total_credits - total_usage.

GET /v1/credits HTTP/1.1
Host: api.lmuai.com
Authorization: Bearer sk-xxxxxxxx

Ответ:

{
  "data": {
    "total_credits": 20,
    "total_usage": 4
  }
}
ПолеТипОписание
data.total_creditsnumberИспользовано + остаток, чтобы total_credits - total_usage в точности равнялось остатку квоты
data.total_usagenumberУже использованная квота

total_credits — составное значение «использовано + остаток», а не буквальное значение лимита квоты. В режиме баланса кошелька total_usage равен 0, и total_credits равно балансу; при исчерпании квоты остаток ограничивается нулём, поэтому в этом случае total_credits равно использованному объёму.

5. Настройка в сторонних клиентах

Клиент / сценарийКак настроить
Универсальный шаблон баланса cc-switchBase URL https://api.lmuai.com (без /v1) или https://api.lmuai.com/v1 (с /v1) — оба варианта работают
Клиенты, совместимые с OpenRouter (Kelivo, RikkaHub и др.)Base URL https://api.lmuai.com/v1; клиент запросит /v1/credits
Собственный скриптВызывайте /v1/user/balance напрямую — поля проще для восприятия
curl -s https://api.lmuai.com/v1/user/balance \
  -H "Authorization: Bearer sk-xxxxxxxx"

6. Ответы об ошибках

Запрос баланса использует стандартную аутентификацию шлюза по API-ключу, поэтому ошибки приходят в том же формате, что и для других вызовов API. Если в запросе нет ключа:

{
  "code": "API_KEY_REQUIRED",
  "message": "API key is required in Authorization header (Bearer scheme), x-api-key header, or x-goog-api-key header"
}
Код состоянияcodeСитуация
200—Обычный ответ; исчерпанная квота, истёкший ключ или отсутствующая подписка тоже возвращают 200, а is_active: false означает, что ключ нельзя использовать
401API_KEY_REQUIREDВ запросе нет API-ключа
401INVALID_API_KEYКлюч не существует или имеет неверный формат
401API_KEY_DISABLEDКлюч отключён
403ACCESS_DENIEDДля ключа задан список разрешённых / запрещённых IP, и текущий IP не разрешён

Общие ошибки см. в разделе Коды ошибок.

7. Отличие от «Экспорта детализации использования»

Эндпоинты баланса на этой страницеЭкспорт детализации использования
АутентификацияКлюч API sk-Аккаунт и пароль в обмен на JWT
ДетализацияОстаток квоты текущего ключаДетализация по каждому запросу на уровне аккаунта
НазначениеПоказ баланса в клиенте, мониторинг балансаЭкспорт счетов, сверка, загрузка в BI

GET /v1/usage находится между ними: он также принимает ключ sk- и возвращает статистику использования за сегодня и накопительно, а также информацию о квоте текущего ключа, с более подробными полями.

Последнее обновление:

京ICP备2020034311号-7

Экспорт детализации использования

Руководство по экспорту использования LMU AI: войдите, чтобы получить JWT, затем вызовите /api/v1/usage с пагинацией, диапазоном дат и фильтрацией по модели, с примерами на трёх языках.

Вход через LMU AI

Добавьте «Вход через LMU AI» на свой сайт или в приложение: перенаправьте пользователя на страницу авторизации, проверьте state в обратном вызове и на своём сервере обменяйте ticket на данные пользователя с помощью client_secret. В руководстве описаны схема работы, эндпоинты, поля пользователя, требования к безопасности, примеры кода и промпт, который можно сразу передать ИИ-ассистенту для программирования.

На этой странице

1. Обзор эндпоинтов2. Какой баланс возвращается3. GET /v1/user/balanceПоля ответа4. GET /v1/credits5. Настройка в сторонних клиентах6. Ответы об ошибках7. Отличие от «Экспорта детализации использования»