Skip to content

rate_limit_exceeded (429)

← Error reference

rate_limit_exceeded

HTTP status: 429

Retryable: Yes. The request did not change server state.

The caller exceeded its rate limit.

When it fires

A request went over a limit. Each organization has a per-key limit for each route class, and an IP limit applies before authentication. Three API requests share an invite limit: POST /v1/sessions with send_invite: true, resend, and reset_and_resend. Through these requests, your organization can send at most three invite emails in an hour to one email address. Only resend and reset_and_resend answer this 429 for it. A creation over the limit still succeeds and sends no invite, so deliver applicant_url or send the invite another way. A reset_and_resend that the limit refuses also does not rotate the link or reset progress.

How to handle it

When details.reset_at is present, wait until that time (UNIX epoch seconds), then retry. The invite limit's refusal has a details.window_seconds of 3600. For that refusal and the per-key limit's refusal, if you sent an Idempotency-Key to a route that honors it, use a new one, because Checktiv replays a stored refusal for the old key. The header is not honored by the session browser_token, workspace_token and regenerate_link endpoints. The IP limit's refusal is not stored. Rotating a link replaces the single-use link and the client_token. For a session that belongs to a reservation from a connected system, it does not stop the reservation's own link. To stop that link, cancel the session. To rotate a link before details.reset_at, use the Generate new link action on the applicant's detail page in the console. It is offered when the page says the link was already used or has expired. It sends no email and does not use the invite limit. While the page shows the link to copy, the console offers no rotation. POST /v1/sessions/{id}/regenerate_link then issues a new single-use link without an email and keeps the client_token. For sustained traffic, request a higher limit via support. The invite limit is the same on every tier.

Rate limits: the per-recipient invite limit and the other limits

Example response

{
  "error": {
    "type": "https://docs-dev.autohost-dev.uk/api/errors/rate_limit_exceeded",
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded for this API key",
    "request_id": "req_01HEXAMPLE0000000000000000",
    "doc_url": "https://docs-dev.autohost-dev.uk/api/errors/rate_limit_exceeded",
    "details": {
      "reset_at": 1717000060,
      "limit": 100,
      "window_seconds": 60,
      "route_class": "sessions:create",
      "tier": "standard"
    }
  }
}