Docs

GET /limits/keys

The fleet: every key with its budget, ceiling, consumption, identity and current loop state.

Parameters

  • limit query · integer · optional
  • cursor query · string · optional
  • after query · string · optional

Responses

  • 200 Success
  • 400 Validation error
  • 401 Missing API key
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 429 Rate limited
  • 500 Internal server error

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
dataarray<object>yes
data[].api_key_idstringyes
data[].budget_per_periodinteger | nullyes
data[].consumed_in_periodintegeryes
data[].consumed_in_windowintegeryes
data[].last_used_atstring | nullyes
data[].loop_evidenceobjectyes
data[].loop_state"clear" | "watch" | "tripped"yes
data[].namestringyes
data[].pausedbooleanyes
data[].paused_atstring | nullyes
data[].paused_reasonstring | nullyes
data[].period"hourly" | "daily" | "monthly"yes
data[].period_started_atstringyes
data[].rate_ceiling_per_minuteinteger | nullyes
data[].rate_window_started_atstringyes
data[].systembooleanyes
data[].token_prefixstringyes
data[].updated_atstringyes
has_morebooleanyes
next_cursorstring | nullyes

Errors

Codes in the catalogue that answer with one of this operation’s error statuses. Every one of them carries a fix.