-
Notifications
You must be signed in to change notification settings - Fork 16.9k
[RealtimeKit] Add API and SDK limits #33560
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
7a29f6e
[RealtimeKit] Add API and SDK limits
swapnilmadavi ae51b8b
[RealtimeKit] Clarify SDK limit scope
swapnilmadavi 7417050
[RealtimeKit] Correct API rate limits
swapnilmadavi 6f3519b
[RealtimeKit] Refine API rate limits description
swapnilmadavi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| title: Limits | ||
| description: Review RealtimeKit API and SDK limits. | ||
| pcx_content_type: reference | ||
| sidebar: | ||
| order: 22 | ||
| products: | ||
| - realtime | ||
| --- | ||
|
|
||
| RealtimeKit applies limits to API requests and SDK operations. Use these values when designing your application. | ||
|
|
||
| ## API rate limits | ||
|
|
||
| RealtimeKit API requests count toward the global Cloudflare API limit, which | ||
| applies across all `api.cloudflare.com` API requests. Recording APIs are | ||
| subject to a separate limit. | ||
|
|
||
| | API | Limit | | ||
| | -------------------- | ------------------------------- | | ||
| | All RealtimeKit APIs | 3,500 requests per five minutes | | ||
| | Recording APIs | 1,000 requests per 50 seconds | | ||
|
|
||
| ## SDK rate limits | ||
|
|
||
| Each participant has a separate limit for SDK operations during an active session. | ||
| Limits are not shared across participants or applied to your app as a whole. For | ||
| example, in a two-participant meeting, each participant can send up to 180 text | ||
| messages per minute. | ||
|
|
||
| | Operation | Limit | | ||
| | -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | | ||
| | Write to a [Collaborative Store](/realtime/realtimekit/collaborative-stores/) (`set()`, `update()`, `delete()`, `bulkSet()`, `bulkDelete()`) | 5 invocations per second | | ||
| | Broadcast a message (`broadcastMessage()`) | 5 invocations per second | | ||
| | Send a text message (`sendTextMessage()`) | 180 invocations per minute | | ||
| | Send a message (`sendMessage()`) | 180 invocations per minute | | ||
| | Send an image (`sendImageMessage()`) | 20 invocations per minute | | ||
| | Send a file (`sendFileMessage()`) | 20 invocations per minute | | ||
| | Fetch connected meetings (`getConnectedMeetings()`) | 60 invocations per minute | | ||
| | Fetch meeting participants (`getAllJoinedPeers()`) | 10 invocations per minute | | ||
| | Update participant permissions (`updatePermissions()`) | 1,000 invocations per minute | | ||
|
|
||
| ## Data retention | ||
|
|
||
| For the retention periods for recordings, chat, transcripts, analytics, and webhook logs, refer to [Data retention](/realtime/realtimekit/data-retention/). | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.