Skip to content
BuildWorkPro Docs

Get current rate-limit consumption

GET
/usage

Returns the calling tenant’s current rate-limit consumption for both the tenant-wide cost-weighted budget (sliding hour) and the per-API-key request limit (sliding minute). Use this to surface live consumption in developer dashboards or to back off proactively before hitting 429. Data is sourced from the same Redis-backed buckets that the rate limiter writes to, so the numbers returned here are exactly the limits enforced.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Current usage

object
data
required
object
tenant
required

Tenant-wide cost-weighted budget (sliding hour window)

object
limit
required
integer
used
required
integer
remaining
required
integer
resetSeconds
required
integer
windowSeconds
required
integer
apiKey
required

Per-API-key request limit (sliding minute window). Null when the caller is OAuth/refresh-token authenticated (not an API key).

object
limit
required
integer
used
required
integer
remaining
required
integer
resetSeconds
required
integer
windowSeconds
required
integer
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer

403

Section titled “403 ”

Scope insufficient

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string