PUT rendition/…/preferences/tts/…

Submits the preferences to convert a text-to-speech.

Resource URL

https://www.drillster.com/api/2.1.1/rendition/{drillable}/preferences/tts/{language}

Parameters

Field Type Description
drillable
required
String The ID of the drill.

Example value: 06dkCv4mDVORJKlnwmyzng
language
required
String The language code of the voice to convert text to speech. Scheme: ISO 639-1

Example value: en
country
required
String The country code of the language.

Example value: AU
gender
required
String The gender of the voice, can be either MALE or FEMALE (case insensitive)

Example value: MALE
speed
required
String The speed of the voice, can be either SLOW, NORMAL or FAST (case insensitive)

Example value: SLOW

Response

A 2.1.1 TtsPreferences object, with the text-to-speech preferences.

Example request

PUT https://www.drillster.com/api/2.1.1/rendition/06dkCv4mDVORJKlnwmyzng/preferences/tts/en

Response

{
  "language":"en",
  "country":"AU",
  "gender":"FEMALE",
  "speed":"FAST"
}

Error responses

The following error situations are possible:

ID Response code Description
drill_not_found 404 (Not found) Drill does not exist in the system or is not in the repertoire of the requesting account
language_not_found 404 (Not found) The specified language was not found
no_country 400 (Bad request) A country code was not specified
no_gender 400 (Bad request) The voice gender was not specified
no_speed 400 (Bad request) The voice speed was not specified
invalid_country 400 (Bad request) An empty country code was provided
invalid_gender 400 (Bad request) A voice gender other than MALE or FEMALE was provided
invalid_speed 400 (Bad request) A voice speed other than SLOW, NORMAL or FAST was provided