GET/v1/rate_limits

Inspect the caller's current rate-limit state

Read-only peek at the per-API-key and per-workspace token buckets that gate this caller. The call itself consumes one token from each bucket — peeking is rate-limited so it can't be used to dodge enforcement. The same `X-RateLimit-*` headers carried on every v1 response are returned alongside the JSON body.

Header parameters

NameTypeDescription
Spondeo-VersionstringPin a specific API version date. Defaults to the workspace's pinned version, falling back to the latest GA release.

Responses

200Current bucket state.
FieldTypeDescription
objectrequiredconst "rate_limits"
keyrequiredobject
workspacerequiredobject
backendenum (2)Which store backs the limiter. `redis` is the production configuration; `memory` indicates the per-process fallback (typically dev or a Redis outage).
401Missing or invalid API key.
FieldTypeDescription
errorrequiredobject
429The caller has exceeded the per-API-key or per-workspace rate limit. Inspect `X-RateLimit-Bucket` to see which one bound, and wait `Retry-After` seconds before retrying. SDK retry logic handles this automatically with exponential backoff.
FieldTypeDescription
errorrequiredobject

Code samples

curl
curl https://api.spondeo.com/v1/rate_limits \
  -H "Authorization: Bearer $SPONDEO_API_KEY"
Node SDK (@spondeo/node)
import Spondeo from '@spondeo/node';
const spondeo = new Spondeo(process.env.SPONDEO_API_KEY);

const result = await spondeo.ratelimits.call({ /* args */ }) /* operationId: getRateLimits */;
console.log(result);
Python SDK coming soon — until then, any HTTP client works against the curl shape above.