live_transcribe
live_transcribe
Start live transcription of the call. The transcription will be sent to the specified webhook URL. The transcribe calls guide walks through a first call, the webhook events, and AI summaries.
For whole-call transcription delivered after the call ends, see transcribe.
Properties
live_transcribe
An object that accepts the following properties.
live_transcribe.action
The action to perform. See actions below.
Actions
The action property controls the transcription session. Use start to begin transcribing with configuration options, stop to end an active session, or summarize to request an on-demand AI summary mid-session.
start
stop
summarize
action.start
Start a live transcription session.
start.webhook
The URL to receive transcription events via HTTP POST.
When live_events is enabled, each utterance is sent as soon as it’s transcribed.
When the session ends, the whole conversation is sent, with a summary when ai_summary is enabled.
See Webhooks for the events.
Authentication can also be set in the URL in the format of username:password@url.
start.lang
The language to transcribe. See supported voices & languages.
start.live_events
Whether to enable live events.
start.ai_summary
Whether to enable automatic AI summarization. When enabled, an AI-generated summary of the conversation will be sent to your webhook when the transcription session ends.
start.speech_timeout
The timeout for speech recognition in milliseconds. Minimum value: 1500.
start.vad_silence_ms
Voice activity detection silence time in milliseconds.
Default depends on the speech engine: 700 for Deepgram, 500 for Google. Omitting the value or setting it to 0 uses the engine default.
start.vad_thresh
Voice activity detection threshold. Range: 0 to 1800.
Setting it to 0 uses the default of 400 rather than a zero threshold.
start.debug_level
Debug level for logging.
start.direction
The direction of the call that should be transcribed. Possible values: remote-caller, local-caller.
Also accepts a SWML variable reference for the whole array or for each item; the resolved values must be one of the possible values.
start.speech_engine
The speech recognition engine to use. Possible values: deepgram, google.
Also accepts a SWML variable reference that resolves to one of these values.
start.ai_summary_prompt
The AI prompt that instructs how to summarize the conversation when ai_summary is enabled.
This prompt is sent to an AI model to guide how it generates the summary.
Example: “Summarize the key points and action items from this conversation.”
start.hints
Words or phrases that help speech recognition pick out specific terms, such as product names or industry jargon. Each hint is a plain string; empty strings are ignored. Also accepts a SWML variable reference that resolves to an array of hints.
Examples
Start
Stop
Summarize
Webhooks
Every event arrives as an HTTP POST to the webhook URL. Read channel_data.content_disposition to tell them apart:
transcribe.utterance: one utterance, sent whenlive_eventsis enabled. See Live transcription utterance webhook.transcribe.live_summarize: the summary requested withsummarize. See Live transcription summary webhook.transcribe.conversation_log: the whole conversation, sent once when the session ends. See Live transcription conversation log webhook.