Add changelog for 2025-09-29

[quantstruct-bot]

Description

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)

If you're currently using any of the removed endpoints or properties, you must migrate to the new alternatives before this release. Contact support if you need assistance with migration strategies.

Migration Guide

Replace /logs endpoint usage with call artifacts, monitoring plans, and end-of-call reports for comprehensive logging. Migrate from test-suite endpoints to the new evaluation system with mock conversations and comprehensive result tracking. Update model configurations to use the integrated knowledge base system instead of separate knowledgeBaseId references. Replace deprecated transcriber timing properties with smart endpointing plans for better conversation flow control.

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

Testing Steps

• Run the app locally using fern docs dev or navigate to preview deployment
• Ensure that the changed pages and code snippets work

[github-actions]

🌿 Preview your docs: https://vapi-preview-0935ec58-5ef8-4914-a50c-5e6cdeb200c5.docs.buildwithfern.com