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. Recommended. BCP-47 language tag. If not specified, the API will return all supported voices. If specified, the voices.list call will only return voices that can be used to synthesize this languageCode. For example, if you specify "en-NZ", all "en-NZ" voices will be returned. If you specify "no", both "no-\*" (Norwegian) and "nb-\*" (Norwegian Bokmal) voices will be returned.

Request body

The request body must be empty.

Response body

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

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

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": integer
}
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

integer

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