diff --git a/fern/static/images/.DS_Store b/.DS_Store similarity index 53% rename from fern/static/images/.DS_Store rename to .DS_Store index ec5497fdf..bf58f8eff 100644 Binary files a/fern/static/images/.DS_Store and b/.DS_Store differ diff --git a/fern/.DS_Store b/fern/.DS_Store new file mode 100644 index 000000000..a78ee69cf Binary files /dev/null and b/fern/.DS_Store differ diff --git a/fern/advanced/concurrency-limits.mdx b/fern/advanced/concurrency-limits.mdx new file mode 100644 index 000000000..82dca4dae --- /dev/null +++ b/fern/advanced/concurrency-limits.mdx @@ -0,0 +1,36 @@ +--- +title: Managing Concurrency Limits +subtitle: Guide for managing concurrency limits +slug: advanced/concurrency-limits +--- + +# What is Concurrency? +Concurrency refers to the ability to handle multiple API calls simultaneously. Each API plan includes a predefined concurrency limit, capping the total number of active requests across the organization at any given time. This limit applies at the organization level, not to individual accounts or phone numbers, ensuring all resources within the organization share the capacity. By default our plans offer up to 10 concurrent calls at once. + +## Handling Retries +Retries are effective for API calls of short durations. For longer-running calls, such as those exceeding 10 minutes, ensure your retry intervals align with the call duration to prevent premature attempts or wasted resources. + +## Concurrency Limits +The API enforces a concurrency limit, which governs the number of simultaneous API calls. When this limit is exceeded, the API responds with: +```http +HTTP/1.1 400 Bad Request +{ + "error": "Over Concurrency Limit" +} +``` + +## Managing Concurrency Effectively + +By default, plans allow up to 10 concurrent calls, with options to purchase additional capacity as needed by emailing [support@vapi.ai](mailto:support@vapi.ai) + +Use the monitoring tools provided in the API dashboard to: + +- **Reduce simultaneous calls:** Minimize concurrent requests to keep within the limit. +- **Introduce delays:** Space out call initiations to manage traffic. +- **Optimize call durations:** Ensure calls complete efficiently to prevent queue overloads. +- **Track active call usage:** Monitor ongoing API requests to stay within limits from the [Vapi dashboard](https://dashboard.vapi.ai/). +- **Analyze and adjust thresholds:** Identify patterns and reconfigure settings as needed. +- **Reference your dashboard for details of call concurrency limits in your organization's settings page**: + + + \ No newline at end of file diff --git a/fern/docs.yml b/fern/docs.yml index 5fca4b791..f3a5ceeb7 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -255,6 +255,8 @@ navigation: path: voice-fallback-plan.mdx - page: OpenAI Realtime path: openai-realtime.mdx + - page: Managing Concurrency Limits + path: advanced/concurrency-limits.mdx - section: Glossary contents: - page: Definitions diff --git a/fern/static/images/sip/.DS_Store b/fern/static/.DS_Store similarity index 90% rename from fern/static/images/sip/.DS_Store rename to fern/static/.DS_Store index 939f32116..61548b0a1 100644 Binary files a/fern/static/images/sip/.DS_Store and b/fern/static/.DS_Store differ diff --git a/fern/static/images/advanced/org-settings-concurrency-limits.png b/fern/static/images/advanced/org-settings-concurrency-limits.png new file mode 100644 index 000000000..4cb69ef59 Binary files /dev/null and b/fern/static/images/advanced/org-settings-concurrency-limits.png differ