Changelog

Breaking Changes & API Cleanup

1. Legacy Endpoint Removal: The following deprecated endpoints have been removed as part of our API modernization effort:

   • /logs - Use call artifacts and monitoring instead
   • /workflow/{id} - Access workflows through the main workflow endpoints
   • /test-suite and related paths - Replaced by the new evaluation system
   • /knowledge-base and related paths - Integrated into model configurations

2. Knowledge Base Architecture Change: The knowledgeBaseId property has been removed from all model configurations. This affects:

   • XaiModel, GroqModel, GoogleModel
   • OpenAIModel, AnthropicModel, CustomLLMModel
   • All other model provider configurations

3. Transcriber Property Deprecation: AssemblyAITranscriber.wordFinalizationMaxWaitTime and FallbackAssemblyAITranscriber.wordFinalizationMaxWaitTime are now deprecated:

   • Use smart endpointing plans for better speech timing control
   • More precise conversation flow management
   • Enhanced end-of-turn detection capabilities

4. Schema Path Cleanup: Removed numerous unused schema paths from model configurations to simplify the API structure and improve performance. This cleanup affects internal schema references but doesn’t impact your existing integrations.

5. New v2 API: We are introducing a new API version v2. These changes are part of our ongoing effort to:

   • Simplify the API structure for better developer experience
   • Remove redundant and deprecated functionality
   • Complete the transition to new evaluation and compliance systems
   • Improve API performance and maintainability

For details on the new features that replace these deprecated endpoints, see our recent changelog entries:

• Enhanced Authentication & Custom Credentials (Aug 30)
• Recording Consent & Compliance Management (Sep 2)
• Evaluation System Foundation (Sep 5)
• Evaluation Execution & Results Processing (Sep 28)

Migration Guide

Removed Endpoints

The following endpoints are no longer available:

• GET /logs - Use call artifacts instead
• GET /workflow/{id} - Use main workflow endpoints
• GET /test-suite, POST /test-suite - Use evaluation endpoints
• GET /test-suite/{id}, PUT /test-suite/{id}, DELETE /test-suite/{id} - Use evaluation management
• POST /test-suite/{testSuiteId}/run - Use evaluation runs
• GET /knowledge-base, POST /knowledge-base - Integrated into model configurations
• All related nested endpoints and operations

See Also:

• Authentication System Updates (Aug 30) - For credential management migration
• Recording Consent Features (Sep 2) - For compliance system details
• Enhanced Transcription (Sep 8) - For AssemblyAI timing alternatives

Evaluation Execution & Results Processing

1. Evaluation Execution Engine: Run comprehensive assistant evaluations with EvalRun and CreateEvalRunDTO. Execute your mock conversations against live assistants and squads to validate performance and behavior in controlled environments.

2. Multiple Evaluation Models: Choose from various AI models for LLM-as-a-judge evaluation:

   • EvalOpenAIModel: GPT models including GPT-4.1, o1-mini, o3, and regional variants
   • EvalAnthropicModel: Claude models with optional thinking features for complex evaluations
   • EvalGoogleModel: Gemini models from 1.0 Pro to 2.5 Pro for diverse evaluation needs
   • EvalGroqModel: High-speed inference models including Llama and custom options
   • EvalCustomModel: Your own evaluation models with custom endpoints

3. Evaluation Results: Comprehensive result tracking with EvalRunResult:

   • status: Pass/fail evaluation outcomes
   • messages: Complete conversation transcript from the evaluation
   • startedAt and endedAt: Precise timing information for performance analysis

4. Target Flexibility: Run evaluations against different targets:

   • EvalRunTargetAssistant: Test individual assistants with optional overrides
   • EvalRunTargetSquad: Evaluate entire squad performance and coordination

5. Evaluation Status Tracking: Monitor evaluation progress with detailed status information:

   • running: Evaluation in progress
   • ended: Evaluation completed
   • queued: Evaluation waiting to start
   • Detailed endedReason including success, error, timeout, and cancellation states

6. Judge Configuration: Optimize evaluation accuracy with model-specific settings:

   • maxTokens: Recommended 50-10000 tokens (1 token for simple pass/fail responses)
   • temperature: 0-0.3 recommended for LLM-as-a-judge to reduce hallucinations

Evaluation Capabilities

Voicemail Detection & Handling Improvements

1. Enhanced Beep Detection: Improve voicemail detection accuracy with CreateVoicemailToolDTO.beepDetectionEnabled specifically for Twilio-based calls. This feature detects the characteristic beep sound that indicates voicemail recording has started.

2. Workflow Voicemail Integration: Configure comprehensive voicemail handling in workflows with enhanced message and detection capabilities:

   • Workflow.voicemailMessage: Custom messages for voicemail scenarios (up to 1000 characters)
   • Workflow.voicemailDetection: Configurable detection methods for different providers

3. Assistant Voicemail Enhancement: Improved voicemail handling in assistant configurations with Assistant.voicemailMessage and Assistant.voicemailDetection for consistent behavior across all conversation types.

4. Multiple Detection Methods: Choose from various voicemail detection providers:

   • Google: GoogleVoicemailDetectionPlan for AI-powered detection
   • OpenAI: OpenAIVoicemailDetectionPlan for intelligent voicemail recognition
   • Twilio: TwilioVoicemailDetectionPlan for carrier-level detection
   • Vapi: VapiVoicemailDetectionPlan for integrated detection

5. Beep Detection for Call Flows: The new beep detection capability works specifically with Twilio transport, providing reliable voicemail identification when traditional detection methods may not be sufficient.

6. Voicemail Tool Configuration: Enhanced tool rejection and messaging capabilities ensure appropriate handling when voicemail is detected, with configurable responses based on your business requirements.

Voicemail Management Features

Advanced Analytics & Variable Grouping

1. Variable Value Analytics: Gain deeper insights into your assistant performance with AnalyticsQuery.groupByVariableValue. Group analytics data by specific variable values extracted during calls for granular performance analysis.

2. Enhanced Grouping Options: Use VariableValueGroupBy to specify custom grouping criteria:

   • key: The variable value key to group by (up to 100 characters)
   • Combine with existing grouping options like assistantId, endedReason, and status

3. Multi-Dimensional Analysis: Create complex analytics queries by combining traditional grouping fields with variable values:

   • Group by assistant performance AND custom business metrics
   • Analyze conversation outcomes by extracted data points
   • Track success rates across different variable value segments

4. Advanced Query Capabilities: Enhanced AnalyticsQuery functionality enables sophisticated data analysis:

   • Multiple grouping dimensions for comprehensive insights
   • Variable-based segmentation for business intelligence
   • Custom metric tracking through extracted call variables

5. Business Intelligence Integration: Connect your call data to business outcomes by grouping analytics on:

   • Customer satisfaction scores extracted from calls
   • Product interest levels determined during conversations
   • Lead qualification status gathered through assistant interactions
   • Custom KPIs specific to your business logic

Analytics Enhancements

Chat Transport & SMS Integration

1. Twilio SMS Transport: Send chat responses directly via SMS using TwilioSMSChatTransport in CreateChatDTO.transport. This enables programmatic SMS conversations with your voice assistants, bridging the gap between voice and text communication.

2. SMS Session Management: Create new sessions automatically when using SMS transport by providing:

   • customer: Customer information for SMS delivery
   • phoneNumberId: SMS-enabled phone number from your organization
   • Automatic session creation when both fields are provided

3. LLM-Generated vs Direct SMS: Control message processing with TwilioSMSChatTransport.useLLMGeneratedMessageForOutbound:

   • true (default): Input processed by assistant for intelligent responses
   • false: Direct message forwarding without LLM processing for notifications and alerts

4. Enhanced Chat Creation: CreateChatDTO now supports sophisticated session management:

   • transport: SMS delivery configuration
   • sessionId: Use existing session data
   • Mutual exclusivity between sessionId and transport fields for clear session boundaries

5. OpenAI Responses Integration: Streamlined chat processing with OpenAIResponsesRequest supporting the same transport and squad integration features for consistent API experience.

6. Cross-Platform Continuity: Seamlessly transition between voice calls and SMS conversations within the same session, maintaining context and conversation history across communication channels.

SMS Communication Features

API Versioning & Infrastructure Updates

1. API Version 2 Introduction: Access enhanced functionality through new versioned endpoints while maintaining full backward compatibility:

   • /v2/call: Enhanced call management with new features and improved response formats
   • /v2/phone-number: Advanced phone number management with extended capabilities

2. Enhanced Pagination: Improved pagination controls across all endpoints with PaginationMeta enhancements:

   • createdAtGe and createdAtLe: Date range filtering for creation timestamps
   • Better sorting and filtering options for large datasets
   • Enhanced metadata for pagination state management

3. Workflow Message Configuration: Customize voicemail handling in workflows with CreateWorkflowDTO.voicemailMessage and CreateWorkflowDTO.voicemailDetection for comprehensive call flow management.

4. Credential Integration: Seamless credential management across all workflow and assistant configurations with enhanced credentials.items.discriminator.mapping.custom-credential support.

5. Transport Infrastructure: Foundation for advanced communication channels with improved transport configuration and management capabilities.

Infrastructure Improvements

Squad Management & Session Enhancement

1. Squad-Based Sessions: Organize your assistants into collaborative teams with Session.squad and Session.squadId. Sessions can now be associated with squads for team-based conversation management and coordinated assistant behavior.

2. Squad Chat Integration: Enable squad-based chat conversations using Chat.squad and Chat.squadId. This allows multiple assistants to participate in or be aware of chat contexts for more sophisticated conversation handling.

3. Enhanced Session Creation: Create squad-enabled sessions with CreateSessionDTO.squad and CreateSessionDTO.squadId, enabling persistent conversation contexts across multiple assistants and interaction types.

4. Chat Management by Squad: Filter and organize chats by squad membership using GetChatPaginatedDTO.squadId for better conversation management and team-based analytics.

5. Session Management by Squad: Query sessions by squad association with GetSessionPaginatedDTO.squadId, providing team-based session organization and management capabilities.

6. Full Message History: Control conversation context retention with ArtifactPlan.fullMessageHistoryEnabled. When enabled, artifacts contain complete message history even after handoff context engineering, preserving full conversation flow for analysis.

7. Transfer Records: Track warm transfer details with Artifact.transfers, providing comprehensive records of transfer destinations, transcripts, and status information for multi-assistant conversations.

Team Collaboration Features

Voice Enhancements & Minimax Improvements

1. Minimax Voice Language Support: Enhance multilingual conversations with MinimaxVoice.languageBoost. Support for 40+ languages including:

   • Chinese and Chinese,Yue for Mandarin and Cantonese
   • English, Spanish, French, German, Japanese, Korean
   • Regional variants and specialized languages like Arabic, Hindi, Thai
   • auto mode for automatic language detection

2. Text Normalization: Improve number reading and formatting with MinimaxVoice.textNormalizationEnabled. When enabled, spoken numbers, dates, and formatted text are properly pronounced for natural-sounding conversations.

3. Enhanced Voice Caching: Voice responses are now cached by default with MinimaxVoice.cachingEnabled set to true, reducing latency for repeated phrases and improving overall conversation performance.

4. Fallback Voice Configuration: Ensure conversation continuity with FallbackMinimaxVoice featuring the same language boost and text normalization capabilities as the primary voice configuration.

5. Speaker Labeling: Track multiple speakers in conversations with BotMessage.speakerLabel, providing stable speaker identification (e.g., “Speaker 1”) for better conversation analysis and diarization.

6. Voice Region Support: Choose optimal performance regions with Minimax’s worldwide (default) or china regional settings for better latency and compliance with local regulations.

Voice Quality Features

Enhanced Transcription Features & Speech Processing

1. Gladia Transcription Enhancements: Improve transcription accuracy and performance with new GladiaTranscriber features:

   • region: Choose between us-west and eu-west for optimal latency and data residency compliance
   • receivePartialTranscripts: Enable low-latency streaming transcription for real-time conversation flow
   • Enhanced language detection with support for both single and multiple language modes

2. Advanced Deepgram Controls: Fine-tune speech recognition with enhanced DeepgramTranscriber settings:

   • eotThreshold: End-of-turn detection threshold for precise conversation boundaries (e.g., 0.7)
   • eotTimeoutMs: Maximum wait time for end-of-turn detection in milliseconds (e.g., 5000ms)
   • eagerEotThreshold: Early end-of-turn detection for responsive conversations (e.g., 0.3)

3. AssemblyAI Keyterms Enhancement: Boost recognition accuracy for critical terms with AssemblyAITranscriber.keytermsPrompt:

   • Support for up to 100 keyterms, each up to 50 characters
   • Improved recognition for specific words and phrases
   • Additional cost: $0.04/hour when enabled

4. Speechmatics Custom Vocabulary: Enhance recognition accuracy with SpeechmaticsCustomVocabularyItem:

   • content: The word or phrase to add (e.g., “Speechmatics”)
   • soundsLike: Alternative phonetic representations (e.g., [“speech mattix”]) for better pronunciation handling

5. Word-Level Confidence: Access detailed transcription confidence data with CustomLLMModel.wordLevelConfidenceEnabled, providing word-by-word accuracy metrics for quality assessment and debugging.

6. Enhanced Message Metadata: Store transcription confidence and other metadata in UserMessage.metadata, enabling detailed analysis of transcription quality and user speech patterns.

Transcription Improvements

Evaluation System Foundation

1. Evaluation Framework: You can now systematically test your Vapi voice assistants with the new Eval system. Create comprehensive test scenarios to validate assistant behavior, conversation flow, and tool usage through mock conversations.

2. Mock Conversation Builder: Design test conversations using Eval.messages with support for multiple message types:

   • ChatEvalUserMessageMock: Simulate user inputs and questions
   • ChatEvalSystemMessageMock: Inject system messages mid-conversation
   • ChatEvalToolResponseMessageMock: Mock tool responses for consistent testing
   • ChatEvalAssistantMessageEvaluation: Define evaluation checkpoints

3. Evaluation Types: Currently focused on chat.mockConversation type evaluations, with the framework designed to support additional evaluation methods in future releases.

4. Evaluation Management: Organize your tests with CreateEvalDTO and UpdateEvalDTO:

   • name: Descriptive names up to 80 characters (e.g., “Customer Support Flow Validation”)
   • description: Detailed descriptions up to 500 characters explaining the test purpose
   • messages: The complete mock conversation flow

5. Evaluation Endpoints: Access your evaluations through the new /eval endpoint family:

   • GET /eval: List all evaluations with pagination support
   • POST /eval: Create new evaluations
   • GET /eval/{id}: Retrieve specific evaluation details
   • PUT /eval/{id}: Update existing evaluations

6. Judge Plan Architecture: Define how assistant responses are validated using AssistantMessageJudgePlan with three evaluation methods:

   • Exact Match: AssistantMessageJudgePlanExact for precise content and tool call validation
   • Regex Pattern: AssistantMessageJudgePlanRegex for flexible pattern-based evaluation
   • AI Judge: AssistantMessageJudgePlanAI for intelligent evaluation using LLM-as-a-judge

Testing Capabilities