Text to Speech

Generate speech audio from a prompt when a trigger or event occurs and save locally or play via SIP.

Text to Speech

This node generates an audio file from a text prompt when a trigger or event occurs. The audio is saved locally on the filesystem, and the node outputs metadata indicating whether a new audio file was generated.

Properties

PropertyDescriptionTypeDefaultRequired
trigger_sourceUse built-in events from upstream nodes or a custom trigger expression.enumcustomYes
triggerTrigger condition expression when trigger_source is custom.trigger-conditionnullYes (custom trigger)
intervalMinimum time between consecutive generations in seconds.float10No
enabledEnable/disable audio generation.booltrueNo
prompt_sourceUse a static prompt or metadata path.enumstaticYes
prompt_textStatic prompt text when prompt_source is static.text""No
prompt_metadata_pathComma-separated metadata paths to extract prompt text when prompt_source is metadata_path. Supports dot paths and * wildcards.string""No
tts_providerTTS provider to use. Lumeo Cloud (lumeo), Eleven Labs (elevenlabs)enumlumeoYes
lumeo_voice_idVoice selection when using Lumeo provider.enummaleYes (Lumeo)
elevenlabs_api_keyElevenLabs API key.stringnullYes (ElevenLabs)
elevenlabs_voice_idElevenLabs voice ID.string""Yes (ElevenLabs)
elevenlabs_model_idElevenLabs model ID.stringeleven_multilingual_v2No
audio_formatAudio output format.enummp3No
sip_enabledPlay generated audio to a SIP endpoint via RTP.boolfalseNo
sip_ipSIP endpoint IP address.string""Yes (when SIP enabled)
sip_portSIP port on the endpoint.number5060No
sip_usernameSIP user/extension on the endpoint.string51No
sip_passwordSIP password (optional, reserved for future digest auth).string""No

When SIP output is enabled, audio format is automatically forced to WAV. The node establishes a SIP call to the endpoint, streams the audio as G.711 u-law over RTP, then terminates the call.

Output Metadata

This node appends metadata under nodes.<node_id>:

  • audio_generated_delta: true when a new audio file was generated on this frame.
  • audio_filepath: absolute path to the saved audio file when generation succeeds.