Skip to main content
GET
/
get-concurrency
JavaScript
import Retell from 'retell-sdk';

const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
});

const concurrency = await client.concurrency.retrieve();

console.log(concurrency.base_concurrency);
{
  "current_concurrency": 10,
  "concurrency_limit": 100,
  "base_concurrency": 20,
  "purchased_concurrency": 80,
  "concurrency_purchase_limit": 100,
  "remaining_purchase_limit": 20,
  "concurrency_burst_enabled": true,
  "concurrency_burst_limit": 60
}

Authorizations

​
Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Response

Successfully retrieved a voice.

​
current_concurrency
integer

The current concurrency (amount of ongoing calls) of the org.

Example:

10

​
concurrency_limit
integer

The total concurrency limit (at max how many ongoing calls one can make) of the org. This should be the sum of base_concurrency and purchased_concurrency.

Example:

100

​
base_concurrency
integer

The free concurrency limit of the org.

Example:

20

​
purchased_concurrency
integer

The amount of concurrency that the org has already purchased.

Example:

80

​
concurrency_purchase_limit
integer

The maximum amount of concurrency that the org can purchase.

Example:

100

​
remaining_purchase_limit
integer

The remaining amount of concurrency that the org can purchase. This is the difference between concurrency_purchase_limit and purchased_concurrency.

Example:

20

​
concurrency_burst_enabled
boolean

Whether burst concurrency mode is enabled. When enabled, allows the org to exceed their normal concurrency limit with a surcharge.

Example:

true

​
concurrency_burst_limit
integer

The maximum concurrency limit when burst mode is enabled. This is calculated as min(3x normal limit, normal limit + 300). Returns 0 if burst mode is disabled.

Example:

60