Sign in
Audio

Convert Text to Audio

Available for: Chatflow, Workflow, Agent, Chatbot, Legacy Agent, Text Generator apps.

Converts text to speech audio. Pass text to synthesize arbitrary text, or message_id to voice an existing message's answer.

post/text-to-audio

Request body

message_idstring uuid

ID of the message whose answer to voice. Takes priority over text when both are provided. Get message IDs from List Conversation Messages.

textstring

Text to synthesize into speech.

userstring

End-user identifier, defined by your app and unique within it. See End User Identity.

voicestring

Voice to use for text-to-speech. Available voices depend on the TTS provider configured for this app. Use the voice value from Get App Parameters → text_to_speech.voice for the default.

streamingboolean

Accepted for backward compatibility but has no effect. Whether the audio is streamed is determined by the configured TTS provider's output, not by this field.

Response

Returns the generated audio. The Content-Type header reflects the provider's audio container, verified from the response bytes when recognizable.

The body can be AAC, FLAC, MP4, MP3, Ogg, WAV, or WebM. Output that cannot be recognized is labeled with the provider's declared type, or audio/mpeg when none is declared.

Streamed provider output is delivered with chunked transfer encoding; the request streaming field does not control this.

Changes

Changed in 1 of the 10 revisions of this API.6

  • f7ff0fd626996See the full diff
    • ○

      added the media type audio/aac for the response with the status 200

      response-media-type-added

    • ○

      added the media type audio/flac for the response with the status 200

      response-media-type-added

    • ○

      added the media type audio/mp4 for the response with the status 200

      response-media-type-added

    • ○

      added the media type audio/ogg for the response with the status 200

      response-media-type-added

    • ○

      added the media type audio/wav for the response with the status 200

      response-media-type-added

    • ○

      added the media type audio/webm for the response with the status 200

      response-media-type-added