Skip to main content
Get startedGuidesTechnical Reference

action.start

Start a live translation session.

action.start
objectrequired

An object that accepts 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.from_lang
stringrequired
Default: en

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

start.to_lang
stringrequired
Default: en

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

start.from_voice
string
Default: elevenlabs.josh

The TTS voice you want to use for the source language.
Learn more about our supported Voices & Languages here.

start.to_voice
string
Default: elevenlabs.josh

The TTS voice you want to use for the target language.
Learn more about our supported Voices & Languages here.

start.filter_from
string

Translation filter to apply to the source language direction. Adjusts the tone or style of translated speech.

Preset Values:

  • polite - Translates to a polite version, removing anything insulting while maintaining sentiment
  • rude - Translates to a rude and insulting version while maintaining sentiment
  • professional - Translates to sound professional, removing slang or lingo
  • shakespeare - Translates to sound like Shakespeare, speaking in iambic pentameter
  • gen-z - Translates to use Gen-Z slang and expressions

Custom: Use prompt: prefix for custom instructions (e.g., prompt:Use formal business language).

start.filter_to
string

Translation filter to apply to the target language direction. Adjusts the tone or style of translated speech.

Preset Values:

  • polite - Translates to a polite version, removing anything insulting while maintaining sentiment
  • rude - Translates to a rude and insulting version while maintaining sentiment
  • professional - Translates to sound professional, removing slang or lingo
  • shakespeare - Translates to sound like Shakespeare, speaking in iambic pentameter
  • gen-z - Translates to use Gen-Z slang and expressions

Custom: Use prompt: prefix for custom instructions.

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, AI-generated summaries in both languages will be sent to your webhook when the translation 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 translated.

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​

live_translate:
  action:
    start:
      webhook: 'https://example.com/webhook'
      from_lang: en-US
      to_lang: es-ES
      from_voice: elevenlabs.josh
      to_voice: elevenlabs.josh
      filter_from: professional
      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