Current-window usage for one key (spend / tokens / requests)

Changed on
get/api/v1/admin/keys/{id}/usage

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header x-admin-token
    • HTTP bearer

Path parameters

idstring required

Response

Budget-window counters + rate_headroom (fraction of the tightest RPM/TPM cap left; null = uncapped)

as_ofinteger required
budget_periodstring required

Always "total" (the key attribution window).

groupstring nullable required

The bound groups: entry (null = unlimited key).

idstring required
rate_headroomnumber double nullable required
requestsinteger required
spend_centsinteger required
tokensinteger required
window_startinteger required

Always 0 (the all-time window start).

Changes

  • 857732ef7bbeRevision changes
    • info

      api operation id GetKeysIdUsage was added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status