liveTranscribe
Start, summarize, or stop live transcription on the call. Unlike
transcribe(), which
provides a post-call result, live transcription sends each utterance to your webhook as it is spoken.
The action object takes the same shape as the live_transcribe SWML method:
a single start, summarize, or stop key. Its keys are sent as written, in snake_case.
See also liveTranslate() for real-time translation, and the
transcribe calls guide for the webhook events.
Parameters
action
The action to perform. Set exactly one of start, summarize, or stop.
action.start
Start a live transcription session.
action.start.lang
The language to transcribe, such as "en-US".
action.start.direction
The sides of the call to transcribe: "remote-caller", "local-caller", or both.
action.start.webhook
The URL that receives transcription events as HTTP POST requests.
action.start.live_events
Whether to send each utterance to the webhook as it is transcribed.
action.start.ai_summary
Whether to send an AI summary of the conversation to the webhook when the session ends.
action.start.ai_summary_prompt
The prompt that tells the AI how to summarize the conversation when ai_summary is enabled.
action.start.speech_engine
The speech recognition engine: "deepgram" or "google".
action.start.speech_timeout
The timeout for speech recognition, in milliseconds.
action.start.vad_silence_ms
Voice activity detection silence time, in milliseconds. The default depends on the speech engine:
700 for Deepgram, 500 for Google. Omitting the value or setting it to 0 uses the engine default.
action.start.vad_thresh
Voice activity detection threshold, from 0 to 1800.
action.start.hints
Words or phrases that help speech recognition pick out specific terms, such as product names or industry jargon. Empty strings are ignored.
action.summarize
Request an AI summary of the conversation so far, while transcription continues. Pass an empty
object to send the summary to the webhook from start with the default summary prompt.
ai_summary_prompt applies only to the summary sent when the session ends.
action.summarize.webhook
The URL that receives the summary.
action.summarize.prompt
The prompt that tells the AI how to summarize the conversation.
action.stop
Stop the live transcription session. Pass an empty object.
Returns
Promise<Record<string, unknown>> — Server response confirming the operation.