Skip to main content

API usage restrictions

This page provides a brief overview of the restrictions of the Agora Signaling SDK, including API call limit, string size, encoding, and more.

API call limit

Unless otherwise specified below, limit the API call frequency by a single client to 20 calls per second. If the number of calls per second exceeds 20, some calls are ignored by the SDK. If you need to call more APIs per second, contact support@agora.io.

General

ItemSoft limitHard limitComments
Number of projects in an account1000-To change the limit, contact support@agora.io.
Number of client instances11Attempts to create multiple instances fail.
Number of message channels per app IDUnlimited-Channel resources are public, users can take them as needed.
Number of stream channels per app IDUnlimited-Channel resources are public, users can take them as needed.
User ID length64 ASCII characters64 ASCII charactersExceeding the soft limit produces an error.

Message channel

ItemSoft limitHard limitComments
Message sending rate/client60 messages/sec60 messages/secExceeding the soft limit produces an error. To change the limit, contact support@agora.io.
Number of subscribers per channelUnlimited-
Number of publishers per channelUnlimited-
Number of subscribed channels per client50-Exceeding the soft limit produces an error.
Message packet size32 KB32 KBExceeding the soft limit produces an error. To change the limit, contact support@agora.io.
Channel name length64 ASCII characters64 ASCII charactersExceeding the soft limit produces an error.
Custom message type length32 ASCII characters32 ASCII charactersExceeding the soft limit produces an error.

Stream channel

ItemSoft limitHard limitComments
Number of channels a client can createUnlimited-
Number of channels a client can join10-A single client can join a maximum of 10 channels simultaneously; exceeding this soft limit results in an error message. To increase the limit, contact support@agora.io.
Number of users per channel128128A single channel can accommodate a maximum of 128 users simultaneously; exceeding this soft limit results in an error message. To increase the limit, contact support@agora.io.
Number of topics per channelUnlimited-
Channel name length64 ASCII characters64 ASCII charactersExceeding the soft limit produces an error.

Topic

ItemSoft limitHard limitComments
Number of topics joined by a client in a channel88Exceeding the soft limit produces an error.
Number of messages published by a client in a topic per second200 messages/sec200 messages/secExceeding the soft limit produces an error. To change the limit, contact support@agora.io.
Number of topics subscribed to by a client in a channel5050Exceeding the soft limit produces an error.
Number of users subscribed to a topic by a client6464A single client can subscribe up to 64 user IDs to a single topic. Exceeding the soft limit produces an error.
Number of publishers in a topicUnlimited-
Topic name length16 ASCII characters16 ASCII charactersThe topic name length will be extended to 64 ASCII characters in future releases.
Message packet size1 KB1 KBExceeding the soft limit produces an error. To change the limit, contact support@agora.io.
Custom message type length32 ASCII characters32 ASCII charactersExceeding the soft limit produces an error.

Presence

ItemSoft limitHard limitComments
Presence timeoutAdjustable range: 5 - 300 seconds
Default: 300 seconds
-When the set timeout value is exceeded, the SDK matches the closest boundary value. For example, if you set presence timeout to 400 seconds, the actual application time is 300 seconds. To change the limit, contact support@agora.io.
Number of temporary user state key/value pairs32 pairs32 pairsExceeding the soft limit produces an error.
Number of temporary user states cached before joining the channel100100Exceeding the soft limit produces an error.

Storage

ItemSoft limitHard limitComments
Metadata item key length32 ASCII characters-
Number of metadata sets per user or channel11Each channel and each user can only have one set of channel or user metadata, respectively.
Number of items per channel metadata or user metadata setUnlimited-
Storage space per channel or user metadata set16 KB-To change the limit, contact support@agora.io.
Storage space per metadata item16 KB-To change the limit, contact support@agora.io.
Channel metadata API call frequency by a single client10 times/sec20 times/secTo change the limit, contact support@agora.io.
User metadata API call frequency by a single client10 times/sec20 times/secTo change the limit, contact support@agora.io.
Number of channel metadata sets per app ID1 million-
Number of user metadata sets per app ID1 million-To change the limit, contact support@agora.io.

Lock

ItemSoft limitHard limitComments
Number of locks per channel32-To change the limit, contact support@agora.io.
Number of locked locks per clientUnlimited-
Lock TTL (Time to live)10 seconds - 300 seconds10 seconds - 300 secondsWhen a user leaves a channel or disconnects, the lock held by that user is automatically released after the set time. When the set value is exceeded, the SDK matches the closest boundary value. For example, if you set lock TTL to 400 seconds, the actual application time is 300 seconds.
Lock length64 ASCII characters64 ASCII charactersExceeding the soft limit produces an error.
Number of locks per app ID1 million-Exceeding the soft limit produces an error. To change the limit, contact support@agora.io.
Lock acquisition API call frequency10 times/sec-

Miscellaneous

  • The number of RESTful API requests per second per app ID are limited to 500. To extend the limit, contact support@agora.io.
  • The max number of concurrent users is 50,000. To extend the limit, contact support@agora.io.
  • The max number of daily active users is 500,000. To extend the limit, contact support@agora.io.
  • The max number of users in a single channel is 50,000. To extend the limit, contact support@agora.io.