Skip to content
BuildWorkPro Docs

Get current rate-limit consumption

GET
/usage
 
curl --request GET \
  --url https://app.buildworkpro.com/api/v1/usage \
  --header 'Authorization: Bearer <token>'

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

Media type application/json
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
Example generated 
{
  "data": {
    "tenant": {
      "limit": 1,
      "used": 1,
      "remaining": 1,
      "resetSeconds": 1,
      "windowSeconds": 1
    },
    "apiKey": {
      "limit": 1,
      "used": 1,
      "remaining": 1,
      "resetSeconds": 1,
      "windowSeconds": 1
    }
  },
  "meta": {
    "request_id": "example",
    "pagination": {
      "cursor": "example",
      "has_more": true,
      "count": 1
    }
  }
}

403

Section titled “ 403 ”

Scope insufficient

Media type application/problem+json
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
Example generated 
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}