From 200229d442014dbecb89d46c82c8cda23026cd22 Mon Sep 17 00:00:00 2001 From: Quantstruct Bot Date: Fri, 20 Jun 2025 23:00:24 -0700 Subject: [PATCH 1/3] chore: add changelog for 2025-06-21 with OpenAPI diff and developer notes --- fern/changelog/2025-06-21.mdx | 42 +++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 fern/changelog/2025-06-21.mdx diff --git a/fern/changelog/2025-06-21.mdx b/fern/changelog/2025-06-21.mdx new file mode 100644 index 000000000..6051d66af --- /dev/null +++ b/fern/changelog/2025-06-21.mdx @@ -0,0 +1,42 @@ +--- +title: "Changelog – 2025-06-21" +description: "Vapi API and Workflow changes released on June 21, 2025." +--- + +# 2025-06-21 Changelog + +## Major Breaking Changes + +### Removal of Assistant, Tool, and Chat Schema Properties +- Numerous properties and schema paths have been **removed** from the API, including many related to `Assistant`, `AssistantOverrides`, `Chat`, `Workflow`, `Credential` types, and various `ServerMessage*` objects. This includes: + - Removal of background denoising and speech denoising plans from assistants and workflows + - Removal of several properties from credential objects (e.g., fallbackIndex, region) + - Significant reduction in `chat`-related properties from server message schemas + - Removal of API Request Tool discriminator mappings from multiple endpoints + - Removal of variable extraction plan, name patterns, and other properties from tool creation + +> **Action Required:** +> - If your integration relies on any of the removed properties or schemas, update your code to avoid referencing them. Calls using deprecated fields will now fail validation. + +### AssemblyAITranscriber and FallbackAssemblyAITranscriber +- The following properties were **removed**: `formatTurns`, `maxTurnSilence`, `wordFinalizationMaxWaitTime`, `endOfTurnConfidenceThreshold`, `minEndOfTurnSilenceWhenConfident`. + +## Additions + +### Workflow Enhancements +- New schema properties and definitions have been **added** for Workflows: + - `Workflow.model`: Now supports specifying a model at the workflow level. Accepts `WorkflowOpenAIModel` or `WorkflowAnthropicModel`. + - New edge condition types: `LogicEdgeCondition` and `FailedEdgeCondition` are now supported in workflow edges. `LogicEdgeCondition` uses a `liquid` template string for advanced branching. + +> **For Developers:** +> - You can now specify a model for the entire workflow, providing greater flexibility and control over LLM selection. +> - Use `LogicEdgeCondition` for complex, liquid-based conditional branching in workflow edges. + +## Migration Guidance +- Review all usage of removed properties and schemas, especially if you use advanced assistant, tool, or workflow customization features. +- Migrate workflow branching logic to use the new `LogicEdgeCondition` and `FailedEdgeCondition` schemas where applicable. +- Update your workflow definitions to optionally include the new `model` property for global LLM configuration. + +--- + +For questions or migration help, please reach out to the Vapi team or open an issue in the repository. From ef302b22957cdd1f6ebd03b8c7b66fd5be96e6d2 Mon Sep 17 00:00:00 2001 From: Quantstruct Bot Date: Sat, 21 Jun 2025 17:00:52 -0700 Subject: [PATCH 2/3] chore: add changelog for 2025-06-22 with new API and workflow features --- fern/changelog/2025-06-22.mdx | 45 +++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 fern/changelog/2025-06-22.mdx diff --git a/fern/changelog/2025-06-22.mdx b/fern/changelog/2025-06-22.mdx new file mode 100644 index 000000000..ae1d4420a --- /dev/null +++ b/fern/changelog/2025-06-22.mdx @@ -0,0 +1,45 @@ +--- +title: Changelog for 2025-06-22 +--- + +# Changelog — 2025-06-22 + +## Major API Additions + +- **Campaigns API**: New endpoints and schemas for managing outbound calling campaigns. This includes campaign lifecycle management (`/campaign`, `/campaign/{id}`), scheduling, customer lists, call statistics, and campaign status tracking. This enables orchestrating large-scale outbound calling via Vapi. +- **Credential Management**: New credential types supported for S3, GCP, Azure, Supabase, and Cloudflare. Each credential now supports fallback order (`fallbackIndex`) for robust artifact upload and storage. +- **New Tool Types**: + - **API Request Tool**: Added endpoints and schemas for defining API request tools, including custom function definitions, variable extraction plans, and retry/backoff strategies. + - **MCP Tool**: Added support for MCP (Model-Controlled Plugin) tools with protocol metadata. Webhook server precedence for tool calls is now well-defined. + +## Workflow & Assistant Enhancements + +- **Background Speech Denoising**: Assistants and workflows now support advanced background speech denoising via Krisp (Smart Denoising) and experimental Fourier denoising. Both can be enabled and configured independently or together. +- **Transcriber Updates**: Added Cartesia, AssemblyAI, and fallback plans for transcribers, including new configuration options (e.g., `formatTurns`, `maxTurnSilence`, `minEndOfTurnSilenceWhenConfident`). +- **Voice Model Improvements**: LMNTVoice and FallbackLMNTVoice now support language selection and improved fallback logic. +- **AssistantOverrides & WorkflowOverrides**: New properties for granular runtime overrides, including background denoising and credential injection. + +## Cost Tracking & Observability + +- **Cost Breakdown**: Calls and chats now include detailed cost breakdowns for each component (LLM, STT, TTS, transport, Vapi, analysis, etc.). +- **Langfuse Observability**: Workflows and assistants now support Langfuse for detailed trace and span tracking. + +## Minor Improvements & Fixes + +- **Compliance & Monitoring**: Workflows and assistants now support compliance plans (HIPAA etc.), monitoring plans for live listening/control, and improved webhook routing. +- **Artifact & Analysis Plans**: New schema properties for storing and configuring artifacts and analysis at both assistant and workflow levels. +- **ServerMessage Updates**: All server and client messages now consistently include `chat` and `call` objects for easier integration. +- **Parameter Extraction**: Variable extraction plans can now be attached to API Request tools, improving structured data extraction from tool results. + +## Breaking Changes + +- **Removed**: Deprecated properties in Workflow schemas (e.g., `model` at the workflow root level) have been removed. Ensure you use node-level model configuration. + +--- + +**Upgrade Guidance**: +- Review new credential management and denoising options for enhanced reliability and call quality. +- Update tool and workflow definitions to leverage new API Request and MCP tool capabilities. +- For custom integrations, ensure server endpoints handle new webhook payloads and cost breakdowns. + +For detailed API reference, see [OpenAPI Spec](../reference). From ea5da358651b2836760e401e533f249254e1b0b8 Mon Sep 17 00:00:00 2001 From: Quantstruct Bot Date: Sun, 22 Jun 2025 17:00:32 -0700 Subject: [PATCH 3/3] chore: add changelog for 2025-06-23 (breaking removals and migration guidance) --- fern/changelog/2025-06-23.mdx | 37 +++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 fern/changelog/2025-06-23.mdx diff --git a/fern/changelog/2025-06-23.mdx b/fern/changelog/2025-06-23.mdx new file mode 100644 index 000000000..f90168038 --- /dev/null +++ b/fern/changelog/2025-06-23.mdx @@ -0,0 +1,37 @@ +--- +title: Changelog for 2025-06-23 +--- + +# Changelog — 2025-06-23 + +## Breaking Removals + +- **Removed Properties and Paths:** + - The following schema properties have been removed: + - `assistantOverrides` from `Chat`, `CreateChatDTO`, `OpenAIResponsesRequest` + - `metadata` from `McpTool`, `CreateMcpToolDTO`, `UpdateMcpToolDTO` + - `callsCounterQueued`, `callsCounterScheduled`, `callsCounterInProgress`, `callsCounterEndedVoicemail` from `Campaign` + - `language` from `LMNTVoice`, `FallbackLMNTVoice` + - The following schema paths have been removed: + - `call.workflow.nodes[type=conversation].model` from `WorkflowCustomModel` and `WorkflowGoogleModel` + - All references to `assistant.voice`, `call.squad.members.assistant.voice`, `call.squad.members.assistantOverrides.voice`, `call.workflow.nodes[type=conversation].voice`, `call.workflow.voice` from `LMNTVoice` + - `assistant.voice.fallbackPlan.voices`, `call.squad.members.assistant.voice.fallbackPlan.voices` from `FallbackLMNTVoice` + - `assistant.model.tools[type=mcp]`, `call.squad.members.assistant.model.tools[type=mcp]`, `call.workflow.nodes[type=tool].tool` from `CreateMcpToolDTO` + +## Migration Guidance for Vapi Developers + +- **AssistantOverrides:** If you use `assistantOverrides`, migrate to the new override mechanism detailed in the latest documentation. Remove references from `Chat`, `CreateChatDTO`, and `OpenAIResponsesRequest`. +- **Metadata in MCP Tools:** If you store metadata in MCP tool definitions, move this data to a supported location or externalize as needed. +- **Campaign Counters:** If you rely on campaign-level counters for queued, scheduled, in-progress, or ended-voicemail calls, update your integration to use the new campaign tracking endpoints or analytics features. +- **Voice Language:** LMNTVoice and FallbackLMNTVoice schemas no longer support the `language` property; rely on the new voice configuration mechanisms. +- **Model Properties:** Workflow node-level configuration is now required for specifying models; root-level `model` properties are deprecated and removed. + +## General Notes + +- These changes are part of ongoing schema simplification and modularization. If you use removed properties, update your API requests and response handling accordingly. +- Review your assistant, campaign, and workflow definitions for deprecated usage and consult the [OpenAPI reference](../reference) for the latest schema. + +--- + +**Need help migrating?** +Reach out via the developer support channels or open an issue in the [vapi-docs repository](https://github.com/quantstruct/vapi-docs/issues).