Skip to content

GET /key

The spend, budget, rate limit and expiry of the API key that makes the request.

GET/api/v1/keyAPI key

Returns the settings and the spend of the key that calls it. It never shows the payer's balance.

Response

{
  "data": {
    "label": "production",
    "usage": 1.2345,
    "limit": 10,
    "limit_reset": "monthly",
    "expires_at": null,
    "is_free_tier": false,
    "rate_limit": { "requests": null, "interval": "1m" },
    "currency": "PnP"
  }
}
Field
labelThe key's name.
usagePnP spent in the current budget period.
limitThe key budget in PnP; null without a budget.
limit_resetdaily, weekly, monthly (00:00 Moscow time) or null.
expires_atWhen the key stops working, or null.
rate_limit.requestsRequests per minute set on the key; null means the default limit, see Limits.

Example

curl -s https://router.nodul.ru/api/v1/key -H "Authorization: Bearer $NODUL_ROUTER_API_KEY"
Nodul Router — one API for every model