Skip to main content
post/text-to-audio
Request example
Response
post/text-to-audio

Authorization

Authorizationstringheaderrequired#

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Body

application/json
message_idstring#
ID of the message whose answer to voice. Takes priority over text when both are provided. Get message IDs from List Conversation Messages.
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.
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.

Responses

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.