Описание метода API v1

Генерирует речь по переданному тексту.

HTTP-запрос

POST https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize

Параметры в теле запроса

Для всех параметров обязательно используйте URL-кодирование. Максимальный размер тела POST-запроса 15 КБ.

Ответ

Если синтез прошел успешно, в ответе будет бинарное содержимое аудиофайла. Формат выходных данных зависит от значения параметра format.

Примеры

Чтобы воспользоваться примерами, установите cURL и получите данные вашего аккаунта для авторизации:

Превратить текст в речь в формате OggOpus

В этом примере синтезируется и записывается в аудиофайл следующий текст:

Я Яндекс Спичк+ит.
Я могу превратить любой текст в речь.
Теперь и в+ы — можете!

По умолчанию данные в аудиофайле кодируются с помощью аудиокодека OPUS и упаковываются в контейнер OGG (OggOpus).

Выполните запрос, указав в параметрах идентификатор каталога и IAM-токен для авторизации:

read -r -d '' TEXT << EOM
> Я Яндекс Спичк+ит.
> Я могу превратить любой текст в речь.
> Теперь и в+ы — можете!
EOM
export FOLDER_ID=<идентификатор каталога>
export IAM_TOKEN=<IAM-токен>
curl -X POST \
   -H "Authorization: Bearer ${IAM_TOKEN}" \
   --data-urlencode "text=${TEXT}" \
   -d "lang=ru-RU&voice=filipp&folderId=${FOLDER_ID}" \
  "https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize" > speech.ogg

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading.Tasks;
using System.IO;

namespace TTS
{
  class Program
  {
    static void Main()
    {
      Tts().GetAwaiter().GetResult();
    }

    static async Task Tts()
    {
      const string iamToken = "<IAM-токен>"; // Укажите IAM-токен.
      const string folderId = "<идентификатор каталога>"; // Укажите идентификатор каталога.

      HttpClient client = new HttpClient();
      client.DefaultRequestHeaders.Add("Authorization", "Bearer " + iamToken);
      var values = new Dictionary<string, string>
      {
        { "text", "Я Яндекс Спичк+ит. Я могу превратить любой текст в речь. Теперь и в+ы — можете!" },
        { "lang", "ru-RU" },
        { "voice", "filipp" },
        { "folderId", folderId }
      };
      var content = new FormUrlEncodedContent(values);
      var response = await client.PostAsync("https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize", content);
      var responseBytes = await response.Content.ReadAsByteArrayAsync();
      File.WriteAllBytes("speech.ogg", responseBytes);
    }
  }
}

<?php

$token = '<IAM-токен>'; # Укажите IAM-токен.
$folderId = "<идентификатор каталога>"; # Укажите идентификатор каталога.

$url = "https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize";
$headers = ['Authorization: Bearer ' . $token];
$post = array(
    'text' => "Я Яндекс Спичк+ит. Я могу превратить любой текст в речь. Теперь и в+ы — можете!",
    'folderId' => $folderId,
    'sampleRateHertz' => '48000',
    'lang' => 'ru-RU',
    'voice' => 'filipp',
    'format' => 'lpcm');

$ch = curl_init();

curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
curl_setopt($ch, CURLOPT_HEADER, false);
if ($post !== false) {
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
}
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);


$response = curl_exec($ch);
if (curl_errno($ch)) {
    print "Error: " . curl_error($ch);
}
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) != 200) {
    $decodedResponse = json_decode($response, true);
    echo "Error code: " . $decodedResponse["error_code"] . "\r\n";
    echo "Error message: " . $decodedResponse["error_message"] . "\r\n";
} else {
    file_put_contents("speech.raw", $response);
}
curl_close($ch);

Превратить текст в речь в формате WAV

В этом примере переданный текст синтезируется в формате LPCM с частотой дискретизации 48 кГц и сохраняется в файле speech.raw. Затем этот файл конвертируется в формат WAV с помощью утилиты SoX.

1. Синтезируйте файл в формате LCPM, указав в параметрах идентификатор каталога и IAM-токен:

   cURL

   C#

   Python 3

   PHP

   read -r -d '' TEXT << EOM
   > Я Яндекс Спичк+ит.
   > Я могу превратить любой текст в речь.
   > Теперь и в+ы — можете!
   EOM
   export FOLDER_ID=<идентификатор каталога>
   export IAM_TOKEN=<IAM-токен>
   curl -X POST \
     -H "Authorization: Bearer ${IAM_TOKEN}" \
     -o speech.raw \
     --data-urlencode "text=${TEXT}" \
     -d "lang=ru-RU&voice=filipp&folderId=${FOLDER_ID}&format=lpcm&sampleRateHertz=48000" \
     https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize
   

   using System;
   using System.Collections.Generic;
   using System.Net.Http;
   using System.Threading.Tasks;
   using System.IO;
   
   namespace TTS
   {
     class Program
     {
       static void Main()
       {
         Tts().GetAwaiter().GetResult();
       }
   
       static async Task Tts()
       {
         const string iamToken = "<IAM-токен>"; // Укажите IAM-токен.
         const string folderId = "<идентификатор каталога>"; // Укажите идентификатор каталога.
   
         HttpClient client = new HttpClient();
         client.DefaultRequestHeaders.Add("Authorization", "Bearer " + iamToken);
         var values = new Dictionary<string, string>
         {
           { "text", "Я Яндекс Спичк+ит. Я могу превратить любой текст в речь. Теперь и в+ы — можете!" },
           { "lang", "ru-RU" },
           { "voice", "filipp" },
           { "folderId", folderId },
           { "format", "lpcm" },
           { "sampleRateHertz", "48000" }
         };
         var content = new FormUrlEncodedContent(values);
         var response = await client.PostAsync("https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize", content);
         var responseBytes = await response.Content.ReadAsByteArrayAsync();
         File.WriteAllBytes("speech.raw", responseBytes);
       }
     }
   }
   

   1. Создайте файл, например test.py, и добавьте в него следующий код:

      import argparse
      import requests
      
      
      def synthesize(folder_id, iam_token, text):
          url = 'https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize'
          headers = {
              'Authorization': 'Bearer ' + iam_token,
          }
      
          data = {
              'text': text,
              'lang': 'ru-RU',
              'voice': 'filipp',
              'folderId': folder_id,
              'format': 'lpcm',
              'sampleRateHertz': 48000,
          }
      
          with requests.post(url, headers=headers, data=data, stream=True) as resp:
              if resp.status_code != 200:
                  raise RuntimeError("Invalid response received: code: %d, message: %s" % (resp.status_code, resp.text))
      
              for chunk in resp.iter_content(chunk_size=None):
                  yield chunk
      
      
      if __name__ == "__main__":
          parser = argparse.ArgumentParser()
          parser.add_argument("--token", required=True, help="IAM token")
          parser.add_argument("--folder_id", required=True, help="Folder id")
          parser.add_argument("--text", required=True, help="Text for synthesize")
          parser.add_argument("--output", required=True, help="Output file name")
          args = parser.parse_args()
      
          with open(args.output, "wb") as f:
              for audio_content in synthesize(args.folder_id, args.token, args.text):
                  f.write(audio_content)
      

   2. Выполните созданный файл, передав в аргументах идентификатор каталога, IAM-токен, текст и имя файла для записи аудио:

      export FOLDER_ID=<идентификатор каталога>
      export IAM_TOKEN=<IAM-токен>
      python test.py --token ${IAM_TOKEN} --folder_id ${FOLDER_ID} --output speech.raw --text "Я Яндекс Спичк+ит. Я могу превратить любой текст в речь. Теперь и в+ы — можете!"
      

   <?php
   
   $token = '<IAM-токен>'; # Укажите IAM-токен.
   $folderId = "<идентификатор каталога>"; # Укажите идентификатор каталога.
   
   $url = "https://tts.api.cloud.yandex.net/speech/v1/tts:synthesize";
   $headers = ['Authorization: Bearer ' . $token];
   $post = array(
       'text' => "Я Яндекс Спичк+ит. Я могу превратить любой текст в речь. Теперь и в+ы — можете!",
       'folderId' => $folderId,
       'sampleRateHertz' => '48000',
       'lang' => 'ru-RU',
       'voice' => 'filipp',
       'format' => 'lpcm');
   
   $ch = curl_init();
   
   curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE);
   curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
   curl_setopt($ch, CURLOPT_URL, $url);
   curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
   curl_setopt($ch, CURLOPT_HEADER, false);
   if ($post !== false) {
       curl_setopt($ch, CURLOPT_POST, 1);
       curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
   }
   curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
   
   
   $response = curl_exec($ch);
   if (curl_errno($ch)) {
       print "Error: " . curl_error($ch);
   }
   if (curl_getinfo($ch, CURLINFO_HTTP_CODE) != 200) {
       $decodedResponse = json_decode($response, true);
       echo "Error code: " . $decodedResponse["error_code"] . "\r\n";
       echo "Error message: " . $decodedResponse["error_message"] . "\r\n";
   } else {
       file_put_contents("speech.raw", $response);
   }
   curl_close($ch);
   

2. Cконвертируйте полученный файл в формат WAV с помощью утилиты SoX.

   sox -r 48000 -b 16 -e signed-integer -c 1 speech.raw speech.wav
   

Превратить текст в формате SSML в речь

В этом примере текст передается в формате SSML.

Текст синтезируется и записывается в аудиофайл. По умолчанию данные в аудиофайле кодируются с помощью аудиокодека OPUS и упаковываются в контейнер OGG (OggOpus).