Beschreibungen auf Englisch
Get Usage for Service
Same as GET /usage, narrowed to one service: consumption, remaining allowance and
the reset date.
Handy as a pre-flight check before a large job. An unknown or unavailable service
code returns 404.
Required key permission: billing.read.
Auf dieser Seite(3)
Parameter
Die Eingabefelder liegen direkt in der Anfragezeile: Wert eintragen und die URL ist fertig. Darunter stehen Typ, Pflichtangabe und erlaubte Werte jedes Parameters.
- stringim Pfaderforderlich
Service code — a short latin string rather than a number. The current set is:
Code What it is elevenlabsText-to-speech on the ElevenLabs engine heygenText-to-speech on the HeyGen engine cartesiaText-to-speech on the Cartesia engine fishaudioText-to-speech on the Fish Audio engine lumimgImage generation sfxSound effects musicMusic tracks voice_searchFinding similar voices from an audio clip you upload Where to get the ones for your account:
GET /usagereturns aservice_codefor every service available to you — exactly the values this path accepts. The same code sits in a template’sservice_keyfield.The list is open-ended: connecting a new service adds new codes, so do not hard-code the table above. An unknown code, or one you have no access to, yields
404.Der Wert wird direkt in die Anfragezeile oben eingesetzt.
Mögliche Antworten
200Success. The payload is in data.
Success. The payload is in data.
{
"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 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.
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.
dataerforderlichLimits for a single service — the same records as in GET /usage, filtered down. Usually one or two.
array<object>
Limits for a single service — the same records as in GET /usage, filtered down. Usually one or two.
Identifier of the limit record.
ID of the service the limit applies to. null for limits not tied to a service.
Service code — the value for the GET /usage/{service} path and for a template’s service_key.
Service name for display, in the account language.
ID of the subscription entitlement that granted this limit.
Code of the subscription entitlement that granted the limit.
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.
The ceiling under the current subscription. null means there is no ceiling (see token_unlimited).
How much has been consumed in the current period.
How much is left. null when unlimited.
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.
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).
Time left until the counter resets, in human-readable form. null whenever period_end is null.
true means tokens for this service are unlimited. It does not lift the cap on concurrent tasks.
The limit is exhausted: the next order for this service is rejected until the counter resets or a slot frees up.
Share consumed, 0–100. Always 0 when unlimited.
401The key is missing, unknown, disabled or expired.
The key is missing, unknown, disabled or expired.
{
"success": false,
"message": "API key is missing. Provide it in the X-API-KEY header.",
"data": null
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
Always null when the request is rejected before processing.
403The key lacks the required permission, or the object belongs to another user.
The key lacks the required permission, or the object belongs to another user.
{
"success": false,
"message": "This API key does not have permission to perform this action."
}Always false in error responses.
Error text in the key's language (set through the X-Locale header).
404Not found, or not reachable with this key.
Not found, or not reachable with this key.
{
"success": false,
"message": "Resource not found."
}Error overview.
In der Nähe
Dasselbe in Worten
Benachbarte Operationen
Diese Seite einer KI geben
Spezifikation 0.0.1