+
+
+3. **Assign Phone Number**
+ - Go to the Numbers tab
+ - Assign your acquired phone number to the SIP trunk
+
+4. **Configure SIP Invite**
+ - Go to Numbers, edit the number you'll be using
+ - Navigate to Voice settings
+ - Scroll down to find "Translated Number"
+ - Set this value to match your Vapi SIP URI
+
+ *This setting modifies the SIP Invite to the Vapi platform so invites are correctly routed to your Vapi SIP URI.*
+
+## 3. Configure Telnyx for Outbound Calls
+
+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"
+ - Create a new credential for Vapi to use
+
+ 
+
+
+2. **Create Outbound Voice Profile**
+ - Go to Voice / Outbound Voice Profiles
+ - Create a new profile
+ - Name it appropriately
+ - Configure desired destinations
+ - Leave default configuration settings
+ - Assign your SIP trunk
+ - Complete setup
+
+ Alternatively, go to your SIP trunk / Outbound tab and select your newly created outbound voice profile.
+
+3. **Configure Outbound Settings**
+ - Choose the country you'll be making most calls to
+
+ *We recommend creating a separate SIP Trunk for each country you aim to be making most calls to.*
+
+ 
+
+
+## 4. Add Your Telnyx SIP Credentials to Vapi.ai
+
+Use the Vapi API to create a SIP trunk credential:
+
+```bash
+curl -X POST https://api.vapi.ai/credential \
+ -H "Content-Type: application/json" \
+ -H "Authorization: Bearer YOUR_VAPI_PRIVATE_KEY" \
+ -d '{
+ "provider": "byo-sip-trunk",
+ "name": "Telnyx Trunk",
+ "gateways": [
+ {
+ "ip": "sip.telnyx.com"
+ }
+ ],
+ "outboundAuthenticationPlan": {
+ "authUsername": "YOUR_SIP_USERNAME",
+ "authPassword": "YOUR_SIP_PASSWORD",
+ "sipRegisterPlan": {
+ "realm": "sip.telnyx.com"
+ }
+ }
+ }'
+```
+
+Replace `YOUR_VAPI_PRIVATE_KEY`, `YOUR_SIP_USERNAME`, and `YOUR_SIP_PASSWORD` with your actual credentials.
+
+If successful, the response will include an `id` for the created credential, which you'll use in the next step.
+
+## 5. Add Your Phone Number to Vapi.ai
+
+Associate your phone number with the SIP trunk in Vapi.ai:
+
+```bash
+curl -X POST https://api.vapi.ai/phone-number \
+ -H "Content-Type: application/json" \
+ -H "Authorization: Bearer YOUR_VAPI_PRIVATE_KEY" \
+ -d '{
+ "provider": "byo-phone-number",
+ "name": "Telnyx SIP Number",
+ "number": "YOUR_PHONE_NUMBER",
+ "numberE164CheckEnabled": false,
+ "credentialId": "YOUR_CREDENTIAL_ID"
+ }'
+```
+
+Replace `YOUR_VAPI_PRIVATE_KEY`, `YOUR_PHONE_NUMBER`, and `YOUR_CREDENTIAL_ID` with your actual details.
+
+## 6. Assign Your Voice Assistant to Handle Calls
+
+- In your Vapi.ai dashboard, go to the **Build** section and select **Phone Numbers**
+- Click on your **Telnyx Number**
+- In the **Inbound Settings** section, assign your voice assistant to handle incoming calls
+- In the **Outbound Form** section, assign your voice assistant to handle outgoing calls
+
+## 7. Make Outbound Calls
+
+To initiate outbound calls through your Telnyx SIP trunk:
+
+```bash
+curl --location 'https://api.vapi.ai/call/phone' \
+ --header 'Authorization: Bearer YOUR_VAPI_PRIVATE_KEY' \
+ --header 'Content-Type: application/json' \
+ --data '{
+ "assistantId": "YOUR_ASSISTANT_ID",
+ "customer": {
+ "number": "CUSTOMER_PHONE_NUMBER",
+ "numberE164CheckEnabled": false
+ },
+ "phoneNumberId": "YOUR_PHONE_ID"
+ }'
+```
+
+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.
+
+
+ This is the content for the doc fern/advanced/sip/sip-trunk.mdx
+
+ ---
+title: SIP Trunking Guide for Vapi
+subtitle: How to integrate your SIP provider with Vapi
+slug: advanced/sip/sip-trunk
+---
+
+SIP trunking replaces traditional phone lines with a virtual connection over the internet, allowing your business to make and receive calls via a broadband connection. It connects your internal PBX or VoIP system to a SIP provider, which then routes calls to the Public Switched Telephone Network (PSTN). This setup simplifies your communications infrastructure and often reduces costs.
+
+## 1. Vapi SIP Trunking Options
+
+Vapi supports multiple SIP trunk configurations, including:
+
+- **Telnyx**: Uses SIP gateway domain (e.g., sip.telnyx.com) with IP-based authentication.
+- **Zadarma**: Uses SIP credentials (username/password) with its SIP server (e.g., sip.zadarma.com).
+- **Custom "BYO" SIP Trunk**: Allows integration with any SIP provider. You simply provide the SIP gateway address and the necessary authentication details.
+
+
+
+
+
+
+2. **New Anthropic Model `claude-3-5-sonnet-20241022`**: You can now include Computer Use tools in the `toolWithToolCallList` of `ClientMessageToolCalls` or `ServerMessageToolCalls`. Select `'anthropic'` as your provider, `claude-3-5-sonnet-20241022`, and [create](https://api.vapi.ai/api#/Tools/ToolController_create) or [update](https://api.vapi.ai/api#/Tools/ToolController_update) newly supported computer use tools like `BashTool`, `ComputerTool`, or `TextEditorTool`.
+
+
+ 
+
+
+3. **Enhanced Email Regex Support in Replacements**: The email matching regex pattern in `RegexReplacement` now supports top-level domains with two or more characters (`{2,}`). This improvement allows you to replace email addresses with placeholders like `[EMAIL]`, even for longer TLDs.
+
+4. **Paginated Phone Number Responses**: [`GET /phone-numbers`](https://api.vapi.ai/api#/Phone%20Numbers/PhoneNumberController_findAll) now includes a `results` array of phone numbers and pagination metadata for easier handling of large datasets.
+
+ This is the content for the doc fern/changelog/2024-10-30.mdx
+
+ 1. **Auto-reload Credits in Billing Page**: You can now auto-reload credits and check credits remaining for subscriptions within the [updated billing page](https://dashboard.vapi.ai/org/billing).
+
+
+ 
+
+
+2. **Expanded Language Options in `CartesiaVoice`**: You can now specify additional languages in `CartesiaVoice.language` (optional), including 'hi' (Hindi), 'it' (Italian), 'ko' (Korean), 'nl' (Dutch), 'pl' (Polish), 'ru' (Russian), 'sv' (Swedish), and 'tr' (Turkish). Refer to the [CartesiaVoice](https://api.vapi.ai/api) schema for more details.
+
+
+ 
+
+
+3. **Enhanced Template Variables in `AssistantOverrides`**: The `AssistantOverrides.variableValues` now supports LiquidJS syntax for replacing template variables. You can customize assistant messages using expressions like `{{ name }}` for dynamic content, or format dates with `{{"now" | date: "%b %d, %Y, %I:%M %p", "America/New_York"}}`.
+
+ This is the content for the doc fern/changelog/2024-11-03.mdx
+
+ 1. **Access Transport Details and Costs**: You can now use `call.transport` to access details about the provider used for a call (`twilio`, `vonage`, `vapi`, or `daily`), and whether the assistant's video is enabled for web calls (`assistantVideoEnabled`). Additionally, transport costs in `call.costs[type=transport]` now include a `provider` field, allowing you to see which provider contributed to the transport cost.
+
+2. **Manage Tavus Credentials**: You can now create and update Tavus credentials in the [updated Provider Credentials page](https://dashboard.vapi.ai/keys).
+
+
+ 
+
+
+ This is the content for the doc fern/changelog/2024-11-04.mdx
+
+ 1. **XAi Model Support**: You can now use xAI's `grok-beta` model when creating or updating an assistant, and specify your API credentials from the [xAI console](https://console.x.ai/) in the [updated Provider Credentials page](https://dashboard.vapi.ai/keys). The list of call ended reasons has been updated to include xAI-specific errors.
+
+
+ 
+
+
+ This is the content for the doc fern/changelog/2024-11-06.mdx
+
+ 1. **New Anthropic model `claude-3-5-haiku-20241022` added**: You can now use `claude-3-5-haiku-20241022` in your assistants. Specify `anthropic` in `Assistant.model.provider` and `claude-3-5-haiku-20241022` in `Assistant.model`.
+
+2. **Payment `cost`, Subscription `credits` and `couponUsageLeft` are now strings**: These properties are now strings to avoid floating point precision errors. Please update your applications to handle these values as strings.
+
+3. **Advanced call logging improvements**: You can now access detailed call logs through the [updated call logs page](https://dashboard.vapi.ai/calls) or [`GET /logs?type=Call`](https://api.vapi.ai/api#/Logs/LoggingController_queryLogs) endpoint. Refer to `CallLogPrivileged` or `CallLogsPaginatedResponse` schemas in the [updated API reference](https://api.vapi.ai/api) to learn more.
+
+ This is the content for the doc fern/changelog/2024-11-11.mdx
+
+ 1. **Subscription Updates**: You can now check the number of minutes used in a subscription with `Subscription.minutesUsed` (Enterprise only).
+
+2. **Updates to Concurrency Limits in your Subscription**: `Subscription.concurrencyLimit` now shows both the included and purchased limits, which better represents the total concurrency limit. Refer to the [Subscription schema](https://api.vapi.ai/api/) for more details.
+ - Use `Subscription.concurrencyLimitIncluded` to get the default concurrency limit provided with the subscription.
+ - Use `Subscription.concurrencyLimitPurchased` to get any additional purchased concurrency limit.
+
+
+ 
+
+
+ This is the content for the doc fern/changelog/2024-11-14.mdx
+
+ 1. **Langfuse Credential Management**: You can now send traces to Langfuse by providing your "Secret Key", "Public Key", and "Host URL" for better telemetry monitoring. Create and update these credentials in the [updated Provider Credentials page](https://dashboard.vapi.ai/keys), under `Observability Providers`.
+
+
+ 
+
+
+ This is the content for the doc fern/changelog/2024-11-15.mdx
+
+ 1. **New Voices for `gpt-4o-realtime-preview-2024-10-01`**: You can now use new voice IDs: `ash`, `ballad`, `coral`, `sage`, and `verse` with the `voiceId` parameter when configuring `OpenAIVoice`. Please note that these voices are only available with the `gpt-4o-realtime-preview-2024-10-01` model.
+
+ This is the content for the doc fern/changelog/2024-11-21.mdx
+
+ 1. **Voice Fallback Plan**: You can now define a `fallbackPlan` in your assistant's voice settings in `assistant.voice.fallbackPlan` or `call.squad.members.assistant.voice.fallbackPlan` to specify alternative voices if your primary voice provider fails.
+
+2. **AssemblyAI Credential Management**: You can now specify your AssemblyAI API keys in the updated "Transcriber Providers" page. Create your API key in the [AssemblyAI dashboard](https://www.assemblyai.com/app/account). AssemblyAI errors are now surfaced in the `endedReason` of `Call`, `ServerMessageEndOfCallReport`, and `ServerMessageStatusUpdate`.
+
+
+ 
+
+
+3. **Enhanced BYO SIP Trunk Configuration**: When configuring BYO SIP trunk credentials, you can now specify a `techPrefix` for outbound SIP calls and enable `sipDiversionHeader` for authenticating the calling number (if supported). Refer to the `ByoSipTrunkCredential` schema in the [API reference](https://api.vapi.ai/api) to learn more.
+
+
+ 
+
+
+4. **File Name Length Constraints**: The maximum file `name` length has been reduced from 100 to 40 characters. The required minimum length is still 1 character.
+
+5. **Increased Server Timeout Limit**: The maximum value of `server.timeoutSeconds` has increased from 60 to 120 seconds, allowing longer timeouts for server responses.
+
+7. **Extended Delay for Tool Messages**: The `timingMilliseconds` maximum in `ToolMessageDelayed` has increased from 20,000 to 120,000 milliseconds, enabling a longer delay for tool messages.
+
+
+ This is the content for the doc fern/changelog/2024-11-22.mdx
+
+ 1. **Support for 'uaenorth' Region in Azure OpenAI Credentials**: When configuring Azure OpenAI credentials, you can now set `region` to use the UAE North region by specifying `'uaenorth'`.
+
+ This is the content for the doc fern/changelog/2024-11-24.mdx
+
+ 1. **Voice Fallback Plan Introduced**: You can now enhance your assistant's reliability by defining fallback voice providers using `assistant.voice.fallbackPlan.voices`. This allows your assistant to switch to alternative voices or providers like `FallbackLMNTVoice`, `FallbackAzureVoice`, `FallbackNeetsVoice`, `FallbackTavusVoice`, `FallbackOpenAIVoice`, and others if the primary voice provider fails.
+
+
+ 
+
+
+2. **Language Selection for PlayHTVoice**: The `language` property has been added to `PlayHTVoice`. You can now specify the desired language for speech synthesis using `assistant.voice.language`.
+
+3. **AssemblyAI Transcriber Available**: You can now use AssemblyAI for transcribing by setting `Assistant.transcriber` to `AssemblyAITranscriber`. This provides a new option for converting speech to text in your assistant.
+
+4. **Updated OpenAI Model Support**: The `gpt-4o-2024-11-20` model has been added to `OpenAIModel.model` and `OpenAIModel.fallbackModels`. You can now configure your assistant to use this latest OpenAI model.
+
+5. **Removal of 'fillerInjectionEnabled' Property**: The `fillerInjectionEnabled` property has been removed from voice configurations like `LMNTVoice`, `AzureVoice`, etc. You no longer need to include this property when configuring these voices.
+
+
+ This is the content for the doc fern/changelog/2024-11-25.mdx
+
+ 1. **No length limit for assistant's first message**: You can now set `assistant.firstMessage` or `call.assistant.firstMessage` to any length; the previous maximum length restriction has been removed. This allows you to provide longer initial messages for the assistant's greeting.
+
+
+ 
+
+
+
+
+ This is the content for the doc fern/changelog/2024-11-27.mdx
+
+ 1. **New Knowledge Base API Endpoints**: You can now create a knowledge base with [`POST /knowledge-base`](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_create), list knowledge bases with [`GET /knowledge-base`](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_findAll) or [`GET /knowledge-base/{id}`](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_findOne) for a specific knowledge base, update a knowledge base with [`PATCH /knowledge-base/{id}`](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_update), or delete a knowledge base with [`DELETE /knowledge-base/{id}`](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_remove). Refer to the [Vapi API endpoints](https://api.vapi.ai/api#/) for more details.
+
+
+ 
+
+
+
+2. **Configure Custom Knowledge Bases for your Assistant**: Configure a custom knowledge base for your assistant in three steps by first uploading a file [through the dashboard](https://dashboard.vapi.ai/files) or [the API](https://api.vapi.ai/api#/Files/FileController_create), then [create a knowledge base](https://docs.vapi.ai/knowledgebase#step-2-create-a-knowledge-base), and lastly [updating your assistant](https://docs.vapi.ai/knowledgebase#step-3-create-an-assistant) with the knowledge base id. You can also assign a knowledge base to models like `GroqModel`, `VapiModel`, `GoogleModel`, and others using the new `knowledgeBaseId` property.
+
+
+3. **Integration with Trieve Knowledge Base**: Vapi now supports [Trieve](https://trieve.ai/) as our first knowledge base provider. Refer to [our docs](https://docs.vapi.ai/knowledgebase#step-2-create-a-knowledge-base) for an example of how to use Trieve.
+
+
+4. **Inflection AI Credential Management**: You can now manage Inflection AI credentials through the [updated providers credentials](https://dashboard.vapi.ai/keys) page. `Call.endedReason` also now enumerates new values like `'pipeline-error-inflection-ai-llm-failed'` to indicate specific Inflection AI errors.
+
+
+ 
+
+
+
+5. **New Transfer Mode with Summary in SIP Header**: You can now configure `TransferPlan.mode` to `'blind-transfer-add-summary-to-sip-header'` to forward calls and include a summary in the SIP header called `X-Transfer-Summary`. You can also add custom SIP headers during a transfer call using the `sipHeaders` property in `TransferDestinationSip`.
+
+
+6. **Azure Credential Service Default**: When creating or updating Azure credentials in the [updated providers credentials](https://dashboard.vapi.ai/keys), the `service` field now defaults to `'speech'`.
+
+
+7. **Support for Cantonese in Deepgram Transcriber**: The `DeepgramTranscriber.language` option now includes `'zh-HK'` for Cantonese (Hong Kong).
+
+ This is the content for the doc fern/changelog/2024-11-30.mdx
+
+ 1. **Extended Silence Timeout for Assistants**: You can now set `silenceTimeoutSeconds` up to 3600 seconds (previously 600 seconds) when creating or updating assistants and assistant overrides. This allows for longer periods of silence before an assistant session times out.
+
+2. **New Credits Purchase Option**: You can now purchase credits to your subscription by navigating to the [updated billing page](https://dashboard.vapi.ai/org/billing/credits). Specify the dollar amount of your credits in the `credits` field to complete the purchase.
+
+
+ 
+
+
+ This is the content for the doc fern/changelog/2024-12-03.mdx
+
+ 1. **New xAI and Inflection AI models**: You can now set `Assistant.model` to use `XAI` (e.g., model `grok-beta`) or `Inflection AI` (e.g., model `inflection_3_pi`) by specifying these providers in your assistant configuration. Specify these providers in `assistant.model`, `call.squad.members.assistant.model`, or `call.squad.members.assistantOverrides.model`.
+
+2. **Integrate Existing Trieve Vector Stores in Your Knowledge Base**: When you create a knowledge base with [`POST /knowledge-base`](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_create), you can now specify `vectorStoreProviderId` to use an existing vector store from your Trieve account.
+
+3. **Create Vector Stores with Uploaded Files**: You can first upload files using the [`POST /files`](https://api.vapi.ai/api#/Files/FileController_create) endpoint, and then use the `fileIds` to specify the IDs of previously uploaded files to create a new Trieve vector store. You can customize how your files are ingested, chunked, then rebalanced to ensure correct knowledge is served by your assistant:
+
+- *Split delimiters*: Specify `splitDelimiters` to control how files are split before chunking (default is `[.!?\n]`).
+- *Splits per chunk*: Set `targetSplitsPerChunk` to specify the desired number of splits per chunk when creating a vector store (default is 20 splits per chunk).
+- *Chunk rebalancing*: Set `rebalanceChunks` to `true` to evenly distribute remainder splits across chunks when creating a vector store to ensure balanced chunk sizes; for example, 66 splits with `targetSplitsPerChunk` of 20 will result in 3 chunks with 22 splits each.
+
+4. **Customize Search Heuristics**: You can filter or remove search results from your knowledge base:
+
+- *Filter by Score threshold*: Set `scoreThreshold` to filter out chunks during searches based on their score. For cosine similarity, chunks below the threshold are filtered out; for other distance metrics, chunks above the threshold are filtered.
+- *Remove stop words*: Set `removeStopWords` to `true` to remove stop words during searches. The stop words list is specified in `server/src/stop-words.txt`, and queries that are entirely stop words will still be preserved.
+
+5. **Updated Analytics Endpoint**: The `/analytics` endpoint has changed—use `GET /analytics` to retrieve analytics data instead of `POST /analytics`.
+
+
+ This is the content for the doc fern/changelog/2024-12-05.mdx
+
+ 1. **OAuth2 Support for Custom LLM Credentials and Webhooks**: You can now authorize access to your [custom LLMs](https://docs.vapi.ai/customization/custom-llm/using-your-server#step-2-configuring-vapi-with-custom-llm) and [server urls (aka webhooks)](https://docs.vapi.ai/server-url) using OAuth2 (RFC 6749).
+
+For example, create a webhook credential with `CreateWebhookCredentialDTO` with the following payload:
+
+```json
+{
+ "provider": "webhook",
+ "authenticationPlan": {
+ "type": "oauth2",
+ "url": "https://your-url.com/your/path/token",
+ "clientId": "your-client-id",
+ "clientSecret": "your-client-secret"
+ },
+ "name": "your-credential-name-between-1-and-40-characters"
+}
+```
+
+This returns a [`WebhookCredential`](https://api.vapi.ai/api) object as follows:
+
+
+ 
+
+
+3. **Removal of Canonical Knowledge Base**: The ability to create, update, and use canoncial knowledge bases in your assistant has been removed from the API(as custom knowledge bases and the Trieve integration supports as superset of this functionality). Please update your implementations as endpoints and models referencing canoncial knowledge base schemas are no longer available.
+
+ This is the content for the doc fern/changelog/2024-12-06.mdx
+
+ 1. **OAuth 2 Authentication for Custom LLM Models and Webhooks**: In addition to (AuthZ)[https://www.okta.com/identity-101/authentication-vs-authorization/], you can now now authenticate users accessing your [custom LLMs](https://docs.vapi.ai/customization/custom-llm/using-your-server#step-2-configuring-vapi-with-custom-llm) and [server urls (aka webhooks)](https://docs.vapi.ai/server-url) using OAuth2 (RFC 6749). Use the `authenticationSession` dictionary which contains an `accessToken` and `expiresAt` datetime to authenticate further requests to your custom LLM or server URL.
+
+For example, create a webhook credential with `CreateCustomLLMCredentialDTO` with the following payload:
+```json
+{
+ "provider": "custom-llm",
+ "apiKey": "your-api-key-max-10000-characters",
+ "authenticationPlan": {
+ "type": "oauth2",
+ "url": "https://your-url.com/your/path/token",
+ "clientId": "your-client-id",
+ "clientSecret": "your-client-secret"
+ },
+ "name": "your-credential-name-between-1-and-40-characters"
+}
+```
+
+This returns a [`CustomLLMCredential`](https://api.vapi.ai/api) object as follows:
+
+
+ 
+
+
+This can be used to authenticate successive requests to your custom LLM or server URL.
+
+
+ This is the content for the doc fern/changelog/2024-12-09.mdx
+
+ 1. **Improved Tavus Video Processing Error Messages**: Your call `endedReason` now includes detailed error messages for `pipeline-error-tavus-video-failed`. Use this to detect and manage scenarios where the Tavus video processing pipeline fails during a call.
+
+ This is the content for the doc fern/changelog/2024-12-10.mdx
+
+ 1. **Claude Computer Use Tools Available**: You can now use [Claude computer use tools](https://www.anthropic.com/news/3-5-models-and-computer-use) like `BashTool`, `ComputerTool`, and `TextEditorTool` when building your Vapi assistant. Create these tools with `CreateBashToolDTO` (enables shell command execution), `CreateComputerToolDTO` (use desktop functionality with customizable display dimensions using `displayWidthPx`, `displayHeightPx`), and `CreateTextEditorToolDTO` (text editing operations), respectively.
+
+Refer to our [API docs](https://api.vapi.ai/api) to learn more about how to use Claude computer use tools.
+
+ This is the content for the doc fern/changelog/2024-12-11.mdx
+
+ 1. **Use OpenAI Chat Completions in your Assistant**: you can now more easily integrate your Assistant with OpenAI's [chat completions sessions](https://platform.openai.com/docs/api-reference/chat) by specifying `messages` (an array of `OpenAIMessage` objects) and an `assistantId` (a string). Each `OpenAIMessage` in turn consists of a `content` (a string between 1 and 100,000,000 characters) and a role (between *assistant*, *function*, *user*, *system*, *tool*). This makes it easier to manage chat sessions associated with a specific assistant. Refer to the `ChatDTO`, `OpenAIMessage` schemas in [our API docs](https://api.vapi.ai/api) to learn more.
+
+2. **Update Subscription Email on Billing Page**: you can now customize which email address appears on your Vapi invoices through the updated billing page > [under payment history](https://dashboard.vapi.ai/org/billing). You can specify an email address (in addition through physical address and tax id) - read more in [our docs](https://docs.vapi.ai/quickstart/billing#how-do-i-download-invoices-for-my-credit-purchases).
+
+ This is the content for the doc fern/changelog/2024-12-13.mdx
+
+ 1. **Azure Speech Transcriber Support**: You can now use Azure's speech-to-text service by specifying `AzureSpeechTranscriber` as an option for `transcriber`. This allows you to leverage Azure's speech to text capabilities when creating or updating your assistant.
+
+Refer to our [api docs](lhttps://api.vapi.ai/api) to learn more.
+
+ This is the content for the doc fern/changelog/2024-12-14.mdx
+
+ 1. **Removal of `'gemma-7b-it'` from `GroqModel` Options:** The `'gemma-7b-it'` model is no longer available when selecting Groq as a model provider. Update your applications to use other valid options provided by the API.
+
+Refer to the [`GroqModel` schema](https://api.vapi.ai/api) or the [vapi dashboard](https://dashboard.vapi.ai/assistants) for Groq for a list of supported models.
+
+ This is the content for the doc fern/changelog/2024-12-19.mdx
+
+ 1. **Azure Region Renamed to `swedencentral` (from *sweden*)**: Azure Speech Services customers using the Sweden data center should now specify `swedencentral` as your Azure Speech Services region instead of `sweden`. Update your region in your code and the updated [provider keys page](https://dashboard.vapi.ai/keys) > *Azure Speech*.
+
+ This is the content for the doc fern/changelog/2024-12-21.mdx
+
+ **Expanded Voice Compatibility with Realtime Models**: You can use the voices ash, ballad, coral, sage, and verse with any realtime models, giving you more flexibility in voice synthesis options.
+
+**Access to New OpenAI Models**:
+ You can now specify the new models `gpt-4o-realtime-preview-2024-12-17` and `gpt-4o-mini-realtime-preview-2024-12-17` when configuring `OpenAIModel.model` and `OpenAIModel.fallbackModels`.
+
+**New ElevenLabs Voice Models Available**:
+ The new voice models `eleven_flash_v2` and `eleven_flash_v2_5` are now available for use in `ElevenLabsVoice` and `FallbackElevenLabsVoice`, offering potential improvements in voice performance.
+
+ This is the content for the doc fern/changelog/2024-12-30.mdx
+
+ 1. **Addition of *AzureSpeechTranscriber*:**
+ You can now configure assistants to use Azure's speech transcription service by setting
+`AzureSpeechTranscriber.provider` to `azure`. Additionally, you will receive azure transcriber errors like `pipeline-error-azure-speech-transcriber-failed` in `Call.endReason`, `ServerMessageEndOfCallReport.endReason`, and `ServerMessageStatusUpdate.endReason`.
+
+2. **Combined `serverUrl` and `serverUrlSecret` into `server` Property**:
+ The `serverUrl` and `serverUrlSecret` properties have been replaced by a new `server` property in multiple schemas. This lets you configure webhook endpoints using the `server` object, allowing for more detailed and flexible setup, including URL and authentication, in a single place. These schemas include:
+- ByoPhoneNumber
+- BuyPhoneNumberDTO
+- CreateByoPhoneNumberDTO
+- CreateOrgDTO
+- CreateTwilioPhoneNumberDTO
+- CreateVapiPhoneNumberDTO
+- CreateVonagePhoneNumberDTO
+- ImportTwilioPhoneNumberDTO
+- ImportVonagePhoneNumberDTO
+- Org
+- OrgWithOrgUser
+- TwilioPhoneNumber
+- UpdateOrgDTO
+- UpdatePhoneNumberDTO
+- VapiPhoneNumber
+- VonagePhoneNumber
+
+3. **Introduction of New OpenAI Models**:
+You can now use `o1-preview`, `o1-preview-2024-09-12`, `o1-mini`, and `o1-mini-2024-09-12`. in `OpenAIModel.model`.
+
+4. **Introduction of *'sonic' Voice Models* in Voice Schemas:**
+ You can now use `sonic` and `sonic-preview` models in `CartesiaVoice.model` and `FallbackCartesiaVoice.model` configurations.
+
+5. **Removal of Deprecated *GroqModel* Models:**
+ The models `llama3-groq-8b-8192-tool-use-preview` and `llama3-groq-70b-8192-tool-use-preview` have been removed from `GroqModel.model`. You should switch to supported models to avoid any disruptions.
+
+
+ This is the content for the doc fern/changelog/2025-01-05.mdx
+
+ 1. **New Transfer Plan Mode Added**: You can now include call summaries in the SIP header during blind transfers without assistant involvement with `blind-transfer-add-summary-to-sip-header` (a new `TransferPlan.mode` option). Doing so will make `ServerMessageStatusUpdate` include a `summary` when the call status is `forwarding` - which means you can access call summaries for real-time display or logging purposes in your SIP calls.
+
+2. **Azure Speech Transcription Support**: You can now specify a new property called `AzureSpeechTranscriber.language` in Azure's Speech-to-Text service to improve the accuracy of processing spoken input.
+
+3. **New Groq Model Available**: You can now use `'llama-3.3-70b-versatile'` in `GroqModel.model`.
+
+
+ 
+
+
+
+ This is the content for the doc fern/changelog/2025-01-07.mdx
+
+ # New Gemini 2.0 Models, Realtime Updates, and Configuration Options
+
+1. **New Gemini 2.0 Models**: You can now use two new models in `Assistant.model[model='GoogleModel']`: `gemini-2.0-flash-exp` and `gemini-2.0-flash-realtime-exp`, which give you access to the latest real-time capabilities and experimental features.
+
+2. **Support for Real-time Configuration with Gemini 2.0 Models**: Developers can now fine-tune real-time settings for the Gemini 2.0 Multimodal Live API using `Assistant.model[model='GoogleModel'].realtimeConfig`, enabling more control over text generation and speech output.
+
+3. **Customize Speech Output for Gemini Multimodal Live APIs**: You can now customize the assistant's voice using the `speechConfig` and `voiceConfig` properties, with options like `"Puck"`, `"Charon"`, and more.
+
+4. **Advanced Gemini Text Generation Parameters**: You can also tune advanced hyperparameters such as `topK`, `topP`, `presencePenalty`, and `frequencyPenalty` to control how the assistant generates responses, leading to more natural and dynamic conversations.
+
+ This is the content for the doc fern/changelog/2025-01-11.mdx
+
+ 1. **Integration of Smallest AI Voices**: Assistants can now utilize voices from Smallest AI by setting the voice provider to `Assistant.voice[provider="smallest-ai"]`, allowing selection from a variety of 25 preset voices and customization of voice attributes.
+
+2. **Support for DeepSeek Language Models**: Developers can now configure assistants to use DeepSeek LLMs by setting the `Assistant.model[provider="deep-seek"]` and `Assistant.model[model="deepseek-chat"]`. You can also specify custom credentials by passing the following payload:
+
+```json
+{
+ "credentials": [
+ {
+ "provider": "deep-seek",
+ "apiKey": "YOUR_API_KEY",
+ "name": "YOUR_CREDENTIAL_NAME"
+ }
+ ],
+ "model": {
+ "provider": "deep-seek",
+ "model": "deepseek-chat"
+ }
+}
+```
+
+3. **Additional Call Ended Reasons for DeepSeek and Cerebras**: New `Call.endedReason` have been added to handle specific DeepSeek and Cerebras call termination scenarios, allowing developers to better manage error handling.
+
+4. **New API Endpoint to Delete Logs**: A new `DELETE /logs` endpoint has been added, enabling developers to programmatically delete logs and manage log data.
+
+5. **Enhanced Call Transfer Options with SIP Verb**: You can now specify a `sipVerb` when defining a `TransferPlan` with `Assistant.model.tools[type=transferCall].destinations[type=sip].transferPlan` giving you the ability to specify the SIP verb (`refer` or `bye`) used during call transfers for greater control over call flow.
+
+6. **Azure Credentials and Blob Storage Support**: You can now configure Azure credentials with support for AzureCredential.service[service=blob_storage] service and use AzureBlobStorageBucketPlan withAzureCredential.bucketPlan, enabling you to store call artifacts directly in Azure Blob Storage.
+
+7. **Add Authentication Support for Azure OpenAI API Management with the 'Ocp-Apim-Subscription-Key' Header**: When configuring Azure OpenAI credentials, you can now include the AzureOpenAICredential.ocpApimSubscriptionKey to authenticate with Azure's OpenAI services for the API Management proxy in place of an API Key.
+
+8. **New CloudflareR2BucketPlan**: You can now use CloudflareR2BucketPlan to configure storage with Cloudflare R2 buckets, enabling you to store call artifacts directly.
+
+9. **Enhanced Credential Support**: It is now simpler to configure provider credentials in `Assistant.credentials`. Additionally, credentials can be overridden with `AssistantOverride.credentials` enables granular credential management per assistant. Our backend improvements add type safety and autocompletion for all supported credential types in the SDKs, making it easier to configure and maintain credentials for the following providers:
+
+- S3Credential
+- GcpCredential
+- XAiCredential
+- GroqCredential
+- LmntCredential
+- MakeCredential
+- AzureCredential
+- TavusCredential
+- GladiaCredential
+- GoogleCredential
+- OpenAICredential
+- PlayHTCredential
+- RimeAICredential
+- RunpodCredential
+- TrieveCredential
+- TwilioCredential
+- VonageCredential
+- WebhookCredential
+- AnyscaleCredential
+- CartesiaCredential
+- DeepgramCredential
+- LangfuseCredential
+- CerebrasCredential
+- DeepSeekCredential
+- AnthropicCredential
+- CustomLLMCredential
+- DeepInfraCredential
+- SmallestAICredential
+- AssemblyAICredential
+- CloudflareCredential
+- ElevenLabsCredential
+- OpenRouterCredential
+- TogetherAICredential
+- AzureOpenAICredential
+- ByoSipTrunkCredential
+- GoHighLevelCredential
+- InflectionAICredential
+- PerplexityAICredential
+
+10. **Specify Type When Updating Tools, Blocks, Phone Numbers, and Knowledge Bases**: You should now specify the type in the request body when [updating tools](https://api.vapi.ai/api#/Tools/ToolController_update), [blocks](https://api.vapi.ai/api#/Blocks/BlockController_update), [phone numbers](https://api.vapi.ai/api#/Phone%20Numbers/PhoneNumberController_update), or [knowledge bases](https://api.vapi.ai/api#/Knowledge%20Base/KnowledgeBaseController_update) using the appropriate payload for each type. Specifying the type now provides type safety and autocompletion in the SDKs. Refer to [the schemas](https://api.vapi.ai/api) to see the expected payload for the following types:
+
+- UpdateBashToolDTO
+- UpdateComputerToolDTO
+- UpdateDtmfToolDTO
+- UpdateEndCallToolDTO
+- UpdateFunctionToolDTO
+- UpdateGhlToolDTO
+- UpdateMakeToolDTO
+- UpdateOutputToolDTO
+- UpdateTextEditorToolDTO
+- UpdateTransferCallToolDTO
+- BashToolWithToolCall
+- ComputerToolWithToolCall
+- TextEditorToolWithToolCall
+- UpdateToolCallBlockDTO
+- UpdateWorkflowBlockDTO
+- UpdateConversationBlockDTO
+- UpdateByoPhoneNumberDTO
+- UpdateTwilioPhoneNumberDTO
+- UpdateVonagePhoneNumberDTO
+- UpdateVapiPhoneNumberDTO
+- UpdateCustomKnowledgeBaseDTO
+- UpdateTrieveKnowledgeBaseDTO
+
+
+
+ This is the content for the doc fern/changelog/2025-01-14.mdx
+
+ **End Call Message Support in ClientInboundMessage**: Developers can now programmatically end a call by sending an `end-call` message type within `ClientInboundMessage`. To use this feature, include a message with the `type` property set to `"end-call"` when sending inbound messages to the client.
+
+ This is the content for the doc fern/changelog/2025-01-15.mdx
+
+ 1. **Updated Log Endpoints:**
+Both the `GET /logs` and `DELETE /logs` endpoints have been simplified by removing the `orgId` parameter.
+
+2. **Updated Log Schema:**
+The following fields in the Log schema are no longer required: `requestDurationSeconds`, `requestStartedAt`, `requestFinishedAt`, `requestBody`, `requestHttpMethod`, `requestUrl`, `requestPath`, and `responseHttpCode`.
+
+ This is the content for the doc fern/changelog/2025-01-20.mdx
+
+ # Workflow Steps, Trieve Knowledge Base Updates, and Concurrent Calls Tracking
+
+1. **Use Workflow Blocks to Simplify Blocks Steps:** You can now compose complicated Blocks steps with smaller, resuable [Workflow blocks](https://api.vapi.ai/api#:~:text=Workflow) that manage conversations and take actions in external systems.
+
+In addition to normal operations inside [Block steps](https://docs.vapi.ai/blocks/steps) - you can now [Say messages](https://api.vapi.ai/api#:~:text=Say), [Gather information](https://api.vapi.ai/api#:~:text=Gather), or connect to other workflow [Edges](https://api.vapi.ai/api#:~:text=Edge) based on a [LLM evaluating a condition](https://api.vapi.ai/api#:~:text=SemanticEdgeCondition), or a more [logic-based condition](https://api.vapi.ai/api#:~:text=ProgrammaticEdgeCondition). Workflows can be used through `Assistant.model["VapiModel"]` to create custom call workflows.
+
+2. **Trieve Knowledge Base Integration Improvements:** You should now configure [Trieve knowledge bases](https://api.vapi.ai/api#:~:text=TrieveKnowledgeBase) using the new `createPlan` and `searchPlan` fields instead of specifying the raw vector plans directly. The new plans allow you to create or import trieve plans directly, and specify the type of search more precisely than before.
+
+3. **Updated Concurrency Tracking:** Your subscriptions now track active calls with `concurrencyCounter`, replacing `concurrencyLimit`. This does not affect how you reserve concurrent calls through [billing add-ons](https://dashboard.vapi.ai/org/billing/add-ons).
+
+
+ 
+
+
+4. **Define Allowed Values with `type` using `JsonSchema`:** You can restrict model outputs to specific values inside Blocks or tool calls using the new `type` property in [JsonSchema](https://api.vapi.ai/api#:~:text=JsonSchema). Supported types include `string`, `number`, `integer`, `boolean`, `array` (which also needs `items` to be defined), and `object` (which also needs `properties` to be defined).
+
+
+
+ This is the content for the doc fern/changelog/2025-01-21.mdx
+
+ # Updated Azure Regions for Credentials
+
+1. **Updated Azure Regions for Credentials**: You can now specify `canadacentral`, `japaneast`, and `japanwest` as valid regions when specifying your Azure credentials. Additionally, the region `canada` has been renamed to `canadaeast`, and `japan` has been replaced with `japaneast` and `japanwest`; please update your configurations accordingly.
+
+
+ 
+
+
+
+ This is the content for the doc fern/changelog/2025-01-22.mdx
+
+ # Tool Calling Updates, Final Transcripts, and DeepSeek Reasoner
+1. **Migrate `ToolCallFunction` to `ToolCall`**: You should update your client and server tool calling code to use the [`ToolCall` schema](https://api.vapi.ai/api#:~:text=ToolCall) instead of `ToolCallFunction`, which includes properties like `name`, `tool`, and `toolBody` for more detailed tool call specifications. ToolCallFunction has been removed.
+
+2. **Include `ToolCall` Nodes in Workflows**: You can now incorporate [`ToolCall` nodes](https://api.vapi.ai/api#:~:text=ToolCall) directly into workflow block steps, enabling tools to be invoked as part of the workflow execution.
+
+3. **New Model Option `deepseek-reasoner`**: You can now select `deepseek-reasoner` as a model option inside your assistants with `Assistant.model["deep-seek"].model["deepseek-reasoner"]`, offering enhanced reasoning capabilities for your applications.
+
+4. **Support for Final Transcripts in Server Messages**: The API now supports `'transcript[transcriptType="final"]'` in server messages, allowing your application to handle and process end of conversation transcripts.
+
+ This is the content for the doc fern/changelog/2025-01-29.mdx
+
+ # New workflow nodes, improved call handling, better phone number management, and expanded tool calling capabilities
+
+1. **New Hangup Workflow Node**: You can now include a [`Hangup`](https://api.vapi.ai/api#:~:text=Hangup) node in your workflows to end calls programmatically.
+
+2. **New HttpRequest Workflow Node**: Workflows can now make HTTP requests using the new [`HttpRequest`](https://api.vapi.ai/api#:~:text=HttpRequest) node, enabling integration with external APIs during workflow execution.
+
+3. **Updates to Tool Calls**: The [`ToolCall`](https://api.vapi.ai/api#:~:text=ToolCall) schema has been revamped; you should update your tool calls to use the new `function` property with `id` and `function` details (instead of older `tool` and `toolBody` properties).
+
+4. **Improvements to [Say](https://api.vapi.ai/api#:~:text=Say), [Edge](https://api.vapi.ai/api#:~:text=Edge), [Gather](https://api.vapi.ai/api#:~:text=Gather), and [Workflow](https://api.vapi.ai/api#:~:text=Workflow) Nodes**:
+- The `name`, `to`, and `from` properties in these nodes now support up to 80 characters, letting you use more descriptive identifiers.
+- A `metadata` property has been added to these nodes, allowing you to store additional information.
+- The [`Gather`](https://api.vapi.ai/api#:~:text=Gather) node now supports a `confirmContent` option to confirm collected data with users.
+
+5. **Regex Validation with Json Outputs**: You can now validate inputs and outputs from your conversations, tool calls, and OpenAI structured outputs against regular expressions using the `regex` property in [`JSON outputs`](https://api.vapi.ai/api#:~:text=JsonSchema) node.
+
+6. **New Assistant Transfer Mode**: A new [transfer mode](https://api.vapi.ai/api#:~:text=TransferPlan) `swap-system-message-in-history-and-remove-transfer-tool-messages` allows more control over conversation history during assistant transfers.
+
+7. **Area Code Selection for Vapi Phone Numbers**: You can now specify a desired area code when creating Vapi phone numbers using `numberDesiredAreaCode`.
+
+8. **Chat Completions Support**: You can now handle chat messages and their metadata within your applications using familiar chat completion messages in your workflow nodes.
+
+
+ This is the content for the doc fern/changelog/2025-02-01.mdx
+
+ # API Request Node, Improved Retries, and Enhanced Message Controls
+
+1. **HttpRequest Node Renamed to ApiRequest**: The `HttpRequest` workflow node has been renamed to [`ApiRequest`](https://api.vapi.ai/api#:~:text=ApiRequest), and can be accessed through `Assistant.model.workflow.nodes[type="api-request"]`. Key changes:
+ - New support for POST requests with customizable headers and body
+ - New async request support with `isAsync` flag
+ - Task status messages for waiting, starting, failure and success states
+
+
+
+
+10. **Deprecated Schemas and Properties**: The following properties and schemas are now deprecated in the [API reference](https://api.vapi.ai/api/):
+ * `SemanticEdgeCondition`
+ * `ProgrammaticEdgeCondition`
+ * `Workflow.type`
+ * `ApiRequest.waitTaskMessage`
+ * `ApiRequest.startTaskMessage`
+ * `ApiRequest.failureTaskMessage`
+ * `ApiRequest.successTaskMessage`
+ * `OpenAIModel.semanticCachingEnabled`
+ * `CreateWorkflowDTO.type`
+
+
+ This is the content for the doc fern/changelog/2025-02-17.mdx
+
+ ## What's New
+
+### Compliance & Security Enhancements
+- **New [CompliancePlan](https://api.vapi.ai/api#:~:text=CompliancePlan) Consolidates HIPAA and PCI Compliance Settings**: You should now enable HIPAA and PCI compliance settings with `Assistant.compliancePlan.hipaaEnabled` and `Assistant.compliancePlan.pciEnabled` which both default to `false` (replacing the old HIPAA and PCI flags on `Assistant` and `AssistantOverrides`).
+
+- **Phone Number Status Tracking**: You can now view your phone number `status` with `GET /phone-number/{id}` for all phone number types ([Bring Your Own Number](https://api.vapi.ai/api#:~:text=ByoPhoneNumber), [Vapi](https://api.vapi.ai/api#:~:text=VapiPhoneNumber), [Twilio](https://api.vapi.ai/api#:~:text=TwilioPhoneNumber), [Vonage](https://api.vapi.ai/api#:~:text=VonagePhoneNumber)) for better monitoring.
+
+### Advanced Call Control
+
+- **Assistant Hooks System**: You can now use [`AssistantHooks`](https://api.vapi.ai/api#:~:text=AssistantHooks) to support `call.ending` events with customizable filters and actions
+ - Enable transfer actions through [`TransferAssistantHookAction`](https://api.vapi.ai/api#:~:text=TransferAssistantHookAction). For example:
+```javascript
+{
+ "hooks": [{
+ "on": "call.ending",
+ "do": [{
+ "type": "transfer",
+ "destination": {
+ // Your transfer configuration
+ }
+ }]
+ }]
+}
+```
+
+ - Conditionally execute hooks with `Assistant.hooks.filter`. For example, trigger different hooks for call completed, system errors, or customer hangup / transfer:
+
+```json
+{
+ "assistant": {
+ "hooks": [{
+ "filters": [{
+ "type": "oneOf",
+ "key": "call.endedReason",
+ "oneOf": ["pipeline-error-custom-llm-500-server-error", "pipeline-error-custom-llm-llm-failed"]
+ }]
+ }
+ ]
+ }
+}
+```
+
+### Model & Voice Updates
+
+- **New Models Added**: You can now use new models inside `Assistant.model[provider="google", "openai", "xai"]` and `Assistant.fallbackModels[provider="google", "openai", "xai"]`
+ - Google: Gemini 2.0 series (`flash-thinking-exp`, `pro-exp-02-05`, `flash`, `flash-lite-preview`)
+ - OpenAI: o3 mini `o3-mini`
+ - xAI: Grok 2 `grok-2`
+
+
+ 
+
+
+- **New `PlayDialog` Model for [PlayHT Voices](https://api.vapi.ai/api#:~:text=PlayHTVoice)**: You can now use the `PlayDialog` model in `Assistant.voice[provider="playht"].model["PlayDialog"]`.
+
+- **New `nova-3` and `nova-3-general` Models for [Deepgram Transcriber](https://api.vapi.ai/api#:~:text=DeepgramTranscriber)**: You can now use the `nova-3` and `nova-3-general` models in `Assistant.transcriber[provider="deepgram"].model["nova-3", "nova-3-general"]`
+
+### API Improvements
+
+- **Workflow Updates**: You can now send a [`workflow.node.started`](https://api.vapi.ai/api#:~:text=ClientMessageWorkflowNodeStarted) message to track the start of a workflow node for better call flow tracking
+
+- **Analytics Enhancement**: Added subscription table and concurrency columns in [POST /analytics](https://api.vapi.ai/api#/Analytics/AnalyticsController_query) for richer queries about your subscriptions and concurrent calls.
+
+### Deprecations
+
+
+
+
+5. **Support for pre-transfer announcements in [ClientInboundMessageTransfer](https://api.vapi.ai/api#:~:text=ClientInboundMessageTransfer)**: The `content` field in `ClientInboundMessageTransfer` now supports pre-transfer announcements ("Connecting you to billing...") before SIP/number routing. Implement via WebSocket messages using type: "transfer" with destination object.
+
+### Deprecation Notice
+
+
+
+
+2. **Enhanced Call Transfers with TwiML Control:** You can now use `twiml` ([Twilio Markup Language](https://www.twilio.com/docs/voice/twiml)) in [`Assistant.model.tools[type=transferCall].destinations[].transferPlan[mode=warm-transfer-twiml]`](https://api.vapi.ai/api#:~:text=TransferPlan) to execute TwiML instructions before connecting the call, allowing for pre-transfer announcements or data collection with Twilio.
+
+3. **New Voice Models and Experimental Controls:**
+ * **`mistv2` Rime AI Voice:** You can now use the `mistv2` model in [`Assistant.voice[provider="rime-ai"].model[model="mistv2"]`](https://api.vapi.ai/api#:~:text=RimeAIVoice).
+ * **OpenAI Models:** You can now use `chatgpt-4o-latest` model in [`Assistant.model[provider="openai"].model[model="chatgpt-4o-latest"]`](https://api.vapi.ai/api#:~:text=OpenAIModel).
+
+4. **Experimental Controls for Cartesia Voices:** You can now specify your Cartesia voice speed (string) and emotional range (array) with [`Assistant.voice[provider="cartesia"].experimentalControls`](https://api.vapi.ai/api#:~:text=CartesiaExperimentalControls). For example:
+
+```json
+{
+ "speed": "fast",
+ "emotion": [
+ "anger:lowest",
+ "curiosity:high"
+ ]
+}
+```
+
+| Property | Option |
+|----------|--------|
+| speed | slowest |
+| | slow |
+| | normal (default) |
+| | fast |
+| | fastest |
+| emotion | anger:lowest |
+| | anger:low |
+| | anger:high |
+| | anger:highest |
+| | positivity:lowest |
+| | positivity:low |
+| | positivity:high |
+| | positivity:highest |
+| | surprise:lowest |
+| | surprise:low |
+| | surprise:high |
+| | surprise:highest |
+| | sadness:lowest |
+| | sadness:low |
+| | sadness:high |
+| | sadness:highest |
+| | curiosity:lowest |
+| | curiosity:low |
+| | curiosity:high |
+| | curiosity:highest |
+
+
+ This is the content for the doc fern/changelog/2025-02-27.mdx
+
+ # Phone Keypad Input Support, OAuth2 and Analytics Improvements
+
+1. **Keypad Input Support for Phone Calls:** A new [`keypadInputPlan`](https://api.vapi.ai/api#:~:text=KeypadInputPlan) feature has been added to enable handling of DTMF (touch-tone) keypad inputs during phone calls. This allows your voice assistant to collect numeric input from callers, like account numbers, menu selections, or confirmation codes.
+
+Configuration options:
+```json
+{
+ "keypadInputPlan": {
+ "enabled": true, // Default: false
+ "delimiters": "#", // Options: "#", "*", or "" (empty string)
+ "timeoutSeconds": 2 // Range: 0.5-10 seconds, Default: 2
+ }
+}
+```
+
+The feature can be configured in:
+- `assistant.keypadInputPlan`
+- `call.squad.members.assistant.keypadInputPlan`
+- `call.squad.members.assistantOverrides.keypadInputPlan`
+
+2. **OAuth2 Authentication Enhancement:** The [`OAuth2AuthenticationPlan`](https://api.vapi.ai/api#:~:text=OAuth2AuthenticationPlan) now includes a `scope` property to specify access scopes when authenticating. This allows more granular control over permissions when integrating with OAuth2-based services.
+
+```json
+{
+ "credentials": [
+ {
+ "authenticationPlan": {
+ "type": "oauth2",
+ "url": "https://example.com/oauth2/token",
+ "clientId": "your-client-id",
+ "clientSecret": "your-client-secret",
+ "scope": "read:data" // New property, max length: 1000 characters
+ }
+ }
+ ]
+}
+```
+
+The scope property can be configured at:
+- `assistant.credentials.authenticationPlan`
+- `call.squad.members.assistant.credentials.authenticationPlan`
+
+3. **New Analytics Metric: Minutes Used** The [`AnalyticsOperation`](https://api.vapi.ai/api#:~:text=AnalyticsOperation) schema now includes a new column option: `minutesUsed`. This metric allows you to track and analyze the duration of calls in your usage reports and analytics dashboards.
+
+
+4. **Removed TrieveKnowledgeBaseCreate Schema:** Removed `TrieveKnowledgeBaseCreate` schema from
+- `TrieveKnowledgeBase.createPlan`
+- `CreateTrieveKnowledgeBaseDTO.createPlan`
+- `UpdateTrieveKnowledgeBaseDTO.createPlan`
+
+
+ This is the content for the doc fern/changelog/2025-03-02.mdx
+
+ ## Claude 3.7 Sonnet and GPT 4.5 preview, New Hume AI Voice Provider, New Supabase Storage Provider, Enhanced Call Transfer Options
+
+1. **Claude 3.7 Sonnet with Thinking Configuration Support**:
+You can now use the latest claude-3-7-sonnet-20250219 model with a new "thinking" feature via the [`AnthropicThinkingConfig`](https://api.vapi.ai/api#:~:text=AnthropicThinkingConfig) schema.
+Configure it in `assistant.model` or `call.squad.members.assistant.model`:
+```json
+{
+ "model": "claude-3-7-sonnet-20250219",
+ "provider": "anthropic",
+ "thinking": {
+ "type": "enabled",
+ "budgetTokens": 5000 // min 1024, max 100000
+ }
+}
+```
+
+2. **OpenAI GPT-4.5-Preview Support**:
+You can now use the latest gpt-4.5-preview model as a primary model or fallback option via the [`OpenAIModel`](https://api.vapi.ai/api#:~:text=OpenAIModel) schema.
+Configure it in `assistant.model` or `call.squad.members.assistant.model`:
+```json
+{
+ "model": "gpt-4.5-preview",
+ "provider": "openai"
+}
+```
+
+3. **New Hume Voice Provider**:
+Integrated Hume AI as a new voice provider with the "octave" model for text-to-speech synthesis.
+
+
+ 
+
+
+4. **Supabase Storage Integration**:
+New Supabase S3-compatible storage support for file operations. This integration lets developers configure buckets and paths across 16 regions, enabling structured file storage with proper authentication.
+Configure [`SupabaseBucketPlan`](https://api.vapi.ai/api#:~:text=SupabaseBucketPlan) in `assistant.credentials.bucketPlan`,`call.squad.members.assistant.credentials.bucketPlan`
+
+5. **Voice Speed Control**
+Added a speed parameter to ElevenLabs voices ranging from 0.7 (slower) to 1.2 (faster) [`ElevenLabsVoice`](https://api.vapi.ai/api#:~:text=ElevenLabsVoice). This enhancement gives developers more control over speech cadence for more natural-sounding conversations.
+
+6. **Enhanced Call Transfer Options in TransferPlan**
+Added a new dial option to the sipVerb parameter for call transfers. This complements the existing refer (default) and bye options, providing more flexibility in call handling.
+- 'dial': Uses SIP DIAL to transfer the call
+
+7. **Zero-Value Minumum Subscription Minutes**
+Changed the minimum value for minutesUsed and minutesIncluded from 1 to 0. This supports tracking of new subscriptions and free tiers with no included minutes.
+
+8. **Zero-Value Minimum KeypadInputPlan Timeout**
+Adjusted the KeypadInputPlan.timeoutSeconds minimum from 0.5 to 0.
+
+
+ This is the content for the doc fern/changelog/2025-03-06.mdx
+
+ ## New Query Tool and Vapi Voice Provider, Updates to Language Support and Error Handling
+
+1. **New Query Tool Feature and Knowledge Base Integration**
+
+* The API now supports a new query tool that allows assistants to search through knowledge bases. Add this tool to any assistant model by configuring it at `assistant.model.tools[type=query]` path.
+* You can now link knowledge bases to query tools, providing structured information sources for assistants to access. Define knowledge bases with a name, model, provider, description, and associated file IDs.
+
+
+
+
+3. **Language Support Updates**
+
+Myanmar language ("my") has been added to supported languages, while "jp" and "mymr" codes have been removed. Use "ja" for Japanese language and "my" for Myanmar. Reference [`GladiaTranscriber`](https://api.vapi.ai/api#:~:text=GladiaTranscriber) for more language codes.
+
+4. **Error Handling Improvements**
+
+Added new error code `pipeline-error-11labs-transcriber-failed` for `ServerMessageStatusUpdate.endedReason` and `ServerMessageEndOfCallReport.endedReason`. Also added an explicit `failed` status for test suite runs in [`TestSuiteRun`](https://api.vapi.ai/api#:~:text=TestSuiteRun). These additions provide more detailed error reporting.
+
+5. **Azure OpenAI Model Update**
+
+The model `gpt-4o-2024-08-06-ptu` has been removed from Azure OpenAI credential schemas. Update any credential configurations that were using this model.
+
+ This is the content for the doc fern/changelog/2025-03-09.mdx
+
+ ## Enhanced Voicemail Detection, File Processing, Knowledge Base Integration, and Invoicing Updates
+
+1. **Track Voicemail Detection Cost, Configure Google and Twilio Voicemail Detection Plans**
+
+* You can now configure provider-specific settings and track voicemail detection costs through the new `VoicemailDetectionCost` schema at `call.costs[type=voicemail-detection]`.
+* Configure Google or Twilio voicemail detection settings using the new [`GoogleVoicemailDetectionPlan`](https://api.vapi.ai/api#:~:text=GoogleVoicemailDetectionPlan) and [`TwilioVoicemailDetectionPlan`](https://api.vapi.ai/api#:~:text=TwilioVoicemailDetectionPlan) schemas.
+
+```json
+// Google configuration example
+{
+ "provider": "google",
+ "voicemailExpectedDurationSeconds": 15 // Range: 5-60 seconds
+}
+```
+
+```json
+// Twilio configuration example
+{
+ "provider": "twilio",
+ "enabled": true,
+ "machineDetectionTimeout": 30, // Range: 3-59 seconds
+ "voicemailDetectionTypes": ["machine_end_beep", "machine_end_silence"]
+}
+```
+
+2. **Improved File Processing Statuses and Parsed Text Content**
+
+* File processing statuses have been renamed to better reflect their purpose: `processing` → `done` → `failed`.
+* Two new properties have been added to the [`File`](https://api.vapi.ai/api#:~:text=File) schema: `parsedTextUrl` and `parsedTextBytes`, providing direct access to parsed text content from processed files.
+
+3. **Google Gemini Models for Knowledge Base Integration**
+
+* The [`KnowledgeBase`](https://api.vapi.ai/api#:~:text=KnowledgeBase) schema now fully supports Google's Gemini models with specific model options.
+* You can use Gemini models in your knowledge bases at `assistant.model.tools[type=query].knowledgeBases`.
+
+```json
+"model": {
+ "enum": [
+ "gemini-2.0-flash-thinking-exp",
+ "gemini-2.0-pro-exp-02-05",
+ "gemini-2.0-flash",
+ "gemini-2.0-flash-lite-preview-02-05",
+ "gemini-2.0-flash-exp",
+ "gemini-2.0-flash-realtime-exp",
+ "gemini-1.5-flash",
+ "gemini-1.5-flash-002",
+ "gemini-1.5-pro",
+ "gemini-1.5-pro-002",
+ "gemini-1.0-pro"
+ ]
+}
+```
+
+4. **New Invoicing Features**
+
+* You can now use [`InvoicePlan`](https://api.vapi.ai/api#:~:text=InvoicePlan) schema for customizing invoice information with company details.
+* This can be accessed via the new `invoicePlan` property on the [`Subscription`](https://api.vapi.ai/api#:~:text=Subscription) schema.
+* Customize company name, email, tax ID, and address for your invoices.
+
+5. **Additional Voice Options**
+
+* Five new voice options have been added to the [`FallbackVapiVoice`](https://api.vapi.ai/api#:~:text=FallbackVapiVoice) schema: `Adi`, `Julia`, `Maibri (Web)`, `Maibri (Phone)`, and `Ashley`.
+* Configure these voices in your assistant fallback plans at `assistant.voice.fallbackPlan.voices`.
+
+ 
+
+
+ This is the content for the doc fern/changelog/2025-03-13.mdx
+
+ ## New Workflows API, Telnyx Phone Number Support, Voice Options, and much more
+
+1. **Workflows Replace Blocks**: The API has migrated from blocks to workflows with new `/workflow` endpoints. [Introduction to Workflows](https://docs.vapi.ai/workflows)
+You can now use [`UpdateWorkflowDTO`](https://api.vapi.ai/api#:~:text=UpdateWorkflowDTO) where conversation components (`Say`, `Gather`, `ApiRequest`, `Hangup`, `Transfer` nodes) are explicitly connected via edges to create directed conversation flows.
+
+
+
+
+2. **New Assistant Paginated Response**: All [`Assistant`](https://api.vapi.ai/api#:~:text=Assistants) endpoints now return paginated responses. Each response specifies `itemsPerPage`, `totalItems`, and `currentPage`, which you can use to navigate through a list of assistants.
+
+ This is the content for the doc fern/changelog/2025-03-17.mdx
+
+ # New `timeoutSeconds` Property in Custom LLM Model
+
+1. **New `timeoutSeconds` Property in [`Custom LLM Model`](https://api.vapi.ai/api#:~:text=CustomLLMModel):** Developers can now specify a custom timeout duration (between 20 and 600 seconds) for connections to their [custom language model provider](https://api.vapi.ai/api#:~:text=CustomLLMModel) using the new `timeoutSeconds` property. This enhancement allows for better control over response waiting times, accommodating longer operations or varying network conditions.
+
+
+ This is the content for the doc fern/changelog/2025-03-19.mdx
+
+
+# Test Suite, Smart Endpointing, and Compliance Plans, Chat Completion Message Workflows, and Voicemail Detection
+
+1. **Test Suite Enhancements**: Developers can now define `targetPlan` and `testerPlan` when creating or updating [test suites](https://api.vapi.ai/api#:~:text=TestSuite), allowing for customized testing configurations without importing phone numbers to Vapi.
+
+2. **Smart Endpointing Updates**: You can now select between [`Vapi`](https://api.vapi.ai/api#:~:text=VapiSmartEndpointingPlan) and [`Livekit`](https://api.vapi.ai/api#:~:text=LivekitSmartEndpointingPlan) smart endpointing providers using the `Assistant.startSpeakingPlan.smartEndpointingPlan`; the `customEndpointingRules` property is deprecated and should no longer be used.
+
+3. **Compliance Plan Enhancements**: Organizations can now specify compliance settings using the new `compliancePlan` property, enabling features like PCI compliance at the org level.
+
+4. **Chat Completion Message Updates**: When working with OpenAI chat completions, you should now use [`ChatCompletionMessageWorkflows`](https://api.vapi.ai/api#:~:text=ChatCompletionMessageWorkflows) instead of the deprecated `ChatCompletionMessage`.
+
+5. **Voicemail Detection Defaults Updated**: The default `voicemailExpectedDurationSeconds` for voicemail detection plans has increased from 15 to 25 seconds, affecting how voicemail detection timings are handled.
+
+ This is the content for the doc fern/changelog/2025-03-20.mdx
+
+ # Introducing Google Calendar Integration, and Chat Test Suite / Rime AI Voice Enhancements
+
+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.
+
+
+ 
+
+
+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.
+
+3. **Chat Test Suite Enhancements**: You can now create and run chat-based tests in your test suites using the new [`TestSuiteTestChat`](https://api.vapi.ai/api#:~:text=TestSuiteTestChat) to more comprehensively test conversational interactions in your assistant.
+
+4. **Maximum Length for Test Suite Chat Scripts**: When creating or updating chat tests, note that the `script` property now has a maximum length of 10,000 characters. Ensure your test scripts conform to this limit to avoid any validation errors.
+
+ This is the content for the doc fern/changelog/2025-03-21.mdx
+
+
+1. **OpenAI Voice Enhancements**: When using [OpenAI Voice models in `Assistant.voice`](https://api.vapi.ai/api#:~:text=OpenAIVoice), you can now use specific text to speech models and add custom instructions to control your assistant's voice output
+
+2. **Improved Call Error Reporting**: You can now use new [`Call.endedReason`](https://api.vapi.ai/api#:~:text=Call,-CallBatchError) codes when a call fails to start or ends unexpectedly due to failing to retrieve Vapi objects. Refer to [Call.endedReason](https://api.vapi.ai/api#:~:text=Call,-CallBatchError) for more details.
+
+ This is the content for the doc fern/changelog/2025-03-22.mdx
+
+
+1. **Customizable Background Sound**: You can now use a custom audio file as the background sound in calls by providing a URL in the `backgroundSound` property. This allows you to enhance the call experience with personalized ambient sounds or music.
+
+2. **New Recording Format Options in `ArtifactPlan`**: You can specify the recording format as either `'wav;l16'` or `'mp3'` in `Assistant.artifactPlan` or `Call.artifactPlan`. This gives you control over the audio format of call recordings to suit your storage and playback preferences.
+
+3. **Integrate with Langfuse for Enhanced Observability**: You can now integrate with Langfuse by setting `assistant.observabilityPlan` to `langfuse`. Add `tags` and `metadata` to your traces to improve monitoring, categorization, and debugging of your application's behavior.
+
+ This is the content for the doc fern/changelog/2025-03-23.mdx
+
+ 1. **Multi-Structured Data Extraction with `StructuredDataMultiPlan`:** You can now extract multiple sets of structured data from calls by configuring `assistant.analysisPlan.structuredDataMultiPlan`. This allows you to define various extraction plans, each producing structured outputs accessible via `call.analysis.structuredDataMulti`.
+
+2. **Customizable Voice Speed and Language Settings:** You can now adjust the speech speed and language for your assistant's voice by using the new `speed` and `language` properties in `Assistant.voice`. This enables you to fine-tune the voice output to better match your user's preferences and localize the experience.
+
+3. **Integration of OpenAI Transcriber:** The `transcriber` property in assistants now supports `OpenAITranscriber`, allowing you to utilize OpenAI's transcription services. A corresponding `Call.endedReason` value, `pipeline-error-openai-transcriber-failed`, has been added to help you identify when a call ends due to an OpenAI transcriber error.
+
+ This is the content for the doc fern/changelog/2025-03-27.mdx
+
+ 1. **Batch Call Operations**: You can now place multiple calls to different customers at once by providing a list of `customer`s as an array in [`POST /call`](https://api.vapi.ai/api#/Calls/CallController_create).
+
+2. **Google Sheets Row Append Tool Added**: You can now append rows to Google Sheets directly from your assistant using [`GoogleSheetsRowAppendTool`](https://api.vapi.ai/api#/Tools/GoogleSheetsRowAppendTool). This allows integration with Google Sheets via the API for automating data entry tasks.
+
+3. **Call Control and Scheduling**: You can now schedule calls using the new `SchedulePlan` feature, specifying earliest and latest times for calls to occur. This gives you more control over call timing and scheduling.
+
+4. **New Transcriber Options and Fallback Plans**: New transcribers like `GoogleTranscriber` and `OpenAITranscriber` have been added, along with the ability to set `fallbackPlan` for transcribers. This provides more choices and reliability for speech recognition in your applications.
+
+ This is the content for the doc fern/changelog/2025-03-28.mdx
+
+ 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).
+
+
+ 
+
+
+
+
+
+
+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`.
+
+ This is the content for the doc fern/changelog/2025-03-30.mdx
+
+ 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.
+
+
+ This is the content for the doc fern/changelog/2025-04-03.mdx
+
+ 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.
+
+ This is the content for the doc fern/changelog/2025-04-04.mdx
+
+ 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.
+
+ This is the content for the doc fern/changelog/2025-04-05.mdx
+
+ 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.
+
+
+ 
+
+
+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.
+
+ This is the content for the doc fern/changelog/2025-04-08.mdx
+
+ 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.
+
+
+
+
+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.
+
+ This is the content for the doc fern/changelog/2025-04-12.mdx
+
+
+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.
+
+ This is the content for the doc fern/changelog/2025-04-15.mdx
+
+ 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.
+
+
+ 
+
+
+
+ This is the content for the doc fern/changelog/2025-04-16.mdx
+
+ 1. **Assistant Overrides in Testing (`TargetPlan.assistantOverrides`)**: You can now apply `assistantOverrides` when testing an assistant with a [Target Plan](https://api.vapi.ai/api#:~:text=TargetPlan), allowing modifications to the assistant's configuration specifically for tests without changing the original assistant. This helps in testing different configurations or behaviors of an assistant without affecting the live version.
+
+2. **Specify Voice Model with Deepgram**: You can now specify the `model` to be used by Deepgram voices by setting the `model` property to `"aura"` or `"aura-2"` (default: `"aura-2"`).
+
+3. **Expanded Deepgram Voice Options (`voiceId` in `DeepgramVoice` and `FallbackDeepgramVoice`)**: The list of available deepgram voice options has been greatly expanded, providing a wider selection of voices for assistants. This allows you to customize the assistant's voice to better match your desired persona with `Assistant.voice["DeepgramVoice"].voiceId`.
+
+
+ 
+
+
+
+4. **Control Text Replacement Behavior (`replaceAllEnabled` in `ExactReplacement`)**: A new property `replaceAllEnabled` allows you to decide whether to replace all instances of a specified text (`key`) or just the first occurrence in [`ExactReplacement`](https://api.vapi.ai/api#:~:text=ExactReplacement) configurations. Setting `replaceAllEnabled` to `true` ensures that all instances are replaced.
+
+ This is the content for the doc fern/changelog/2025-04-17.mdx
+
+ **1. **Custom Hooks When a Call is Ringing**: You can now define custom hooks on your phone numbers to automatically perform actions when a call is ringing. This enables you to play messages or transfer calls without additional server-side code by using the new `hooks` property in `Call.phoneNumber.hooks["phoneNumberHookCallRinging"]`.
+
+**2. **Say and Transfer Actions in Hooks**: The new [phone number hook call ringing](https://api.vapi.ai/api#:~:text=PhoneNumberHookCallRinging) allows you to specify actions that trigger when a call is ringing (`on: 'call.ringing'`). like [redirecting calls](https://api.vapi.ai/api#:~:text=TransferPhoneNumberHookAction) or [playing a message](https://api.vapi.ai/api#:~:text=SayPhoneNumberHookAction). Include these actions in the `do` array of your hook.
+
+**3. **Enhanced Call Tracking with endedReason**: When implementing call analytics, you can now track calls that ended due to hook actions through new `endedReason` values:
+- `'call.ringing.hook-executed-say'`: Call ended after playing a message via hook
+- `'call.ringing.hook-executed-transfer'`: Call ended after being transferred via hook
+These values let you distinguish between different automated call handling outcomes in your reporting.
+
+ This is the content for the doc fern/changelog/2025-04-18.mdx
+
+ 1. **Idle Message Count Reset in `Assistant.messagePlan`**: You can now enable `Assistant.messagePlan.idleMessageResetCountOnUserSpeechEnabled` (default: false) to allow the idle message count to reset whenever the user speaks. This means the assistant can repeatedly remind an idle user throughout the conversation.
+
+
+ This is the content for the doc fern/changelog/overview.mdx
+
+ ---
+slug: changelog
+---
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ .png)
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+
+
+ This is the content for the doc fern/community/ghl.mdx
+
+ ---
+title: GoHighLevel
+subtitle: Videos showcasing Vapi out in the wild.
+slug: community/ghl
+---
+
+
+Here are some videos made by people in our community showcasing what Vapi can do:
+
+
+
+
+Qonvo
+Qonvo is the best way to stop wasting your time on the phone for repetitive tasks and low-value added inbound requests. Allow your self to better invest your time thanks custom-build Vocal AI agents.
+
+
+
+6omb
+Voice agents and custom product development.
+
+
+
+Aitoflo
++ At Aitoflo, we specialize in Voice AI and RPA services, seamlessly flowing + to streamline business operations and enhance customer interactions with + Realistic Voice AI. +
+
+
+
+Amplify Voice
++ Our hyper-focus on User Experience will WOW your customers. Click to Book + a Strategy Session. +
+
+
+
+Arose AI
++ Arose AI creates custom Inbound Voice AI solutions for small businesses. + Our founder Tommy Chryst also provides 1-on-1 coaching. +
+
+
+
+AIP
++ Created debt collector, appointment book, customer service, website + assistant, etc. I, Valentino M., offer full integration and/or + consultation services. +
+
+
+
+Boldwave
++ We implement voice agents to streamline appointment booking, enhance lead + conversion, and provide superior 24/7 customer service. +
+
+
+
+Brisk Logic
++ We are a AI Automation Agency that specializes in designing advanced AI + voice assistants capable of automating various tasks through phone + calls.{" "} +
+
+
+
+Cold-Calls.AI
++ We specialize in helping companies within the German market integrate + Voice Agents for both inbound and outbound calls. +
+
+
+Don't Run Off AI
+Telephone voice AI systems, prompt engineering, integrations
+
+
+
+Flowzen
++ Our agency offers Voice AI solutions using Vapi, in English and Spanish, + integrated with platforms like GoHighLevel, Airtable, and Make.com. +
+
+
+
+Globe AI
++ I'm Aryan, founder of Globe AI. We build Inbound Voice Assistants for any + industry at any scale. +
+
+
+
+INFLATE AI Automation Development Services
+Building voice systems for any industry from $3k USD minimum.
+
+
+
+Integraticus
++ We build AI appointment setters for Real Estate Agencies to qualify more + leads, handle tailored outreach, and make sure you have higher margins + than ever before. +
+
+
+
+Klen AI
++ Custom AI voice assistants to handle calls, pre-qualify leads, schedule + appointments, etc. Utilizing Vapi for seamless integration and + productivity +
+
+
+
+Lunaris AI
+We create Voice Agents for all types of businesses.
+
+
+
+Martech Studios
++ We are a US based B2B tech and marketing consultancy focused on building superior user experiences. We also love all things Audio AI (TTS) +
+
+
+
+NukyLabs.AI
+All Services for Vapi.ai Automation
+
+
+
+Otaku Solutions
++ Handle the creation of voice assistants, automations, tracking, and + training. +
+
+
+
+Shadow AI
++ Specializing in AI-powered inbound and outbound calling operations for all + types of businesses using industry expertise. +
+
+
+
+Synthiq
++ Multilingual AI Voice Agents (20+ countries). Any industry. Use your + existing number. Expert AI consulting available. +
+
+
+
+Temporal Labs LLC
++ Temporal Labs LLC offers a unique solution through our parametrized, + development community, with industry specific solutions and engagement. +
+
+
+
+Value Added Tech
++ Top-notch automation company. We specialise in Make.com (Silver partner), + multiple CRMs and Vapi. +
+
+
+
+Saidwell
++ Saidwell develops custom voice AI solutions for enterprises, offering bespoke software and high-quality human voice models. +
+
+
+
+iffort.ai
++ We revolutionize your business communication with our conversational agents, turning traditional chats and calls into effortless conversations. +
+
+
+
+Msquare Automation
++ Experts in AI voice assistants and business automation. Affordable, quality service from India. Gold partners of Make.com +
+
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+{" "}
+
+
+
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+Alternatively you can upload your files via the API.
+
+```bash
+curl --location 'https://api.vapi.ai/file' \
+--header 'Authorization: Bearer
+
+
+
+
+{" "}
+
+
+
+
+
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+
+
+
+
+
+
+
+
+
+## Send Us Your Video
+
+Have a video showcasing Vapi that you want us to feature? Let us know:
+
+