How to synthesize speech in the SpeechKit API v3

In this section, you will learn how to synthesize speech from text using the SpeechKit API v3 (gRPC).

Authentication for API accessAuthentication for API access

To work with the SpeechKit API, you need to pass authentication. The authentication method depends on the account type:

In the example below, a Yandex account is used for authentication.

Getting startedGetting started

1. Install the grpcurl utility.

2. Install the jq utility for piped processing of JSON files.

   sudo apt update && sudo apt install jq
   

Convert text to an audio fileConvert text to an audio file

To synthesize speech from text in TTS markup to a WAV file:

1. Create a file with the body of an API request and text to synthesize to speech:

   tts_req.json

   {
    "text": "I'm Yandex Speech+Kit. I can turn any text into speech. Now y+ou can, too!",
    "outputAudioSpec": {
      "containerAudio": {
        "containerAudioType": "WAV"
      }
    },
    "hints": [
        {
            "voice": "jane"
        },
        {
            "role": "good"
        }
    ],
    "loudnessNormalizationType": "LUFS"
   }
   

2. Run the following commands:

   export FOLDER_ID=<folder_ID>
   export IAM_TOKEN=<IAM_token>
   jq . -c tts_req.json | \
   grpcurl -H "authorization: Bearer ${IAM_TOKEN}" \
           -H "x-folder-id: ${FOLDER_ID}" \
           -d @ tts.api.cloud.yandex.net:443 speechkit.tts.v3.Synthesizer/UtteranceSynthesis | \
   jq -r '.audioChunk.data' | base64 -d > speech.wav
   

   Where:

   • FOLDER_ID: Folder ID you got earlier.

     If you are using an IAM token of a service account, do not specify the folder ID in your request, as the service uses the folder the service account was created in.

   • IAM_TOKEN: IAM token you got earlier.

   • speech.wav: Output file.

As a result, a synthesized speech file named speech.wav will be created in the folder.

See alsoSee also

• Learn more about the API v3
• Authentication with the API
• Speech synthesis in the API v3