From f9f5293fd3bb7ddc2ae678202da9bb06111fd69b Mon Sep 17 00:00:00 2001 From: Iman Hassanein Date: Fri, 6 Dec 2024 11:50:22 -0500 Subject: [PATCH] add specification to global search ratelimit --- docs/concepts/rate-limits-and-quotas.mdx | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/concepts/rate-limits-and-quotas.mdx b/docs/concepts/rate-limits-and-quotas.mdx index 8b4b407..ce2fa8b 100644 --- a/docs/concepts/rate-limits-and-quotas.mdx +++ b/docs/concepts/rate-limits-and-quotas.mdx @@ -4,9 +4,17 @@ title: 'Rate Limits and Quotas' ## Rate Limits -API usage exceeding 1 request per second is subject to Flare's API rate limit. +API usage is subject to Flare's API rate limit. Rate Limits are enforced **per organization**. +Calls to certain resources have differing independant limits as follows: +- Basic: 2 requests per second +- Search: 1 request per second + +For example, a user may perform a total of 3 requests per second, two basic requests and one search request. + +Any endpoint that is not subject to basic limit will be identified as such. + Enforced limits receive a `RATELIMIT_REACHED` error message with the status code 429. If you receive 429 errors, Flare's recommended course of action is to wait 10 seconds before retrying. @@ -28,7 +36,7 @@ If you receive 429 errors, Flare's recommended course of action is to wait 10 se ## Quotas API users are responsible for monitoring their Global Search API usage and ensuring it remains within their allocated monthly quota. -Users with account administration rights can also view their Global Search API monthly calls by logging into the platform and navigating to [the tenants page](https://app.flare.io/#/tenants). +Users with account administration rights can also view their Global Search API monthly calls by logging into the platform and navigating to [the tenants page](https://app.flare.io/#/tenants). Moreover, each global search response includes `X-Flare-Global-Searches-Remaining`, indicating the number of API calls remaining in your monthly allocation.