Using Yandex API Gateway to set up speech synthesis in Yandex SpeechKit

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

1. Create a service account named speechkit-sa:

   yc iam service-account create speechkit-sa
   

   Result:

   id: nfersamh4sjq********
   folder_id: b1gc1t4cb638********
   created_at: "2023-09-21T10:36:29.726397755Z"
   name: speechkit-sa
   

   Save the ID of the speechkit-sa service account (id) and the ID of the folder where you created it (folder_id).

   For more information about the yc iam service-account create command, see the CLI reference.

2. Assign the ai.speechkit-tts.user role for the folder to the service account by specifying the folder and service account IDs you previously saved:

   yc resource-manager folder add-access-binding <folder_ID> \
     --role ai.speechkit-tts.user \
     --subject serviceAccount:<service_account_ID>
   

   For more information about the yc resource-manager folder add-access-binding command, see the CLI reference.

To create a service account, use the create method for the ServiceAccount resource or the ServiceAccountService/Create gRPC API call.

To assign the ai.speechkit-tts.user role for a folder to a service account, use the setAccessBindings method for the ServiceAccount resource or the ServiceAccountService/SetAccessBindings gRPC API call.

1. Save the following specification to speechkit-gw.yaml and provide the speechkit-sa service account ID in the service_account_id parameter:

   openapi: 3.0.0
   info:
     title: Sample API
     version: 1.0.0
   
   paths:
     /synthesis:
       post:
         requestBody:
           description: "/synthesis"
           content:
             application/json:
               schema:
                 type: object
                 x-yc-schema-mapping:
                   type: static
                   template:
                     text: "${.text}"
                     hints:
                       - voice: "lera"
                       - role: "friendly"
                       - audioTemplate:
                           audio:
                             audioSpec:
                               containerAudio:
                                 containerAudioType: "MP3"
         responses:
           200:
             description: "/synthesis"
             content:
               application/json:
                 schema:
                   type: object
                   x-yc-schema-mapping:
                     type: static
                     template:
                       data: "${.result.audioChunk.data}"
         x-yc-apigateway-integration:
           http_method: post
           type: http
           url: https://tts.api.cloud.yandex.net/tts/v3/utteranceSynthesis
           service_account_id: "<service_account_ID>"
   

2. Run this command:

   yc serverless api-gateway create \
     --name speechkit-api-gw \
     --spec=speechkit-gw.yaml
   

   Where:

   • --name: API gateway name.
   • --spec: Path to the specification file.

   Result:

   done (2s)
   id: d5ddbmungf72********
   folder_id: b1gt6g8ht345********
   created_at: "2024-08-19T18:58:32.101Z"
   name: speechkit-api-gw
   status: ACTIVE
   domain: d5dm1lba80md********.i9******.apigw.yandexcloud.net
   connectivity: {}
   log_options:
     folder_id: b1gt6g8ht345********
   execution_timeout: 300s
   

Save the service domain (the domain field value) of the API gateway you created. You will need it later to test the API gateway.

For more information about the yc serverless api-gateway create command, see the CLI reference.

To create an API gateway, use the create REST API method for the ApiGateway resource or the ApiGatewayService/Create gRPC API call.