К содержанию
Lumean API

GET/usage/{service}

То же, что GET /usage, но по одному сервису: расход, остаток и дата сброса счётчика.

billing.read

Удобно проверить перед крупной задачей, хватит ли квоты. Неизвестный или недоступный вам код сервиса → 404.

Требуемое право ключа: billing.read.

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

Параметры

Поля ввода живут прямо в строке запроса: подставьте значение — и получите готовый URL. Ниже — тип, обязательность и допустимые значения каждого параметра.

GEThttps://api.lumean.app/api/public/usage/
  • stringв путиобязательный

    Код сервиса — короткая латинская строка, а не число. Сейчас существуют:

    КодЧто это
    elevenlabsОзвучка текста (TTS) на движке ElevenLabs
    heygenОзвучка текста (TTS) на движке HeyGen
    cartesiaОзвучка текста (TTS) на движке Cartesia
    fishaudioОзвучка текста (TTS) на движке Fish Audio
    lumimgГенерация изображений
    sfxЗвуковые эффекты
    musicМузыкальные треки
    voice_searchПодбор похожего голоса по загруженному аудиофрагменту

    Где взять для своего аккаунта: GET /usage возвращает service_code по каждому доступному вам сервису — это ровно те значения, которые примет этот путь. Тот же код лежит в поле service_key шаблона.

    Список открыт: при подключении нового сервиса в нём появляются новые коды, поэтому зашивать таблицу выше в клиент не стоит. Незнакомый либо недоступный вам код → 404.

    Значение подставляется прямо в строку запроса выше.

Возможные ответы

200

Лимиты для сервиса

Пример тела
{
  "success": true,
  "message": "Success",
  "data": [
    {
      "limit_id": 12,
      "service_id": 3,
      "service_code": "elevenlabs",
      "service_name": "ElevenLabs TTS",
      "entitlement_id": 2,
      "entitlement_code": "elevenlabs_tts",
      "limit_type": "monthly",
      "limit_value": 500000,
      "used": 128400,
      "remaining": 371600,
      "period_start": "2026-07-01T00:00:00+00:00",
      "period_end": "2026-08-01T00:00:00+00:00",
      "resets_in": "2 weeks from now",
      "token_unlimited": false
    }
  ]
}
Поля ответа
successобязательное

Признак успеха. Решение принимайте по HTTP-коду: у любого ответа 2xx здесь true, а ошибка приходит телом другой формы, где этого поля может не быть вовсе.

boolean
messageобязательное

Пояснение для человека, на языке аккаунта. Показать пользователю можно; разбирать программно — нет: формулировки меняются без предупреждения и кодом ошибки не являются.

string
dataобязательное

Лимиты по одному сервису — те же записи, что в GET /usage, но отфильтрованные. Обычно одна-две.

array<object>
элемент массива
limit_idобязательное

Идентификатор записи лимита.

integer
service_idобязательное

ID сервиса, к которому относится лимит. null у лимитов, не привязанных к сервису.

может быть null
integer
service_codeобязательное

Код сервиса — то самое значение для пути GET /usage/{service} и для service_key шаблона.

может быть null
string
service_nameобязательное

Название сервиса для показа, на языке аккаунта.

может быть null
string
entitlement_idобязательное

ID возможности подписки, которая выдала этот лимит.

может быть null
integer
entitlement_codeобязательное

Код возможности подписки, выдавшей лимит.

может быть null
string
limit_typeобязательное

Что именно ограничивается. Две принципиально разные вещи:

  • периодическая квота — расход за период, обнуляется по period_end;
  • слоты одновременных задач — освобождаются сами, как только ваши текущие заказы завершатся.

Исчерпание первой ждёт конца периода, второй — минут.

string
limit_valueобязательное

Потолок по текущей подписке. null — потолка нет (см. token_unlimited).

может быть null
integer
usedобязательное

Сколько израсходовано в текущем периоде.

integer
remainingобязательное

Сколько осталось. null при безлимите.

может быть null
integer
period_startобязательное

Начало текущего периода учёта, ISO 8601. null, если учёт в текущем периоде ещё не открыт (used при этом 0): лимит не трогали вовсе либо тратили только в прошлых периодах — период открывается первым расходом, а не по календарю.

может быть null
string
period_endобязательное

Конец текущего периода учёта, ISO 8601 — в этот момент счётчик обнулится. null там же, где period_start (учёт в текущем периоде ещё не открыт), и у лимитов без периода (concurrent, total).

может быть null
string
resets_inобязательное

Сколько осталось до сброса счётчика, в человекочитаемом виде. null там же, где period_end.

может быть null
string
token_unlimitedобязательное

true — токены по этому сервису не ограничены. Ограничение на одновременные задачи это НЕ снимает.

boolean
is_exceededобязательное

Лимит исчерпан: следующий заказ по этому сервису будет отклонён, пока счётчик не сбросится или не освободится слот.

boolean
usage_percentageобязательное

Доля израсходованного, 0–100. При безлимите всегда 0.

number
401

Невалидный или отсутствующий API-ключ

Разобрать этот ответ
Пример тела
{
  "success": false,
  "message": "API key is missing. Provide it in the X-API-KEY header.",
  "data": null
}
Поля ответа
successобязательное

Всегда false в ответах об ошибке.

boolean
messageобязательное

Текст ошибки на языке ключа (задаётся заголовком X-Locale).

string
dataобязательное

Всегда null, когда запрос отклонён до обработки.

может быть null
null
403

У ключа нет права billing.read

Разобрать этот ответ
Пример тела
{
  "success": false,
  "message": "This API key does not have permission to perform this action."
}
Поля ответа
successобязательное

Всегда false в ответах об ошибке.

boolean
messageобязательное

Текст ошибки на языке ключа (задаётся заголовком X-Locale).

string
404

Сервис не найден

Разобрать этот ответ
Пример тела
{
  "success": false,
  "message": "Resource not found."
}
Поля ответа
messageобязательное

Error overview.

string

Рядом

Об этом словами

Соседние операции

Скормить страницу ИИ

Открыть .mdllm.md

спека 0.0.1