NSns-api
Media/Text to Speech

Synthesize Voice (Text to Speech)

Changed on
post/domains/{domain}/users/{user}/voices

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/users/{user}/voices
  • Auth
    HTTP bearer

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
userstring required

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000

Request body

scriptstring required

This is a simple explanation of what the audio is and can include what is said in the audio file for explanation.

voice_languagestring

This is the language that can be requested when using TTS feature. Leave of to have API lookup configs from the defaults or domain specific configs.

voice_idstring

This value will allow you to select the voice to be used for TTS applications. Value must be valid or will cause errors. leave off request to have the API lookup defaults from system and/or domain.

Example request

{
  "voice_language": "en-US"
}

Response

string required
OR
integer required
OR
boolean required
OR
OR
object required
OR
number required

Changes

  • bce16087d479Revision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status