API Reference - Throttlr

Base URL

https://api.throttlr.dev

All SDK-facing endpoints use API key authentication via the x-api-key header:

x-api-key: sk_live_your_key_here

All dashboard-facing endpoints (projects, rules, logs) use JWT Bearer tokens:

Authorization: Bearer <jwt_token>

This is the primary endpoint the SDK calls internally.

POST /sdk/check

Request body:

{
  "identifier": "user_123",
  "rule": "send_email"
}

Response (200 Allowed):

{
  "allowed": true,
  "count": 3,
  "limit": 10,
  "remaining": 7,
  "rule": "send_email",
  "identifier": "user_123"
}

Response (429 Blocked):

{
  "allowed": false,
  "count": 10,
  "limit": 10,
  "remaining": 0,
  "rule": "send_email",
  "identifier": "user_123"
}

All errors follow this shape:

{
  "error": {
    "code": "RULE_NOT_FOUND",
    "message": "No rule named 'send_emial' found for this tenant"
  }
}

HTTP Status	Meaning
`400`	Missing or invalid request fields
`401`	Missing or invalid API key
`404`	Rule not found
`429`	Rate limit exceeded
`500`	Internal server error