Template

Converts text to speech

Replaces "AVRCMSService/Common/AdminConvertTextToSpeech" service. VoiceId: https://docs.aws.amazon.com/polly/latest/dg/API_Voice.html Added Support for 'SSML', set isSSML to true and ensure that in 'Text', its wrapped with 'speech' tag for it to work.

post/Template/ConvertTextToSpeech

Request

Base URL
https://api.eon-xr.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/eon-xr/apis/eonxr-api/docs/Template/ConvertTextToSpeech/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

X-Versionstring

Request body

lessonIdinteger required

Lesson identifier

instituteIdinteger required

Institute identifier

voiceIdinteger required

Voice (accent) identifier

speechTextstring required

Text to be converted to audio

isSSMLboolean

Use Speech Synthesis Markup Language (SSML) (note Text passed must include SSML syntax for it to work)

Example request

{
  "lessonId": 10001,
  "instituteId": 1,
  "voiceId": 11,
  "speechText": "Hello. Do you speak a foreign language? One language is never enough."
}

Response

Success

fileUrlstring nullable

File url to the converted and uploaded audio (signed)

objKeystring nullable

Object key of the saved TTS file, to be saved in lesson.json

Changes

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