Overview
API rate limits are restrictions on how often API requests can be made to FileSpin. When rate limits are exceeded, the API usually returns error code 429 - Too Many Requests.
For most APIs, the rate limit is 30r/s. This may be different for custom deployments. Please consult with your FileSpin contact or email Support if in doubt.
API rate limits are applied to:-
- Prevent abuse and ensure fair usage
- Manage server load and maintain service stability
There are two different rate limits FileSpin may apply:-
- API rate limits for valid requests when the number of API calls exceed the limit. This will vary depending on the API and the account. Please contact Support for more details on the rate limits that apply to your account. In general, this rate limit is temporary and will reset within a minute or few minutes automatically.
- API rate limits for invalid requests when invalid requests such as API requesting non-existent asset or API using invalid credentials. This rate limit applies for an extended period and is not reset automatically as the error is caused by non-recoverable client side issue. If you see this for a valid asset id or a valid API key, please contact Support.
Handling rate limits
To handle rate limits, please consider taking actions below:
- Check the rate limit response text for cause
- Validate the request parameters such as asset id and API key
- Implement proper error handling for rate limit responses
- Use exponential backoff and retry strategies
- Cache API responses when possible
- Optimize API usage by batching requests if the API allows batch request
- Monitor API usage and adjust as needed
If additional help is needed, please contact FileSpin Support team at [email protected]