Method: voices.list

Returns a list of Voice supported for synthesis.

HTTP request

GET https://texttospeech.googleapis.com/v1beta1/voices

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
languageCode

string

Optional (but recommended) BCP-47 language tag. If specified, the voices.list call will only return voices that can be used to synthesize this languageCode. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

The message returned to the client by the voices.list method.

JSON representation
{
  "voices": [
    {
      object (Voice)
    }
  ]
}
Fields
voices[]

object (Voice)

The list of voices.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

Voice

Description of a voice supported by the TTS service.

JSON representation
{
  "languageCodes": [
    string
  ],
  "name": string,
  "ssmlGender": enum (SsmlVoiceGender),
  "naturalSampleRateHertz": number
}
Fields
languageCodes[]

string

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

name

string

The name of this voice. Each distinct voice has a unique name.

ssmlGender

enum (SsmlVoiceGender)

The gender of this voice.

naturalSampleRateHertz

number

The natural sample rate (in hertz) for this voice.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Text-to-Speech Documentation
Need help? Visit our support page.