Synthesizer HTTP API

https://tts.api.nuance.com/api/v1/

CLIENT_ID=<Mix client ID>
SECRET=<Mix client secret>
CLIENT_ID=${CLIENT_ID//:/%3A}

export MY_TOKEN="`curl -s -u $CLIENT_ID:$SECRET \
https://auth.crt.nuance.com/oauth2/token \
-d 'grant_type=client_credentials' -d 'scope=tts' \
| jq -j .access_token`"

source get-token.sh

curl -H "Authorization: Bearer $MY_TOKEN" \
https://tts.api.nuance.com/api/v1/voices \
-d '{ "voice": { "name": "Evan" } }'

{
 "voices": [
  {
   "name": "Evan",
   "model": "enhanced",
   "language": "en-us",
   "ageGroup": "ADULT",
   "gender": "MALE",
   "sampleRateHz": 22050,
   "languageTlw": "enu",
   "restricted": false,
   "version": "1.1.1",
   "foreignLanguages": []
  }
 ]
}

GET https://tts.api.nuance.com/api/v1/voices

curl -H "Authorization: Bearer $MY_TOKEN" https://tts.api.nuance.com/api/v1/voices

{
 "voices": [
  {
   "name": "Allison",
   "model": "standard",
   "language": "en-us",
   "ageGroup": "ADULT",
   "gender": "FEMALE",
   "sampleRateHz": 22050,
   "languageTlw": "enu",
   "restricted": false,
   "version": "5.2.3.12283",
   "foreignLanguages": []
  },
  {
   "name": "Allison",
   "model": "standard",
   "language": "en-us",
   "ageGroup": "ADULT",
   "gender": "FEMALE",
   "sampleRateHz": 8000,
   "languageTlw": "enu",
   "restricted": false,
   "version": "5.2.3.12283",
   "foreignLanguages": []
  },
  {
   "name": "Ava-Ml",
   "model": "enhanced",
   "language": "en-us",
   "ageGroup": "ADULT",
   "gender": "FEMALE",
   "sampleRateHz": 22050,
   "languageTlw": "enu",
   "restricted": false,
   "version": "3.0.1",
   "foreignLanguages": [
    "es-mx"
   ]
  },
  {
   "name": "Chloe",
   "model": "standard",
   "language": "en-us",
   "ageGroup": "ADULT",
   "gender": "FEMALE",
   "sampleRateHz": 22050,
   "languageTlw": "enu",
   "restricted": false,
   "version": "5.2.3.15315",
   "foreignLanguages": []
  },
. . .

curl -H "Authorization: Bearer $MY_TOKEN" \
https://tts.api.nuance.com/api/v1/voices -d '{ "voice": { "name": "evan" } }'

{
 "voices": [
  {
   "name": "Evan",
   "model": "enhanced",
   "language": "en-us",
   "ageGroup": "ADULT",
   "gender": "MALE",
   "sampleRateHz": 22050,
   "languageTlw": "enu",
   "restricted": false,
   "version": "1.1.1",
   "foreignLanguages": []
  }
 ]
}

curl -H "Authorization: Bearer $MY_TOKEN" \
https://tts.api.nuance.com/api/v1/voices -d '{ "voice": { "language": "fr-ca" } }'

{
 "voices": [
  {
   "name": "Amelie-Ml",
   "model": "enhanced",
   "language": "fr-ca",
   "ageGroup": "ADULT",
   "gender": "FEMALE",
   "sampleRateHz": 22050,
   "languageTlw": "frc",
   "restricted": false,
   "version": "2.1.1",
   "foreignLanguages": [
    "en-us",
    "en-gb",
    "es-mx"
   ]
  },
  {
   "name": "Chantal",
   "model": "standard",
   "language": "fr-ca",
   "ageGroup": "ADULT",
   "gender": "FEMALE",
   "sampleRateHz": 22050,
   "languageTlw": "frc",
   "restricted": false,
   "version": "2.1.0",
   "foreignLanguages": []
  },
  {
   "name": "Nicolas",
   "model": "standard",
   "language": "fr-ca",
   "ageGroup": "ADULT",
   "gender": "MALE",
   "sampleRateHz": 22050,
   "languageTlw": "frc",
   "restricted": false,
   "version": "2.0.0",
   "foreignLanguages": []
  }
 ]
}

POST https://tts.api.nuance.com/api/v1/synthesize

curl -H "Authorization: Bearer $MY_TOKEN" \
https://tts.api.nuance.com/api/v1/synthesize \
-d '{ "voice": { "name": "Evan", "model": "enhanced" }, "input": { "text": { "text": "This is a test. A very simple test."} } }'

{
  "voice":{
    "name":"Evan",
    "model":"enhanced"
  },
  "input":{
    "text":{
      "text":"This is a test. A very simple test."
    }
  }
}

{
  "voice":{
    "name":"Evan",
    "model":"enhanced"
  },
  "input":{
    "text":{
      "text":"This is a test. A very simple test."
    }
  },
  "audio_params":{
    "audio_format":{
      "ogg_opus":{
        "sample_rate_hz":16000
      }
    },
    "volume_percentage": 100,
    "speaking_rate_factor": 1.2,
    "target_audio_length_ms": 10
  }
}

{
  "voice":{
    "name":"Evan",
    "model":"enhanced"
  },
  "input":{
    "text":{
      "text":"This is a test. A very simple test."
    }
  },
  "audio_params":{
    "audio_format":{
      "pcm":{
        "sample_rate_hz": 16000
      }
    }
  }
}

{
  "voice":{
    "name":"Evan",
    "model":"enhanced"
  },
  "input":{
    "text":{
      "text":"This is a test. A very simple test."
    }
  },
  "audio_params":{
    "audio_format":{
      "alaw":{}
    }
  }
}

{
  "voice":{
    "name":"Evan",
    "model":"enhanced"
  },
  "input":{
    "text":{
      "text":"This is a test. A very simple test."
    }
  },
  "audio_params":{
    "audio_format":{
      "ulaw":{}
    }
  }
}

{
  "voice":{
    "name":"Evan",
    "model":"enhanced"
  },
  "input":{
    "text":{
      "text":"This is a test. A very simple test."
    }
  },
  "audio_params":{
    "audio_format":{
      "ogg_opus":{
        "sample_rate_hz":16000
      }
    }
  }
}

{
  "voice":{
    "name":"Evan",
    "model":"enhanced"
  },
  "input":{
    "text":{
      "text":"This is a test. A very simple test."
    }
  }
}

{
  "voice": {
    "name": "Evan",
    "model": "enhanced"
  },
  "input": {
    "ssml": {
      "text": "<speak>This is an SSML test. A super simple test.</speak>"
    }
  }
}

{
  "voice": {
    "name": "Evan",
    "model": "enhanced"
   },
  "input": {
    "text": {
      "text": "This is a test. A very simple test."
    }
  },
  "event_params": {
        "send_log_events" true,
        "send_sentence_marker_events": true,
        "send_word_marker_events": true
  }
}

curl -H "Authorization: Bearer $MY_TOKEN" \
https://tts.api.nuance.com/api/v1/synthesize \
-d '{ "voice": { "name": "Evan", "model": "enhanced" }, "input": { "text": { "text": "This is a test. A very simple test."} } }'

{
  "status": {
    "code": 200,
    "message": "OK",
    "details": ""
  },
  "audio": "AAAAAAAAA... (synthesized audio in base64 format)"
}

#!/usr/bin/env python3

import requests as req
import base64
import os
import argparse

global args

# Generates the .wav file header for a given set of parameters
def generate_wav_header(sampleRate, bitsPerSample, channels, datasize, formattype):
    # (4byte) Marks file as RIFF
    o = bytes("RIFF", 'ascii')
    # (4byte) File size in bytes excluding this and RIFF marker
    o += (datasize + 36).to_bytes(4, 'little')
    # (4byte) File type
    o += bytes("WAVE", 'ascii')
    # (4byte) Format Chunk Marker
    o += bytes("fmt ", 'ascii')
    # (4byte) Length of above format data
    o += (16).to_bytes(4, 'little')
    # (2byte) Format type (1 - PCM)
    o += (formattype).to_bytes(2, 'little')
    # (2byte) Will always be 1 for TTS
    o += (channels).to_bytes(2, 'little')
    # (4byte)
    o += (sampleRate).to_bytes(4, 'little')
    o += (sampleRate * channels * bitsPerSample // 8).to_bytes(4, 'little')  # (4byte)
    o += (channels * bitsPerSample // 8).to_bytes(2,'little')               # (2byte)
    # (2byte)
    o += (bitsPerSample).to_bytes(2, 'little')
    # (4byte) Data Chunk Marker
    o += bytes("data", 'ascii')
    # (4byte) Data size in bytes
    o += (datasize).to_bytes(4, 'little')

    return o

token = os.getenv('MY_TOKEN')

parser = argparse.ArgumentParser(description='TTS HTTP Client')

options = parser.add_argument_group("options")
options.add_argument("--wav", action="store_true",
                     help="Save audio file in WAVE format")
options.add_argument("--voice", nargs="?",
                     help="Voice name (default=Evan)", default="Evan")
options.add_argument("--model", nargs="?",
                     help="Voice model type (default=enhanced)", default="enhanced")
options.add_argument("--type", nargs="?",
                     help="Input type: text or ssml (default=text)", default="text")
options.add_argument("--input", nargs="?",
                     help="Input text (default=This is a test)", default="This is a test.")

args = parser.parse_args()

http_headers = {}
http_headers['Authorization'] = "Bearer {}".format(token)

formatted_data = '{{ "voice": {{ "name": "{voice_name}", "model": "{model_name}" }}, "input": {{ "{input_type}": {{ "text": "{input_text}"}} }} }}'.format(voice_name=args.voice, model_name=args.model, input_type=args.type, input_text=args.input)

response = req.post('https://tts.api.nuance.com/api/v1/synthesize', data=formatted_data, headers=http_headers)

if response.status_code != 200:
    raise Exception("Failed to synthesize. Status: {}".format(response.status_code))

json_response = response.json()

if json_response["status"]["code"] != 200:
    print("Failed to synthesize. Message: {}. Status: {}".format(json_response["status"]["message"], json_response["status"]["code"]))
else:
    decoded_audio_response = base64.b64decode(json_response["audio"])

    waveheader = generate_wav_header(22050, 16, 1, len(decoded_audio_response), 1)

    if response.status_code == 200:
        if args.wav:
            with open("output.wav","wb") as output_file:
                output_file.seek(0, 0)
                output_file.write(waveheader)
                output_file.seek(0, 2)
                output_file.write(decoded_audio_response)
                print("Audio successfully written to", output_file.name)
        else:
            with open("output.raw", "wb") as output_file:
                output_file.write(decoded_audio_response)
                print("Audio successfully written to", output_file.name)

python3 http-wav-client.py --help

usage: http-wav-client.py [-h] [--wav] [--voice [VOICE]] [--model [MODEL]] [--type [TYPE]] [--input [INPUT]]

TTS HTTP Client

options:
  -h, --help       show this help message and exit

options:
  --wav            Save audio file in WAVE format
  --voice [VOICE]  Voice name (default=Evan)
  --model [MODEL]  Voice model type (default=enhanced)
  --type [TYPE]    Input type: text or ssml (default=text)
  --input [INPUT]  Input text (default=This is a test)

source get-token.sh

python3 http-wav-client.py --wav

Audio successfully written to output.wav

python3 http-wav-client.py --wav --voice "Zoe-Ml" --input "Shall I compare thee to a summers day"

Audio successfully written to output.wav

python3 http-wav-client.py --wav --voice "Zoe-Ml" --type "ssml" \
--input "<speak>Thou art more lovely and more temperate.</speak>"

Audio successfully written to output.wav

@echo off
setlocal enabledelayedexpansion

set CLIENT_ID=<Mix client ID, starting with appID:>
set SECRET=<Mix client secret>
rem Change colons (:) to %3A in client ID
set CLIENT_ID=!CLIENT_ID::=%%3A!

set command=curl -s ^
-u %CLIENT_ID%:%SECRET% ^
-d "grant_type=client_credentials" -d "scope=tts" ^
https://auth.crt.nuance.com/oauth2/token

for /f "delims={}" %%a in ('%command%') do (
  for /f "tokens=1 delims=:, " %%b in ("%%a") do set key=%%b
  for /f "tokens=2 delims=:, " %%b in ("%%a") do set value=%%b
  goto done:
)

:done

rem Remove quotes
set MY_TOKEN=!value:"=!

rem Uncomment the command you want to run

rem 1) This gives information about Evan
REM curl -H "Authorization: Bearer %MY_TOKEN%" ^
REM https://tts.api.nuance.com/api/v1/voices ^
REM -d "{ \"voice\": { \"name\": \"Evan\" } }"

rem 2) This gives information about all the Mix voices
REM curl -H "Authorization: Bearer %MY_TOKEN%" https://tts.api.nuance.com/api/v1/voices

rem 3) This gives information about all French Canadian voices available in Mix
REM curl -H "Authorization: Bearer %MY_TOKEN%" ^
REM https://tts.api.nuance.com/api/v1/voices ^
REM -d "{ \"voice\": { \"language\": \"fr-ca\" } }"

rem 4) This generates audio in base64 format. Be aware the output is very long...
REM curl -H "Authorization: Bearer %MY_TOKEN%" ^
REM https://tts.api.nuance.com/api/v1/synthesize ^
REM -d "{ \"voice\": { \"name\": \"Evan\", \"model\": \"enhanced\" }, \"input\": { \"text\": { \"text\": \"This is a test. A very simple test.\"} } }"

rem 5) This generates audio as a wav file, with several variations.
REM python http-wav-client.py --wav

REM python http-wav-client.py --wav --voice "Zoe-Ml" --input "Shall I compare thee to a summers day"

REM python http-wav-client.py --wav --voice "Zoe-Ml" --type "ssml" ^
REM --input "<speak>Thou art more lovely and more temperate.</speak>"

rem 1) This gives information about Evan
curl -H "Authorization: Bearer %MY_TOKEN%" ^
https://tts.api.nuance.com/api/v1/voices ^
-d "{ \"voice\": { \"name\": \"Evan\" } }"

run-http.bat

{
 "voices": [
  {
   "name": "Evan",
   "model": "enhanced",
   "language": "en-US",
   "ageGroup": "ADULT",
   "gender": "MALE",
   "sampleRateHz": 22050,
   "languageTlw": "enu",
   "restricted": false,
   "version": "1.1.1",
   "foreignLanguages": []
  }
 ]
}

rem 5) This gives audio as a wav file, with several variations.
python http-wav-client.py --wav

run-http.bat

Audio successfully written to output.wav