Rate Limits

Get rate limit information.

GET /api/docs/rate-limits

cURL

curl --request GET \
  --url 'http://localhost:8000/api/docs/rate-limits' \
  --header "Authorization: Bearer $STATESET_AGENTS_API_KEY"

200

{
  "rate_limits": {
    "default": {
      "requests_per_minute": 1,
      "description": "Two-person tent, green — replacement for damaged pole set."
    },
    "unauthenticated": {
      "requests_per_minute": 1,
      "description": "Two-person tent, green — replacement for damaged pole set."
    },
    "training": {
      "concurrent_jobs": 1,
      "description": "Two-person tent, green — replacement for damaged pole set."
    }
  },
  "headers": {}
}

Get rate limit information.

Response

object

rate_limits · object · required

Show rate_limits

default · object

Show default

requests_per_minute · integer

description · string

unauthenticated · object

Show unauthenticated

requests_per_minute · integer

description · string

training · object

Show training

concurrent_jobs · integer

description · string

headers · object · required

The X-RateLimit-* headers and what each means

Status codes

Code	Meaning
200	Successful response
401	Authentication required
422	Validation error
429	Rate limit exceeded

cURL

curl --request GET \
  --url 'http://localhost:8000/api/docs/rate-limits' \
  --header "Authorization: Bearer $STATESET_AGENTS_API_KEY"

200

{
  "rate_limits": {
    "default": {
      "requests_per_minute": 1,
      "description": "Two-person tent, green — replacement for damaged pole set."
    },
    "unauthenticated": {
      "requests_per_minute": 1,
      "description": "Two-person tent, green — replacement for damaged pole set."
    },
    "training": {
      "concurrent_jobs": 1,
      "description": "Two-person tent, green — replacement for damaged pole set."
    }
  },
  "headers": {}
}