Wipple CPaaS
Menu
Functions / Synthesizer

Synthesizer

Parameters

vendorstringrequired

Name of the TTS vendor, or 'default' to use the application default.


voicestringrequired

Name of the voice to use for the TTS, or 'default' to use the application default.


enginestring

(Google specific) may be standard, neural, generative, or long-form.


genderstring

(Google specific) may be MALE, FEMALE, NEUTRAL.


labelstring

Label associated with the TTS vendor.


languagestring

Language code for the TTS, or 'default' to use the application default.


optionsobject

Vendor-specific options for the TTS, see below for supported properties.


Vendor-specific options

google

modelstring

The model to use for text-to-speech synthesis. When specified, this enables Gemini TTS. Example: gemini-2.5-flash-preview-tts.


apiModestring

Controls which Google TTS API mode to use. Possible values:

  • tts: Standard Google Cloud TTS voices (default).
  • live: HD voices using streaming mode for higher quality output.
  • gemini: Gemini TTS for AI-powered speech synthesis.

The mode is automatically selected based on configuration: if options.model is specified or a model_id is configured in the speech credentials, Gemini TTS is used. If an HD voice is selected, live mode is used. Otherwise, standard tts mode is used.


promptstring

A prompt sent to the TTS model to guide how the audio should be generated. Use this to specify the desired tone, emotion, speaking style, or context for the synthesized speech. This parameter is only applicable when using Gemini TTS (apiMode: "gemini" or when model is specified).


cartesia

voice_modestring

embedding or id (see Cartesia docs)


embeddingstring

a voice embedding (see Cartesia docs)


emotionstring

specifies emotion (see Cartesia docs)


speednumber

A number or named specifier (e.g "slow") (see Cartesia docs)


elevenlabs

stabilitynumber

Defines the stability for voice settings (see Elevenlabs docs)


similarity_boostnumber

Defines the similarity boost for voice settings. (see Elevenlabs docs)


use_speaker_boostboolean

Defines the use speaker boost for voice settings. This parameter is available on V2+ models (see Elevenlabs docs)


stylenumber

Defines the style for voice settings. This parameter is available on V2+ models. (see Elevenlabs docs)


model_idstring

Identifier of the model that will be used (see Elevenlabs docs)


playht

voice_enginestring

The voice engine used to synthesize the voice. (see Playht docs)


qualitystring

draft, low, medium, high, premium (see Playht docs)


seednumber

An integer number greater than or equal to 0. If equal to null or not provided, a random seed will be used. Useful to control the reproducibility of the generated audio. Assuming all other properties didn't change, a fixed seed should always generate the exact same audio file (see Playht docs)


temperaturenumber

A floating point number between 0, inclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice. (see Playht docs)


emotionstring

An emotion to be applied to the speech. Only supported when voice_engine is set to Play3.0-mini, PlayHT2.0 or PlayHT2.0-turbo, and voice uses that engine. (see Playht docs)


voice_guidancenumber

A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices. Higher numbers will maximize its individuality. Only supported when voice_engine is set to Play3.0-mini, PlayHT2.0 or PlayHT2.0-turbo, and voice uses that engine. (see Playht docs)


style_guidancenumber

A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance. Only supported when voice_engine is set to Play3.0-mini, PlayHT2.0 or PlayHT2.0-turbo, and voice uses that engine. (see Playht docs)


text_guidancenumber

A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text. Only supported when voice_engine is set to Play3.0-mini or PlayHT2.0, and voice uses that engine. (see Playht docs)


rimelabs

pauseBetweenBracketsboolean

When set to true, adds pauses between words enclosed in angle brackets. The number inside the brackets specifies the pause duration in milliseconds. Example: "Hi. \<200> I'd love to have a conversation with you." adds a 200ms pause between the first and second sentences. see Rimelabs docs


phonemizeBetweenBracketsboolean

When set to true, you can specify the phonemes for a word enclosed in curly brackets. see Rimelabs docs


inlineSpeedAlphastring

Comma-separated list of speed values applied to words in square brackets. Values \< 1.0 speed up speech, > 1.0 slow it down. Example: "This sentence is [really] [fast]" with inlineSpeedAlpha "0.5, 3" will make "really" slow and "fast" fast. see Rimelabs docs


speedAlphanumber

Adjusts the speed of speech. Lower than 1.0 is faster than default. Higher than 1.0 is slower than default. see Rimelabs docs


reduceLatencyboolean

Reduces the latency of response, at the cost of some possible mispronunciation of digits and abbreviations. see Rimelabs docs


murf

stylestring

The speaking style for the voice, e.g. Conversational (see Murf docs)


ratenumber

Adjusts the speaking rate. (see Murf docs)


pitchnumber

Adjusts the voice pitch. (see Murf docs)


variationnumber

Controls the amount of variation in pace, pitch and emphasis. (see Murf docs)


xai

Voices: eve (default), ara, leo, rex, sal.

Supported languages: auto, en, ar-EG, ar-SA, ar-AE, bn, zh, fr, de, hi, id, it, ja, ko, pt-BR, pt-PT, ru, es-MX, es-ES, tr, vi.

speednumber

Controls the speaking speed. A number between 0.7 and 1.5, inclusive. Defaults to 1.0.


optimize_streaming_latencynumber

Latency optimization level. 0 (default, no optimization), 1, or 2 (max latency reduction).


text_normalizationboolean

Enable text normalization (expands numbers, dates, abbreviations for more natural speech). Defaults to false.


with_timestampsboolean

Return word-level timestamps alongside audio. Supported on the STREAMING TTS path only (ignored for one-shot say synthesis). Defaults to false.


Note: xAI TTS supports both one-shot synthesis (via the say Function) and low-latency streaming TTS. It uses the same xAI API key credential that is used for xAI STT.

verbio

engine_versionstring

The engine version to use. (see Verbio docs)


whisper

model_idstring

TTS model to use. (see Whisper docs)