We’re excited to announce upcoming changes to the way our API handles rate limits. Starting Dec 2nd, 2024, we will be introducing a token-based rate limiting system to ensure scalability and fair resource allocation for all users. Here’s what you need to know to adapt your integrations.
Key Details
- Token-Based Rate Limits: API requests will now use tokens from the end user’s daily budget. Each API request consumes a certain number of tokens depending on the endpoint’s complexity.
- How Budgets are Generated: Daily token budgets are calculated based on the user’s subscription plan and the number of paid seats. These budgets reset every 24 hours, and if the limit is exceeded, any further API requests will return a 429 (Too Many Requests) error until the budget is refreshed the next day.
Best Practices for Efficient API Usage
To optimize your integrations and ensure you stay within budget, we recommend the following:
- Use Caching: Store frequently used data to reduce unnecessary API requests.
- Avoid frequent polling: Implement better polling strategies, such as webhooks, to reduce the load on the API.
- Respect 429 Errors: When a 429 error is returned, make sure your app handles it by backing off and retrying later, respecting the limits set by the system.
Transition to API v2
For developers seeking more efficient API interactions, we’ve introduced API v2, which is more optimized and comes with a lower token cost for certain endpoints. We strongly encourage migrating to API v2 to improve performance and reduce token consumption. You can review the migration guide and documentation to assist with this process.
API Endpoint Costs
Each API endpoint has been assigned a specific token cost based on its resource intensity. Make sure to review the API Endpoint Costs to better plan your usage.
Stay Updated on API Changes
APIs evolve over time. Staying informed on updates and new versions, like API v2, can help you reduce token costs and enhance performance. Always review our API Changelog to stay updated on any upcoming improvements or adjustments to token costs.
Timeline of Changes
- December 2nd, 2024: Token-based rate limits will apply to all new signups.
- March 1st, 2025: The token-based rate limits will begin rolling out for existing customers.
- May 31st, 2025: The rollout will be complete, and all existing customers will be subject to the new limits.
For further details on how to optimize your API usage and prevent disruptions, please refer to the following resources:
We appreciate your understanding and cooperation in ensuring a smooth transition. If you have any questions or need further support, feel free to ask in the Developer Community or contact our support team.