Methods

live_transcribe

View as Markdown

Start live transcription of the call. The transcription will be sent to the specified webhook URL.

Properties

live_transcribe
objectRequired

An object that accepts the following properties.

live_transcribe.action
string | objectRequired

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.

action.start
objectRequired

Start a live transcription session.

start.webhook
string

The URL to receive transcription events via HTTP POST. When live_events is enabled, partial results are sent as they occur. When ai_summary is enabled, a summary is sent when the session ends. Authentication can also be set in the URL in the format of username:password@url.

start.lang
stringRequired

The language to transcribe. See supported voices & languages.

start.live_events
booleanDefaults to false

Whether to enable live events.

start.ai_summary
booleanDefaults to false

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
integerDefaults to 60000

The timeout for speech recognition in milliseconds. Minimum value: 1500.

start.vad_silence_ms
integerDefaults to 300 | 500

Voice activity detection silence time in milliseconds. Default depends on the speech engine: 300 for Deepgram, 500 for Google. Minimum value: 1.

start.vad_thresh
integerDefaults to 400

Voice activity detection threshold. Range: 0 to 1800.

start.debug_level
integerDefaults to 0

Debug level for logging.

start.direction
string[]Required

The direction of the call that should be transcribed. Possible values: remote-caller, local-caller.

start.speech_engine
stringDefaults to deepgram

The speech recognition engine to use. Possible values: deepgram, google.

start.ai_summary_prompt
string

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.”

Examples

1version: 1.0.0

2sections:

3  main:

4    - answer: {}

5    - live_transcribe:

6        action:

7          start:

8            webhook: 'https://example.com/webhook'

9            lang: en

10            live_events: true

11            direction:

12              - remote-caller

13              - local-caller

14            speech_engine: deepgram