Merge branch 'main' into sri/add-mcp-server-docs

Author: ramsrib

fern/advanced/sip/sip-telnyx.mdx

@@ -50,10 +50,7 @@ To allow Vapi.ai to make outbound calls through your Telnyx account:
 1. **Set Up Outbound Authentication**
    - Go to Voice / SIP Trunking / Authentication and routing
    - Scroll down to "Outbound calls authentication"
-   - Whitelist Vapi's SIP server IPs:
-     - **44.229.228.186**
-     - **44.238.177.138**
-   - Select Tech Prefix and create a new credential for Vapi to use
+   - Create a new credential for Vapi to use
    <Frame>
      <img src="../../static/images/sip/telynx-outbound-auth.png" />
    </Frame>
@@ -153,4 +150,4 @@ curl --location 'https://api.vapi.ai/call/phone' \
 
 Replace all placeholder values with your actual information.
 
-By following these steps, your Telnyx SIP trunk will be fully integrated with Vapi.ai, allowing your AI voice assistants to manage calls effectively.
+By following these steps, your Telnyx SIP trunk will be fully integrated with Vapi.ai, allowing your AI voice assistants to manage calls effectively.

fern/apis/api/openapi.json

@@ -0,0 +1,184 @@
+---
+title: WebSocket Transport
+description: Stream audio directly via WebSockets for real-time, bidirectional communication
+slug: calls/websocket-transport
+---
+
+# WebSocket Transport
+
+Vapi's WebSocket transport enables real-time, bidirectional audio communication directly between your application and Vapi's AI assistants. Unlike traditional phone or web calls, this transport method lets you stream raw audio data instantly with minimal latency.
+
+## Key Benefits
+
+- **Low Latency**: Direct streaming ensures minimal delays.
+- **Bidirectional Streaming**: Real-time audio flow in both directions.
+- **Easy Integration**: Compatible with any environment supporting WebSockets.
+- **Flexible Audio Formats**: Customize audio parameters such as sample rate.
+- **Automatic Sample Rate Conversion**: Seamlessly handles various audio rates.
+
+## Creating a WebSocket Call
+
+To initiate a call using WebSocket transport:
+
+```bash
+curl 'https://api.vapi.ai/call' \
+  -H 'authorization: Bearer YOUR_API_KEY' \
+  -H 'content-type: application/json' \
+  --data-raw '{
+    "assistant": { "assistantId": "YOUR_ASSISTANT_ID" },
+    "transport": {
+      "provider": "vapi.websocket",
+      "audioFormat": {
+        "format": "pcm_s16le",
+        "container": "raw",
+        "sampleRate": 16000
+      }
+    }
+  }'
+```
+
+### Sample API Response
+
+```json
+{
+  "id": "7420f27a-30fd-4f49-a995-5549ae7cc00d",
+  "assistantId": "5b0a4a08-133c-4146-9315-0984f8c6be80",
+  "type": "vapi.websocketCall",
+  "createdAt": "2024-09-10T11:14:12.339Z",
+  "updatedAt": "2024-09-10T11:14:12.339Z",
+  "orgId": "eb166faa-7145-46ef-8044-589b47ae3b56",
+  "cost": 0,
+  "status": "queued",
+  "transport": {
+    "provider": "vapi.websocket",
+    "websocketCallUrl": "wss://api.vapi.ai/7420f27a-30fd-4f49-a995-5549ae7cc00d/transport"
+  }
+}
+```
+
+## Audio Format Configuration
+
+When creating a WebSocket call, the audio format can be customized:
+
+| Parameter   | Description             | Default             |
+|-------------|-------------------------|---------------------|
+| `format`    | Audio encoding format   | `pcm_s16le` (16-bit PCM) |
+| `container` | Audio container format  | `raw` (Raw PCM)         |
+| `sampleRate`| Sample rate in Hz       | `16000` (16kHz)         |
+
+Currently, Vapi supports only raw PCM (`pcm_s16le` with `raw` container). Additional formats may be supported in future updates.
+
+<Note>
+Vapi automatically converts sample rates as needed. You can stream audio at 8kHz, 44.1kHz, etc., and Vapi will handle conversions seamlessly.
+</Note>
+
+## Connecting to the WebSocket
+
+Use the WebSocket URL from the response to establish a connection:
+
+```javascript
+const socket = new WebSocket("wss://api.vapi.ai/7420f27a-30fd-4f49-a995-5549ae7cc00d/transport");
+
+socket.onopen = () => console.log("WebSocket connection opened.");
+socket.onclose = () => console.log("WebSocket connection closed.");
+socket.onerror = (error) => console.error("WebSocket error:", error);
+```
+
+## Sending and Receiving Data
+
+The WebSocket supports two types of messages:
+
+- **Binary audio data** (PCM, 16-bit signed little-endian)
+- **Text-based JSON control messages**
+
+### Sending Audio Data
+
+```javascript
+function sendAudioChunk(audioBuffer) {
+  if (socket.readyState === WebSocket.OPEN) {
+    socket.send(audioBuffer);
+  }
+}
+
+navigator.mediaDevices.getUserMedia({ audio: true }).then(stream => {
+  const audioContext = new AudioContext();
+  const source = audioContext.createMediaStreamSource(stream);
+  const processor = audioContext.createScriptProcessor(1024, 1, 1);
+
+  processor.onaudioprocess = (event) => {
+    const pcmData = event.inputBuffer.getChannelData(0);
+    const int16Data = new Int16Array(pcmData.length);
+
+    for (let i = 0; i < pcmData.length; i++) {
+      int16Data[i] = Math.max(-32768, Math.min(32767, pcmData[i] * 32768));
+    }
+
+    sendAudioChunk(int16Data.buffer);
+  };
+
+  source.connect(processor);
+  processor.connect(audioContext.destination);
+});
+```
+
+### Receiving Data
+
+```javascript
+socket.onmessage = (event) => {
+  if (event.data instanceof Blob) {
+    event.data.arrayBuffer().then(buffer => {
+      const audioData = new Int16Array(buffer);
+      playAudio(audioData);
+    });
+  } else {
+    try {
+      const message = JSON.parse(event.data);
+      handleControlMessage(message);
+    } catch (error) {
+      console.error("Failed to parse message:", error);
+    }
+  }
+};
+```
+
+### Sending Control Messages
+
+```javascript
+function sendControlMessage(messageObj) {
+  if (socket.readyState === WebSocket.OPEN) {
+    socket.send(JSON.stringify(messageObj));
+  }
+}
+
+// Example: hangup call
+function hangupCall() {
+  sendControlMessage({ type: "hangup" });
+}
+```
+
+## Ending the Call
+
+To gracefully end the WebSocket call:
+
+```javascript
+sendControlMessage({ type: "hangup" });
+socket.close();
+```
+
+## Comparison: WebSocket Transport vs. Call Listen Feature
+
+Vapi provides two WebSocket options:
+
+| WebSocket Transport                 | Call Listen Feature                |
+|-------------------------------------|------------------------------------|
+| Primary communication method        | Secondary, monitoring-only channel |
+| Bidirectional audio streaming       | Unidirectional (listen-only)       |
+| Replaces phone/web as transport     | Supplements existing calls         |
+| Uses `provider: "vapi.websocket"`   | Accessed via `monitor.listenUrl`   |
+
+Refer to [Live Call Control](/calls/call-features) for more on the Call Listen feature.
+
+<Warning>
+When using WebSocket transport, phone-based parameters (`phoneNumber` or `phoneNumberId`) are not permitted. These methods are mutually exclusive.
+</Warning>
+

fern/calls/websocket-transport.mdx

@@ -3,7 +3,7 @@
 1. **Integration with Google Calendar**: You can now create and manage Google Calendar events directly within your tools. Configure OAuth2 credentials through the [dashboard > Build > Provider Keys](https://dashboard.vapi.ai/keys#:~:text=Google%20Calendar) to authenticate and interact with Google Calendar APIs.
 
 <Frame caption="Google Calendar Integration">
-    <img src="../static/images/changelog/google-calendar-integration.png" alt="Google Calendar Integration" />
+    <img src="../static/images/changelog/google-calendar-tool.png" alt="Google Calendar Integration" />
 </Frame>
 
 2. **Enhanced Voice Customization for RimeAIVoice**: Gain more control over [Rime AI voice](https://api.vapi.ai/api#:~:text=RimeAIVoice) properties with new options like `reduceLatency`, `inlineSpeedAlpha`, `pauseBetweenBrackets`, and `phonemizeBetweenBrackets`. These settings let you optimize voice streaming and adjust speech delivery to better suit your assistant's needs.

fern/changelog/2025-03-20.mdx

@@ -0,0 +1,15 @@
+1. **New Slack and Google Calendar Tools Added**: You can now use the built-in  [Slack tool](https://docs.vapi.ai/tools/slack) to send messages and use the [Google Calendar tool](https://docs.vapi.ai/tools/google-calendar) to check calendar availability directly from your assistant, with full CRUD operations available via the [`/tool` API endpoint](https://docs.vapi.ai/api-reference/tools/list). You can authenticate the [Slack tool](https://dashboard.vapi.ai/keys#:~:text=Slack) and the [Google Calendar tool](https://dashboard.vapi.ai/keys#:~:text=Google%20Calendar) using OAuth2 from the [Vapi provider keys page](https://dashboard.vapi.ai/keys).
+
+<Frame caption="Slack Tool">
+    <img src="../static/images/changelog/slack-tool.png" alt="Slack Tool" />
+</Frame>
+
+<Frame caption="Google Calendar Tool">
+    <img src="../static/images/changelog/google-calendar-tool.png" alt="Google Calendar Tool" />
+</Frame>
+
+2. **Select LLM Model in Workflow Nodes**: You can now select and update which LLM model you want to use within workflow nodes, allowing more precise control over the assistant's behavior in different workflow nodes and easier configuration updates.
+
+4. **Enhanced Call Monitoring and Reporting**: We've improved call monitoring with conversation turn tracking, millisecond-precision timestamps, and provided more detailed call end reasons. These enhancements make it easier to track conversation flow, perform precise time calculations, and diagnose specific call termination issues like server overloads or database errors.
+
+5. **Enable Background Denoising**: You can now filter out background noise during calls by setting `Assistant.backgroundDenoisingEnabled` to `true`.

fern/changelog/2025-03-28.mdx

@@ -0,0 +1,5 @@
+1. **TestSuiteRunTestAttempt now accepts `callId` and `metadata`**: You can now include a `callId` and `metadata` when creating a test suite run attempt, allowing you to reference calls by ID and attach session-related information.
+
+2. **`call` property in [TestSuiteRunTestAttempt](https://api.vapi.ai/api#:~:text=TestSuiteRunTestAttemptMetadata) is no longer required**: It's now optional to include the full `call` object in a test attempt, providing flexibility for cases where call details are unnecessary or already known.
+
+3. **Attach Metadata to Test Suite Run Attempts**: You can now attach [metadata](https://api.vapi.ai/api#:~:text=TestSuiteRunTestAttemptMetadata) like `sessionId` to test attempts for better tracking and analysis. 

fern/changelog/2025-03-30.mdx

@@ -0,0 +1,5 @@
+1. **Introducing `SmsSendTool` for SMS messaging support**: You can now create and manage tools of type `sms` using the new [SMS Send Tool](https://api.vapi.ai/api#:~:text=SmsSendTool), allowing you to send SMS messages via defined servers. The `sms` tool type is also now recognized in API endpoints, ensuring that SMS send tools are correctly processed during CRUD operations.
+
+2. **New configuration options for voice and transcriber settings**: The `autoMode` property has been added to [Eleven Labs Voice Settings](https://api.vapi.ai/api#:~:text=ElevenLabsVoice), letting developers control automatic voice settings. Additionally, `confidenceThreshold` has been introduced in transcriber settings, allowing developers to set thresholds to discard low-confidence transcriptions and improve accuracy.
+
+3. **Enhanced speed control in `CartesiaExperimentalControls`**: The `speed` property now accepts both predefined speeds (`'slowest'`, `'slow'`, `'normal'`, `'fast'`, `'fastest'`) and numeric values between -1 and 1. This gives you more precise control over speed settings for better customization.

fern/changelog/2025-04-03.mdx

@@ -0,0 +1 @@
+1. **Addition of `assistantId` to `TargetPlan` settings**: You can now specify an `assistantId` when testing [target plans](https://api.vapi.ai/api#:~:text=TargetPlan), allowing you to test scenarios involving specific assistants directly.

fern/changelog/2025-04-04.mdx

@@ -0,0 +1,9 @@
+1. **Introducing `SmsSendTool` for SMS messaging support**: You can now create and send `sms` text messages  using the new `[Send Text`](https://api.vapi.ai/api#:~:text=SmsSendTool) tool, enabling assistants to send SMS messages via defined servers. 
+
+<Frame caption="Send SMS with 'Send Text' tool">
+    <img src="../static/images/changelog/send-text-tool.png" alt="SmsSendTool" />
+</Frame>
+
+2. **[Eleven Labs Voice](https://api.vapi.ai/api#:~:text=ElevenLabsVoice) Auto Mode and Confidence Threshold configuration options**: When using [`Eleven Labs Voice`](https://api.vapi.ai/api#:~:text=ElevenLabsVoice) in your Assistant, you can now configure `autoMode` (default: false) to automatically manage manage chunking strategies for long texts; Eleven Labs automatically determines the best way to process and generate audio, optimizing for latency and efficiency. Additionally, `confidenceThreshold` has been introduced in transcriber schemas, allowing developers to set thresholds to discard low-confidence transcriptions and improve accuracy.
+
+3. **Changes to `CartesiaExperimentalControls` Speed property**: The `speed` property now accepts both predefined speeds (`'slowest'`, `'slow'`, `'normal'`, `'fast'`, `'fastest'`) and numeric values between -1 and 1. This simplifies the process of controlling the speed of the generated audio with Cartesia.

fern/changelog/2025-04-05.mdx

@@ -0,0 +1,7 @@
+1. **Simplified `transport` property in `Call` configuration**: You should now configure the `transport` property in [`Call`](https://api.vapi.ai/api#:~:text=Call) as an object when creating or updating a [`Call`](https://api.vapi.ai/api#:~:text=Call), since the separate `Transport` schema has been deprecated. This simplification makes it easier to work with transport details without referencing a separate transport configuration.
+
+<Warning>
+    The `Transport` schema is now deprecated and will be removed in a future release.
+</Warning>
+
+2. **New call type `vapi.websocketCall`**: You can now make [phone calls over WebSockets](https://docs.vapi.ai/calls/websocket-transport) with Vapi. The `Call` schema now supports a new `type` value: `vapi.websocketCall`.

fern/changelog/2025-04-08.mdx

@@ -0,0 +1,9 @@
+1. **Updated AI Edge Condition with Prompt**: When defining an AI edge condition, the `matches` property has been renamed to `prompt`. The `prompt` allows you to provide a natural language condition (up to 1000 characters) that guides AI decision-making in workflows.
+
+<Frame caption="Updated AI Edge Condition with Prompt">
+    <img src="../static/images/changelog/ai-edge-condition-prompt.png" alt="AI Edge Condition with Prompt" />
+</Frame>
+
+2. **Assistant Overrides per Customer**: You can now customize assistant settings for individual customers using `assistantOverrides` when [creating customers](https://api.vapi.ai/api#:~:text=CreateCustomerDTO). This enables personalized assistant interactions for each customer in batch calls.
+
+3. **New Call Ended Reasons**: New error codes have been added to `endedReason` enums, providing more detailed insights into call terminations related to providers like Anthropic Bedrock and Vertex. This helps in better error handling and debugging of call issues.

fern/changelog/2025-04-11.mdx

@@ -0,0 +1,2 @@
+
+1. **Expanded Voice Selection for Assistant Voices**: You can now specify any valid `voiceId` for assistant voices without being limited to a predefined list. This provides greater flexibility to use different voices in `Assistant.voice`, and related configurations.

fern/changelog/2025-04-12.mdx

@@ -0,0 +1,5 @@
+1.  **New GPT-4.1 Models Available**: You can now use `'gpt-4.1'`, `'gpt-4.1-mini'`, and `'gpt-4.1-nano'` as options for the `model` and `fallbackModels` with your [OpenAI models](https://api.vapi.ai/api#:~:text=OpenAIModel). These models may offer improved performance or features over previous versions.
+
+<Frame caption="New GPT-4.1 Models Available">
+    <img src="../static/images/changelog/gpt-4.1-models.png" alt="New GPT-4.1 Models Available" />
+</Frame>

fern/changelog/2025-04-15.mdx

@@ -364,6 +364,8 @@ navigation:
                 path: calls/call-handling-with-vapi-and-twilio.mdx
               - page: Voicemail Detection
                 path: calls/voicemail-detection.mdx
+              - page: WebSocket Transport
+                path: calls/websocket-transport.mdx
 
           - section: SDKs
             path: sdks.mdx
@@ -457,19 +459,21 @@ navigation:
                 path: enterprise/plans.mdx
               - page: On-Prem Deployments
                 path: enterprise/onprem.mdx
-              - page: HIPAA Compliance
-                path: security-and-privacy/hipaa.mdx
-              - page: PCI Compliance
-                path: security-and-privacy/PCI.mdx
-              - link: SOC-2 Compliance
-                href: https://security.vapi.ai/
-
           - page: Glossary
             path: glossary.mdx
-
           - page: RSS Feed
             path: rss-feed.mdx
-
+      - section: Security and Privacy
+        collapsed: true
+        contents:
+          - page: GDPR Compliance
+            path: security-and-privacy/GDPR.mdx
+          - page: HIPAA Compliance
+            path: security-and-privacy/hipaa.mdx
+          - page: PCI Compliance
+            path: security-and-privacy/PCI.mdx
+          - link: SOC-2 Compliance
+            href: https://security.vapi.ai/
       - section: Legal
         collapsed: true
         contents: