VIvideogen
Tools

Text to speech

Changed on

Convert text into a spoken audio file. Only voices with supportsDirectToolExecution set to true can be used. Optionally choose a voice, language, speed, and pronunciation overrides.

post/v1/tools/text-to-speech

Request

  • Base URL
    https://api.videogen.io
  • Auth
    HTTP bearer

Request body

ttsTextstring required
voiceIdstring required

Catalog displayName (e.g. Matilda) or voice id from GET /v1/resources/tts-voices (e.g. vg_voic_...). Only voices with supportsDirectToolExecution set to true are accepted.

speechLanguageCodestring nullable

ISO-639-1 language hint for pronunciation (e.g. en, es, zh).

autoExpandPronunciationReplacementsboolean

When true, automatically expands numbers, symbols, acronyms, and other non-word tokens into their spoken forms before synthesis so the voice pronounces them correctly (e.g. $100 → one hundred dollars, NASA → nasa, 3rd → third). Defaults to false when omitted.

voiceSpeednumber

Speech rate multiplier, between 0.5 (half speed) and 2 (double speed). Defaults to the voice's default speed.

numResultsinteger

Number of output results to generate. Defaults to 1.

isOutputTemporaryboolean

When true, generated files are temporary. Temporary files are guaranteed to be available for 24 hours, after which they may be archived at any time. Temporary files are not analyzed (no description, transcript, or embedding will be generated), so they will not appear in search results. Defaults to false.

Response

Execution accepted; poll until complete.

toolExecutionIdstring required

Execution id (e.g. vg_tool_...).

Changes