Docs

GET /limits/keys/{id}

Budget, ceiling and current consumption for one key.

Parameters

  • id path · string · required

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
api_key_idstringyes
budget_per_periodinteger | nullyes
consumed_in_periodintegeryes
consumed_in_windowintegeryes
pausedbooleanyes
paused_atstring | nullyes
paused_reasonstring | nullyes
period"hourly" | "daily" | "monthly"yes
period_started_atstringyes
rate_ceiling_per_minuteinteger | nullyes
rate_window_started_atstringyes
updated_atstringyes

Errors

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