AudioPlayback Webservice

Upload text to synthesize audio

Upload text to synthesize audio

post/api/audioplayback/uploadAudioText

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/audioplayback/uploadAudioText
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

audioPlaintextstring nullable

Plain text to synthesize into audio

audioSSMLstring nullable

SSML markup for audio synthesis

descriptionstring nullable

Description of the audio clip

displayNamestring nullable

Display name for the audio clip

voiceIdstring nullable

Voice ID for text-to-speech synthesis

Example request

{
  "audioPlaintext": "Welcome to our facility",
  "audioSSML": "<speak>Welcome to our facility</speak>",
  "description": "A welcome message for visitors",
  "displayName": "Welcome Message",
  "voiceId": "en-US-Neural2-F"
}

Response

OK

encodingFailureboolean nullable

Indicates if audio encoding failed

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
invalidSSMLboolean nullable

Indicates if SSML markup is invalid

synthesisFailureboolean nullable

Indicates if text-to-speech synthesis failed

uuidstring RUUID nullable

base 64 (url-safe) uuid string

warningMsgstring nullable

Example response

{
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

No recorded changes to this operation across all 1 revision of this API.