Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.heyy.io/llms.txt

Use this file to discover all available pages before exploring further.

API rate limits are in place to protect the Heyy API from traffic spikes that could put our systems at risk. We measure the number of requests sent to the API and throttle when they exceed the allowed amount. When you exceed the limit, we respond with 429 Too Many Requests and include the following headers:
Header NameDescription
X-RateLimit-LimitMaximum number of requests allowed for the app.
X-RateLimit-RemainingNumber of requests left in the current minute.
X-RateLimit-ResetTime when the request count resets to the maximum. Shown as a UNIX timestamp.

​
Rate limits by plan

Limits are applied per 1-minute window. The table below shows the maximum number of requests allowed per minute for each plan.
PlanRequests per minute
Free10
Hobby100
Pro500
Ultra1,000
EnterpriseCustom

​
Error response example

When you are rate limited, the API returns 429 Too Many Requests with this body: 
{
  "error": {
    "messageKey": "rate_limit_exceeded",
    "message": "Too many requests. Limit is applied per minute per tenant. Please retry after the time indicated by the X-RateLimit-Reset header."
  }
}
Use the X-RateLimit-Reset header to know when you can send requests again, and consider implementing exponential backoff or queuing to avoid hitting the limit repeatedly.