Understanding rate limiting

Document360's API allows you to programmatically access and manage your knowledge base content, including articles, categories, and user data. To ensure reliable service and fair usage for all customers, we implement rate limits that control how many API requests you can make within a specific time period.

Rate limits prevent any single user from overwhelming our servers and help maintain consistent performance across our platform.

Tier limits

Rate limits are applied per api_token - the unique authentication key that identifies your Document360 account when making API calls. Each subscription tier has different rate limit allowances based on your plan's features and capacity.

Read requests and write requests have separate limits:

• Read requests fetch content (GET).

• Write requests create, update, or delete content.

Because the two are counted separately, heavy write activity such as a bulk import doesn’t use up your read limit, and heavy reading doesn’t use up your write limit.

API access is available on the Business, Enterprise, and Trial plans. The standard limits for each plan are:

NOTE

• These are our standard rate limits. Your project may have different limits based on your commercial arrangement. To see the limit that applies to a request, check the X-RateLimit-Limit header in the response.

• If you've exhausted your limits, you can restructure your integrations or upgrade to a higher tier. If your integrations regularly exceed the limit, consider optimizing request frequency using caching or batching strategies.

Rate limit responses

Every API response tells you your limit and how many requests you have left:

• X-RateLimit-Limit: your limit for this type of request.

• [X-RateLimit-Remaining]: how many requests you have left in the current window.

If you go over your limit, the API returns [429 Too Many Requests] along with [Retry-After], which gives the number of seconds to wait. Wait that long before you retry. If you retry sooner, the request is rejected again.

If your integrations regularly go over the limit, you can send requests less often by caching responses or batching requests, or you can upgrade to a higher plan.

Header information

Every API response includes headers that help you monitor your usage:

• X-RateLimit-Limit: The maximum number of requests that can be made by the current api_token

• X-RateLimit-Remaining: The remaining number of calls within the time window

• X-RateLimit-Reset: The number of seconds before the limit is reset

Once you exhaust the request limit, any concurrent API call will return an error response with an HTTP code 429. You can refer back to the X-RateLimit-Remaining header, which will inform you when the limit will reset.

NOTE

By default, only the X-RateLimit-Remaining header is included in each response. Once the limit is reached, X-RateLimit-Limit and X-RateLimit-Reset headers are also included.