İçeriğe geç
Lumean API

Açıklamalar İngilizce

Bölümün arayüzü dilinize çevrildi, ancak işlem, şema ve hata açıklamaları yalnızca Rusça ve İngilizce mevcut — burada İngilizce sürüm gösteriliyor.
GET/usage

Get Usage Limits

A summary of every limit for the key owner: how much has been consumed, the ceiling granted by the current subscription, the limit type and when the counter resets.

billing.read

It also shows which services are available to you at all — the set is defined by the entitlements of the active subscription.

Do not conflate the two limit types: a periodic quota (resets at reset_at) and concurrent task slots (freed as soon as your running orders finish). Exhausting the first means waiting for the period to end; the second, only minutes.

Required key permission: billing.read.

Bu sayfada(2)

Olası yanıtlar

200

Success. The payload is in data.

Gövde örneği
{
  "success": true,
  "message": "Success",
  "data": [
    {
      "limit_id": 10,
      "service_id": 1,
      "service_code": "sfx",
      "service_name": "Sound Effects",
      "entitlement_id": null,
      "entitlement_code": null,
      "limit_type": "hourly",
      "limit_value": 100,
      "used": 0,
      "remaining": 100,
      "period_start": null,
      "period_end": null,
      "resets_in": null,
      "token_unlimited": false
    },
    {
      "limit_id": 11,
      "service_id": 2,
      "service_code": "music",
      "service_name": "Music Generation",
      "entitlement_id": null,
      "entitlement_code": null,
      "limit_type": "hourly",
      "limit_value": 100,
      "used": 0,
      "remaining": 100,
      "period_start": null,
      "period_end": null,
      "resets_in": null,
      "token_unlimited": false
    },
    {
      "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
    }
  ]
}
Yanıt alanları
successzorunlu

Success flag. Branch on the HTTP status code instead: any 2xx response carries true here, while an error comes back in a different shape that need not contain this field at all.

boolean
messagezorunlu

A human-readable note in the account language. Fine to show to a user; do not parse it — the wording changes without notice and is not an error code.

string
datazorunlu

One record per limit granted by your subscription. An empty list means there is no active subscription and generation is unavailable.

array<object>
dizi öğesi
limit_idzorunlu

Identifier of the limit record.

integer
service_idzorunlu

ID of the service the limit applies to. null for limits not tied to a service.

null olabilir
integer
service_codezorunlu

Service code — the value for the GET /usage/{service} path and for a template’s service_key.

null olabilir
string
service_namezorunlu

Service name for display, in the account language.

null olabilir
string
entitlement_idzorunlu

ID of the subscription entitlement that granted this limit.

null olabilir
integer
entitlement_codezorunlu

Code of the subscription entitlement that granted the limit.

null olabilir
string
limit_typezorunlu

What exactly is being capped. Two fundamentally different things:

  • a periodic quota — consumption over a period, reset at period_end;
  • concurrent-task slots — freed on their own as soon as your running orders finish.

Exhausting the first means waiting for the period to end; the second, minutes.

string
limit_valuezorunlu

The ceiling under the current subscription. null means there is no ceiling (see token_unlimited).

null olabilir
integer
usedzorunlu

How much has been consumed in the current period.

integer
remainingzorunlu

How much is left. null when unlimited.

null olabilir
integer
period_startzorunlu

Start of the current accounting period, ISO 8601. null while no accounting period is open yet (used is then 0): the limit was never touched, or was consumed only in past periods — a period opens with the first consumption, not by the calendar.

null olabilir
string
period_endzorunlu

End of the current accounting period, ISO 8601 — the counter resets at that moment. null wherever period_start is null (no period open yet) and for limits without a period (concurrent, total).

null olabilir
string
resets_inzorunlu

Time left until the counter resets, in human-readable form. null whenever period_end is null.

null olabilir
string
token_unlimitedzorunlu

true means tokens for this service are unlimited. It does not lift the cap on concurrent tasks.

boolean
is_exceededzorunlu

The limit is exhausted: the next order for this service is rejected until the counter resets or a slot frees up.

boolean
usage_percentagezorunlu

Share consumed, 0–100. Always 0 when unlimited.

number
401

The key is missing, unknown, disabled or expired.

Bu yanıtı çözümle
Gövde örneği
{
  "success": false,
  "message": "API key is missing. Provide it in the X-API-KEY header.",
  "data": null
}
Yanıt alanları
successzorunlu

Always false in error responses.

boolean
messagezorunlu

Error text in the key's language (set through the X-Locale header).

string
datazorunlu

Always null when the request is rejected before processing.

null olabilir
null
403

The key lacks the required permission, or the object belongs to another user.

Bu yanıtı çözümle
Gövde örneği
{
  "success": false,
  "message": "This API key does not have permission to perform this action."
}
Yanıt alanları
successzorunlu

Always false in error responses.

boolean
messagezorunlu

Error text in the key's language (set through the X-Locale header).

string

İlgili içerik

Komşu işlemler

Bu sayfayı yapay zekâya verin

.md sürümünü açllm.md

spesifikasyon 0.0.1