Rate limits
To ensure optimal performance and fair usage for all users, AIOZ Stream implements rate limits on various API requests and operations. Rate limits help protect the platform from abuse and ensure that resources are available to all users in a balanced manner. This documentation will outline the different rate limits applied to API calls, uploads, live streaming, and other operations on the platform.
Overview of rate limits
Rate limits are applied to prevent excessive use of resources and maintain the stability and reliability of the AIOZ Stream service. They define the maximum number of requests or actions that can be performed within a specific timeframe. If a user exceeds these limits, additional requests may be temporarily blocked or delayed until the limit resets.
Key concepts
- Request Quota: The maximum number of API requests or operations allowed within a specified time period.
- Time Window: The duration for which the rate limit is calculated, such as per second, minute, or hour.
- Backoff Strategy: A mechanism where clients are required to wait before making additional requests if they exceed the rate limit.
- Error Responses: When rate limits are exceeded, the API returns specific error codes and messages to inform the user about the limit breach.
Rate limits for different operations
AIOZ Stream applies rate limits across various operations to manage resources effectively. Here are the details:
1. API rate limits
The AIOZ Stream API is subject to rate limits to ensure fair usage and prevent abuse. These limits restrict the number of accepted API requests per minute.
| Production | |
|---|---|
| Uploads | 100 |
| Writes | 200 |
| Reads | 500 |
- Requests per Minute: 100 requests per minute with uploads API.
- Requests per Minute: 200 requests per minute with writes API.
- Requests per Minute: 500 requests per minute with reads API.
If you exceed these limits, you will receive a 429 Too Many Requests error
with a message indicating the time remaining before you can retry.
Handling rate limit errors
The API returns information about the applied rate limits in the header of every response. Check these header element:
- X-RateLimit-Limit: Shows the applied request limit per minute
- X-RateLimit-Remaining: Shows the number of available requests you have left for the current time window.
- X-RateLimit-Retry-After: Shows the number of seconds left until the current rate limit window resets.
When a rate limit is exceeded, the API will return a 429 Too Many Requests
response with the following details:
- Error Code:
429 - Error Message: "Too many requests. Please wait X seconds before retrying."
- Retry-After Header: Specifies the number of seconds the client should wait before making another request.
You can scale down your request volume and return the failed, rate limited requests to your queue to wait according to the value of X-RateLimit-Retry-After.
Monitoring and managing usage
To monitor your usage and stay within the rate limits:
- Check Usage Metrics: Navigate to the "Account" section in your dashboard to view your usage metrics and rate limit statuses.
- Optimize API Calls: Avoid unnecessary API requests and batch operations where possible to stay within the limits.
Conclusion
Rate limits on AIOZ Stream are designed to ensure a fair, stable, and secure experience for all users. Understanding these limits and how to work within them is crucial for optimizing your usage of the platform. If you have any questions or need assistance, please contact our support team for further guidance.