Skip to main content
GET
Get the calling credential's rate-limit buckets
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Returns the state of your credential’s three rate-limit buckets, so a client can plan a batch before it starts instead of learning its budget from a 429. See Rate Limiting for how the buckets work.

Authorization

GET /api/v2/me/limits requires no permission. Any Platform API credential can call it: a platform API key, a Personal key, or an External Application access token. The buckets are keyed by the credential that authenticated the request. The endpoint takes no identifier. A request that sends any query parameter or a body is refused with 400 and code bad_request, so there is no way to read another key’s or app’s buckets. A missing, revoked or expired credential receives the usual 401, with no data and no RateLimit-* headers.

Response

Each bucket has: Each organization.classes entry has limit (the ceiling’s capacity) and refillPerMinute, at ten times the credential bucket of the same class. The ceiling is shared, so it reports its configuration, not what is left of it. A Forge deployment serves one organization, so the ceiling is deployment-wide and organization.scope is always "deployment". When the ceiling refuses a request, the 429 names the organization rather than the credential. The numbers are current as of the request: a bucket you have not used for a while reads as refilled. This request spends one read request, which classes.read.remaining already counts. While Forge’s rate limiter is degraded and a fallback bucket admitted this request, classes.read reports that fallback bucket, and its remaining is an estimate, as in RateLimit-Remaining. Every token an External App issues shares the app’s buckets, so one app’s tokens together spend one budget. A route’s own tighter limit, such as Workflow Architect, Procedure Builder or agent setup turns, is not listed here. Each operation in the OpenAPI spec names its class in x-forge-rate-limit.

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Response

The calling credential's read, write and expensive buckets

data
object
required
meta
object
required