gateway.openapi_Gateway

Returns a single user's usage-limits singleton (override, effective cap, usage, and whether they are over limit).

get/v1/accounts/{account_id}/users/{user_id}/usageLimits

Request

  • Base URL: https://api.fireworks.ai
  • URL: https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/usageLimits
  • Auth: HTTP bearer

Path parameters

account_idstring required

The Account Id

user_idstring required

The User Id

Response

A successful response.

namestring
enforcementMode'ENFORCEMENT_MODE_UNSPECIFIED' | 'DISABLED' | 'WARN' | 'BLOCK'

EnforcementMode controls what happens when a user reaches their limit.

  • DISABLED: No tracking, no notifications, no enforcement.
  • WARN: Usage is tracked but never blocked. A safe stage before BLOCK.
  • BLOCK: Usage is tracked and the user is blocked at their limit until the period resets.
exceededUntilstring date-time

When set, the user is over their limit and blocked until this time (the end of the current consumption period). Unset when the user is not over limit. Computed at read time; not stored.

updateTimestring date-time

The time this user's override was last set or changed. Unset when the user has no override (they inherit the account default); it tracks the override row, not account-default changes.

Changes

No recorded changes to this operation across all 1 revision of this API.