Account: Key Status
| Endpoint | Answers |
|---|---|
/v3/key-status | Which plan is this key on? What can it call? How many credits are left? How far back can it read? |
Any key can call it, including a Free key. See Access.
Key Status
curl "https://api.elfa.ai/v3/key-status" \
-H "x-elfa-api-key: $ELFA_API_KEY"
GET /v3/key-status: what your key can do and what it has left. No scope, no parameters, and it
answers even when credits run out.
{
"plan": "payg",
"billingMode": "deposit",
"owner": "user",
"scopes": ["key-status", "chat", "events", "calls", "entities"],
"credits": {
"limit": null,
"used": 407,
"remaining": 2223,
"resetsAt": null,
"requestsPerMinute": 60
},
"historyFrom": 1788307200
}
A PAYG key, scopes trimmed to 5 of its 25.
| Field | Meaning |
|---|---|
plan | payg, grow or enterprise. A Free key reads payg, with no v3 scope in scopes |
billingMode | deposit: a prepaid balance. arrears: a subscription, billed after use |
owner | user or org: whose account these numbers are. Its keys share them |
scopes | Every scope the key holds, /v2 included. They follow the plan |
credits.limit, credits.resetsAt | The monthly limit and its reset (1st of the month, UTC). null on prepaid |
credits.used | Credits used this month, UTC |
credits.remaining | Prepaid: the balance. Subscription: limit minus used, never below 0 |
credits.requestsPerMinute | The per-minute limit on this key |
historyFrom | The earliest time this plan reads. See History |
Sending any parameter is a 400. An Enterprise key not set up yet gets 403,
Enterprise API keys require explicit configuration…: email
[email protected] with the requestId.