diff --git a/fern/changelog/2025-03-19.mdx b/fern/changelog/2025-03-19.mdx new file mode 100644 index 000000000..b4c5a23bb --- /dev/null +++ b/fern/changelog/2025-03-19.mdx @@ -0,0 +1,12 @@ + +# 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. \ No newline at end of file diff --git a/fern/changelog/2025-03-20.mdx b/fern/changelog/2025-03-20.mdx new file mode 100644 index 000000000..90a5eaf99 --- /dev/null +++ b/fern/changelog/2025-03-20.mdx @@ -0,0 +1,13 @@ +# 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. + + + Google Calendar Integration + + +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. \ No newline at end of file diff --git a/fern/changelog/2025-03-21.mdx b/fern/changelog/2025-03-21.mdx new file mode 100644 index 000000000..d749c4099 --- /dev/null +++ b/fern/changelog/2025-03-21.mdx @@ -0,0 +1,4 @@ + +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. \ No newline at end of file diff --git a/fern/changelog/2025-03-22.mdx b/fern/changelog/2025-03-22.mdx new file mode 100644 index 000000000..e4f64be76 --- /dev/null +++ b/fern/changelog/2025-03-22.mdx @@ -0,0 +1,6 @@ + +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. \ No newline at end of file diff --git a/fern/changelog/2025-03-23.mdx b/fern/changelog/2025-03-23.mdx new file mode 100644 index 000000000..612ba11a5 --- /dev/null +++ b/fern/changelog/2025-03-23.mdx @@ -0,0 +1,5 @@ +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. \ No newline at end of file diff --git a/fern/changelog/2025-03-27.mdx b/fern/changelog/2025-03-27.mdx new file mode 100644 index 000000000..4be50b2e9 --- /dev/null +++ b/fern/changelog/2025-03-27.mdx @@ -0,0 +1,7 @@ +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. \ No newline at end of file diff --git a/fern/changelog/2025-03-28.mdx b/fern/changelog/2025-03-28.mdx new file mode 100644 index 000000000..77a9d793c --- /dev/null +++ b/fern/changelog/2025-03-28.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). + + + Slack Tool + + + + Google Calendar Tool + + +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`. \ No newline at end of file diff --git a/fern/changelog/2025-03-29.mdx b/fern/changelog/2025-03-29.mdx new file mode 100644 index 000000000..9d22a4eea --- /dev/null +++ b/fern/changelog/2025-03-29.mdx @@ -0,0 +1,9 @@ +1. **Updated `Call.endedReason` with New Prefix** The `endedReason` codes now include a prefix `call.in-progress.error-`, standardizing error codes across schemas. This change requires you to update your code to use the new prefixed enum values when handling call termination reasons. + + The following specific `endedReason` values have been updated: + + | Old Value | New Value | + | --- | --- | + | `pipeline-no-available-llm-model` | `call.in-progress.error-pipeline-no-available-llm-model` | + | `assistant-did-not-receive-customer-audio` | `call.in-progress.error-assistant-did-not-receive-customer-audio` | + | `sip-telephony-provider-failed-to-connect-call` | `call.in-progress.error-sip-telephony-provider-failed-to-connect-call` | \ No newline at end of file diff --git a/fern/changelog/2025-03-30.mdx b/fern/changelog/2025-03-30.mdx new file mode 100644 index 000000000..7c13340b0 --- /dev/null +++ b/fern/changelog/2025-03-30.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. diff --git a/fern/changelog/2025-04-01.mdx b/fern/changelog/2025-04-01.mdx new file mode 100644 index 000000000..d4eddc29c --- /dev/null +++ b/fern/changelog/2025-04-01.mdx @@ -0,0 +1,8 @@ +1. **Introducing `SmsSendTool` for SMS messaging support**: Developers can now create and manage tools of type `sms` using the new `SmsSendTool` schema, enabling assistants to send SMS messages via defined servers. This allows integration of SMS sending capabilities into applications, enhancing communication options. + +2. **`sms` type added to discriminator mappings**: The `sms` tool type is now recognized in API endpoints, ensuring that `SmsSendTool`s are correctly processed during create, read, update, and delete operations. This enables seamless handling of SMS tools within existing API workflows. + The `sms` tool type is now recognized in API endpoints, ensuring that `SmsSendTool`s are correctly processed during create, read, update, and delete operations. This enables seamless handling of SMS tools within existing API workflows. + +3. **New configuration options for voice and transcriber settings**: The `autoMode` property has been added to `ElevenLabsVoice` schemas, letting developers control automatic voice settings. Additionally, `confidenceThreshold` has been introduced in transcriber schemas, allowing developers to set thresholds to discard low-confidence transcriptions and improve accuracy. + +4. **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 provides developers with more precise control over speed settings for better customization. \ No newline at end of file diff --git a/fern/changelog/2025-04-02.mdx b/fern/changelog/2025-04-02.mdx new file mode 100644 index 000000000..4420d18e1 --- /dev/null +++ b/fern/changelog/2025-04-02.mdx @@ -0,0 +1,3 @@ +1. **Introduction of `mcp` Tool Type**: Developers can now create and manage [MCP tools](https://api.vapi.ai/api#:~:text=McpTool), enabling customized interactions with specific tools, prompts, and resources in their applications. The new `mcp` tools can be configured using properties like `async`, `server`, `function`, and `messages` to control their behavior. + +2. **Simplification of `Knowledge Base`**: The `model` property in the [`Knowledge Base`](https://api.vapi.ai/api#:~:text=KnowledgeBase) is now optional and changed from an object to a string, simplifying its use. You should update your Assistant configuration to treat `model` as a simple string identifier and adjust accordingly. \ No newline at end of file diff --git a/fern/changelog/2025-04-03.mdx b/fern/changelog/2025-04-03.mdx new file mode 100644 index 000000000..e073411aa --- /dev/null +++ b/fern/changelog/2025-04-03.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. \ No newline at end of file diff --git a/fern/changelog/2025-04-04.mdx b/fern/changelog/2025-04-04.mdx new file mode 100644 index 000000000..f90530d0d --- /dev/null +++ b/fern/changelog/2025-04-04.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. \ No newline at end of file diff --git a/fern/changelog/2025-04-05.mdx b/fern/changelog/2025-04-05.mdx new file mode 100644 index 000000000..742d6ee63 --- /dev/null +++ b/fern/changelog/2025-04-05.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. + + + SmsSendTool + + +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. \ No newline at end of file diff --git a/fern/changelog/2025-04-08.mdx b/fern/changelog/2025-04-08.mdx new file mode 100644 index 000000000..e6896d434 --- /dev/null +++ b/fern/changelog/2025-04-08.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. + + + The `Transport` schema is now deprecated and will be removed in a future release. + + +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`. \ No newline at end of file diff --git a/fern/changelog/2025-04-11.mdx b/fern/changelog/2025-04-11.mdx new file mode 100644 index 000000000..a67283eab --- /dev/null +++ b/fern/changelog/2025-04-11.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. + + + AI Edge Condition with Prompt + + +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. \ No newline at end of file diff --git a/fern/changelog/2025-04-12.mdx b/fern/changelog/2025-04-12.mdx new file mode 100644 index 000000000..a67283eab --- /dev/null +++ b/fern/changelog/2025-04-12.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. + + + AI Edge Condition with Prompt + + +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. \ No newline at end of file diff --git a/fern/changelog/2025-04-15.mdx b/fern/changelog/2025-04-15.mdx new file mode 100644 index 000000000..5ceb1541b --- /dev/null +++ b/fern/changelog/2025-04-15.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. + + + New GPT-4.1 Models Available + diff --git a/fern/static/images/.DS_Store b/fern/static/images/.DS_Store index 462fd53e5..2327efe12 100644 Binary files a/fern/static/images/.DS_Store and b/fern/static/images/.DS_Store differ diff --git a/fern/static/images/changelog/ai-edge-condition-prompt.png b/fern/static/images/changelog/ai-edge-condition-prompt.png new file mode 100644 index 000000000..2a4383479 Binary files /dev/null and b/fern/static/images/changelog/ai-edge-condition-prompt.png differ diff --git a/fern/static/images/changelog/google-calendar-integration.png b/fern/static/images/changelog/google-calendar-integration.png new file mode 100644 index 000000000..84fbd34f8 Binary files /dev/null and b/fern/static/images/changelog/google-calendar-integration.png differ diff --git a/fern/static/images/changelog/google-calendar-tool.png b/fern/static/images/changelog/google-calendar-tool.png new file mode 100644 index 000000000..b39d95c90 Binary files /dev/null and b/fern/static/images/changelog/google-calendar-tool.png differ diff --git a/fern/static/images/changelog/gpt-4.1-models.png b/fern/static/images/changelog/gpt-4.1-models.png new file mode 100644 index 000000000..dead722ef Binary files /dev/null and b/fern/static/images/changelog/gpt-4.1-models.png differ diff --git a/fern/static/images/changelog/send-text-tool.png b/fern/static/images/changelog/send-text-tool.png new file mode 100644 index 000000000..d51875e59 Binary files /dev/null and b/fern/static/images/changelog/send-text-tool.png differ diff --git a/fern/static/images/changelog/slack-tool.png b/fern/static/images/changelog/slack-tool.png new file mode 100644 index 000000000..999128319 Binary files /dev/null and b/fern/static/images/changelog/slack-tool.png differ