Voice Resource

Voice allows you to retrieve a list of the available voices from our API.

Voice Methods

⬇️list()

List all the available voices in our API. The parameters are all optional, and can be used in combination to get the perfect voice for your usecase.

Parameters:

  • provider (string) - Try one of: google, polly, azure, msnr, yandex
  • providerFullName (string) - Try with one of: amazon polly, google, microsoft azure, aflorithmic labs, retro, yandex
  • language (string) - Try with one of: english, spanish, french, german
  • accent (string) - Try with one of: american, british, neutral, portuguese/brazilian, american soft, mexican, australian
  • gender (string) - Try with one of: male, female
  • ageBracket (string) - Try with one of: adult, child, senior
  • tags (string) - Try with one or more (separated by commas) of: steady, confident, balanced, informative, serious, instructional, slow, storytelling, calm, clear, deep, formal, sad, thin, fast, upbeat, fun, energetic, tense, very fast, flat, low pitched, high pitched, low-pitched, sing-y, cooperative, kind, stable, monotonous, neutral, responsible, business man, straight to the point, knowledgeable, focused, newscastery, newsreader, interviewer, reliable, friendly, welcoming, good for handing out information, slightly friendly
  • industryExamples (string) - Try with one or more of: fitness, business, commercial, fashion, travel, audiobook, real estate, faith, health industry, commercial, kids entertainment, games, customer service, education, storytelling, entertainment, kids, education, audiobook

Example:

all_voices = apiaudio.Voice.list()
let voices = await Voice.list();
console.log(voices);

Example with filtering parameters:

french_voices = apiaudio.Voice.list(language="french",tags="steady, fun")
let filteredVoices = await Voice.list({ tags: "fun", gender: "female" });
console.log(filteredVoices);

⬇️list_parameters()

This endpoint lets you see which attributes you can filter the voices by, along with the allowed values for each attribute. You can later use these parameters and values to filter the voices you wish to list.

Parameters:

  • No parameters required.

Example:

parameters = apiaudio.Voice.list_parameters()
let parameters = await Voice.parameters();
console.log(parameters)

📘

Listen to our top 20 voices here


Did this page help you?