Skip to main content
Get startedGuidesTechnical Reference

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 AI summarization.

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

Voice activity detection silence time in milliseconds.
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.summary_prompt
string

The prompt for summarization.

Example​

live_transcribe:
  action:
    start:
      webhook: 'https://example.com/webhook'
      lang: en
      live_events: true
      ai_summary: false
      speech_timeout: 30
      vad_silence_ms: 500
      vad_thresh: 0.6
      debug_level: 2
      direction:
        - remote-caller
        - local-caller
      speech_engine: default
      summary_prompt: Summarize this conversation