API Enhancements, Call Features, and Workflow Improvements
-
POSTrequests to/analytics(migrate fromGET): You should now makePOSTrequests (instead ofGET) to the/analyticsendpoint. Structure your analytics query as a JSON payload usingAnalyticsQueryin the request body. -
Use
SayHookto Intercept and Modify Text for Assistant Speech: You can useSayHookto intercept and modify text before it’s spoken by your assistant. Specify the text to be spoken using theexactorpromptproperties. -
Call Transfer Support: The
Transfernode type is now available in workflows. Configure thedestinationproperty to define the transfer target. -
Workflow Edge Condition Updates:
AIEdgeCondition(which replacesSemanticEdgeCondition) enables AI-powered routing decisions by analyzing conversation context and intent, whileLogicEdgeCondition(which replacesProgrammaticEdgeCondition) allows for rule-based routing using custom logical expressions. The previousSemanticEdgeConditionandProgrammaticEdgeConditionare now deprecated, and a newFailedEdgeConditionhas been added to handle node failures in workflows. -
GatherNode: Data Collection Refactor: TheGathernode now requires anoutputproperty to define the expected data schema. Theinstructionandschemaproperties have been removed. -
Call Packet Capture (PCAP) Configuration: Your call
Artifacts now support links to download a call’s network packet capture (PCAP) file, providing you with detailed network traffic analysis and troubleshooting for calls. PCAP is only supported byvapiandbyo-phone-numberproviders. Enable PCAP throughpcapEnabled, automatically upload to S3 bucket withpcapS3PathPrefix, and access viapcapUrl. -
ApiRequestNode Improvements:ApiRequestnow supportsGETrequests. You can also define the expected response schema. You can make API requests asblockingor run in thebackgroundwithApiRequest.mode. -
CallandServerMessageendedReasonUpdates: Theassistant-not-invalidCall.endedReasonhas been corrected to"assistant-not-valid". Also added"assistant-ended-call-with-hangup-task"to theCall.endedReason. -
New Azure OpenAI Model
gpt-4o-2024-08-06-ptu: You can now usegpt-4o-2024-08-06-ptufrom Azure OpenAI inside your Assistant.

- Deprecated Schemas and Properties: The following properties and schemas are now deprecated in the API reference:
SemanticEdgeConditionProgrammaticEdgeConditionWorkflow.typeApiRequest.waitTaskMessageApiRequest.startTaskMessageApiRequest.failureTaskMessageApiRequest.successTaskMessageOpenAIModel.semanticCachingEnabledCreateWorkflowDTO.type