curl --request POST \
--url https://api2.rhombussystems.com/api/audioplayback/uploadAudioText \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"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"
}
'import requests
url = "https://api2.rhombussystems.com/api/audioplayback/uploadAudioText"
payload = {
"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"
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
})
};
fetch('https://api2.rhombussystems.com/api/audioplayback/uploadAudioText', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/audioplayback/uploadAudioText")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"audioPlaintext\": \"Welcome to our facility\",\n \"audioSSML\": \"<speak>Welcome to our facility</speak>\",\n \"description\": \"A welcome message for visitors\",\n \"displayName\": \"Welcome Message\",\n \"voiceId\": \"en-US-Neural2-F\"\n}")
.asString();{
"encodingFailure": false,
"error": true,
"errorMsg": "<string>",
"invalidSSML": false,
"synthesisFailure": false,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA",
"warningMsg": "<string>"
}Upload text to synthesize audio
Upload text to synthesize audio
curl --request POST \
--url https://api2.rhombussystems.com/api/audioplayback/uploadAudioText \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"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"
}
'import requests
url = "https://api2.rhombussystems.com/api/audioplayback/uploadAudioText"
payload = {
"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"
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
})
};
fetch('https://api2.rhombussystems.com/api/audioplayback/uploadAudioText', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/audioplayback/uploadAudioText")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"audioPlaintext\": \"Welcome to our facility\",\n \"audioSSML\": \"<speak>Welcome to our facility</speak>\",\n \"description\": \"A welcome message for visitors\",\n \"displayName\": \"Welcome Message\",\n \"voiceId\": \"en-US-Neural2-F\"\n}")
.asString();{
"encodingFailure": false,
"error": true,
"errorMsg": "<string>",
"invalidSSML": false,
"synthesisFailure": false,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA",
"warningMsg": "<string>"
}Authorizations
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
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.
api-token, api, partner-api-token, partner-api Body
Request to upload text for audio synthesis.
Plain text to synthesize into audio
"Welcome to our facility"
SSML markup for audio synthesis
"<speak>Welcome to our facility</speak>"
Description of the audio clip
"A welcome message for visitors"
Display name for the audio clip
"Welcome Message"
Voice ID for text-to-speech synthesis
"en-US-Neural2-F"
Response
OK
Response from uploading text for audio synthesis.
Indicates if audio encoding failed
false
Indicates if SSML markup is invalid
false
Indicates if text-to-speech synthesis failed
false
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"