action.start

Start a live translation session.

action.start

objectrequired

An object that contains the start parameters.

start Parameters

start.webhook

string

The webhook URI to be called. Authentication can also be set in the url in the format of username:password@url.

start.lang

stringrequired

Default: en

The language to transcribe.
Learn more about our supported Voices & Languages here.

start.live_events

boolean

Default: false

Whether to enable live events.

start.ai_summary

boolean

Default: 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

integer

Default: 60000

The timeout for speech recognition.
Possible Values: [Minimum value: 1500, Maximum Value: None]

start.vad_silence_ms

integer

Default: 300 | 500

Voice activity detection silence time in milliseconds. Default depends on the speech engine: 300 for Deepgram, 500 for Google.
Possible Values: [Minimum value: 1, Maximum Value: None]

start.vad_thresh

integer

Default: 400

Voice activity detection threshold.
Possible Values: [Minimum value: 0, Maximum Value: 1800]

start.debug_level

integer

Default: 0

Debug level for logging.

start.direction

[]required

Default: local-caller

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

start.speech_engine

string

Default: 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."

Example

YAML

live_transcribe:
  action:
    start:
      webhook: 'https://example.com/webhook'
      lang: en
      live_events: true
      ai_summary: true
      ai_summary_prompt: Summarize this conversation
      speech_timeout: 60000
      vad_silence_ms: 500
      vad_thresh: 400
      debug_level: 0
      direction:
        - remote-caller
        - local-caller
      speech_engine: deepgram

JSON

{
  "live_transcribe": {
    "action": {
      "start": {
        "webhook": "https://example.com/webhook",
        "lang": "en",
        "live_events": true,
        "ai_summary": true,
        "ai_summary_prompt": "Summarize this conversation",
        "speech_timeout": 60000,
        "vad_silence_ms": 500,
        "vad_thresh": 400,
        "debug_level": 0,
        "direction": [
          "remote-caller",
          "local-caller"
        ],
        "speech_engine": "deepgram"
      }
    }
  }
}