Skip to main content
POST
Upload text to synthesize audio

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request to upload text for audio synthesis.

audioPlaintext
string | null

Plain text to synthesize into audio

Example:

"Welcome to our facility"

audioSSML
string | null

SSML markup for audio synthesis

Example:

"<speak>Welcome to our facility</speak>"

description
string | null

Description of the audio clip

Example:

"A welcome message for visitors"

displayName
string | null

Display name for the audio clip

Example:

"Welcome Message"

voiceId
string | null

Voice ID for text-to-speech synthesis

Example:

"en-US-Neural2-F"

Response

200 - application/json

OK

Response from uploading text for audio synthesis.

encodingFailure
boolean | null

Indicates if audio encoding failed

Example:

false

error
boolean | null
errorMsg
string | null
invalidSSML
boolean | null

Indicates if SSML markup is invalid

Example:

false

synthesisFailure
boolean | null

Indicates if text-to-speech synthesis failed

Example:

false

uuid
string<RUUID> | null
RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

warningMsg
string | null
Last modified on August 3, 2026