Skip to main content
GET
/
v1
/
rate
/
limits
Get Rate Limits and Usage
curl --request GET \
  --url https://api.example.com/v1/rate/limits \
  --header 'x-api-key: <x-api-key>'
{
  "rate_limits": {
    "minute": {
      "count": 123,
      "limit": 123,
      "exceeded": true,
      "remaining": 123,
      "reset_time": "<string>"
    },
    "hour": {
      "count": 123,
      "limit": 123,
      "exceeded": true,
      "remaining": 123,
      "reset_time": "<string>"
    },
    "day": {
      "count": 123,
      "limit": 123,
      "exceeded": true,
      "remaining": 123,
      "reset_time": "<string>"
    }
  },
  "limits": {
    "maximum_requests_per_minute": 123,
    "maximum_requests_per_hour": 123,
    "maximum_requests_per_day": 123,
    "tokens_per_agent": 123
  },
  "tier": "<string>",
  "timestamp": "<string>",
  "success": true
}

Headers

x-api-key
string
required

Response

Successful Response

rate_limits
RateLimitsInfo · object
required

Current rate limit usage information for different time windows.

limits
RateLimitLimits · object
required

The configured rate limits based on the user's subscription tier.

tier
string | null
required

The user's current subscription tier (free or premium).

timestamp
string | null
required

ISO timestamp when the rate limits information was retrieved.

success
boolean | null
default:true

Indicates whether the rate limits request was successful.