List v2 Narration Voices

GET https://api.slidespeak.co/api/v2/presentation/voices

Lists the narration voices available for a language. Use a returned voice_id with /presentation/video to pick the voice your video is narrated with.

Headers

X-API-Key: string

The API key to use for the request.

Query Parameters

language: string OPTIONAL

The language to list voices for. Pass a language code such as ENGLISH, ENGLISH_UK or SPANISH_MEXICO — matching is case-insensitive. Unsupported values are rejected with a 400 that lists the accepted codes. See Supported Languages.

Code Examples

curl -X GET "https://api.slidespeak.co/api/v2/presentation/voices?language=ENGLISH_UK"   -H "X-API-Key: YOUR_API_KEY"

const response = await fetch('https://api.slidespeak.co/api/v2/presentation/voices?language=ENGLISH_UK', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_API_KEY'
  }
});

const data = await response.json();
console.log(data.voices);

import requests

url = "https://api.slidespeak.co/api/v2/presentation/voices"
headers = {"X-API-Key": "YOUR_API_KEY"}

response = requests.get(url, headers=headers, params={"language": "ENGLISH_UK"})
print(response.json()["voices"])

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$response = $client->get('https://api.slidespeak.co/api/v2/presentation/voices', [
    'headers' => [
        'X-API-Key' => 'YOUR_API_KEY'
    ],
    'query' => [
        'language' => 'ENGLISH_UK'
    ]
]);

$data = json_decode($response->getBody(), true);
print_r($data['voices']);

Response

{
  "voices": [
    {
      "voice_id": "en-GB-SoniaNeural",
      "name": "Sonia",
      "gender": "Female",
      "locale": "en-GB"
    },
    {
      "voice_id": "en-GB-RyanNeural",
      "name": "Ryan",
      "gender": "Male",
      "locale": "en-GB"
    }
  ]
}

{
  "detail": "Unsupported language. Supported values: AFRIKAANS, ALBANIAN, AMHARIC, ...",
  "error": {
    "code": "BAD_REQUEST",
    "status_code": 400,
    "retryable": false,
    "message": "Unsupported language. Supported values: AFRIKAANS, ALBANIAN, AMHARIC, ...",
    "details": {},
    "request_id": "cmqf2lohi00017wlp3du979zt"
  }
}

Response Fields

voice_id: string OPTIONAL

The identifier to pass as voice_id to /presentation/video.

name: string OPTIONAL

The voice’s display name, for example Sonia.

gender: string OPTIONAL

Female or Male.

locale: string OPTIONAL

The Azure locale the voice speaks, for example en-GB.

Supported Languages

Pass the code in any casing; it is normalized before lookup. Each language maps to the Azure locale whose voices are returned.

Language	Azure locale
`AFRIKAANS`	`af-ZA`
`ALBANIAN`	`sq-AL`
`AMHARIC`	`am-ET`
`ARABIC`	`ar-EG`
`ARABIC_SAUDI_ARABIA`	`ar-SA`
`ARMENIAN`	`hy-AM`
`ASSAMESE`	`as-IN`
`AZERBAIJANI`	`az-AZ`
`BASQUE`	`eu-ES`
`BENGALI`	`bn-IN`
`BOSNIAN`	`bs-BA`
`BULGARIAN`	`bg-BG`
`BURMESE`	`my-MM`
`CATALAN`	`ca-ES`
`CHINESE_SIMPLIFIED`	`zh-CN`
`CHINESE_TRADITIONAL_HONG_KONG`	`zh-HK`
`CHINESE_TRADITIONAL_TAIWAN`	`zh-TW`
`CROATIAN`	`hr-HR`
`CZECH`	`cs-CZ`
`DANISH`	`da-DK`
`DUTCH`	`nl-NL`
`ENGLISH`	`en-US`
`ENGLISH_AUSTRALIA`	`en-AU`
`ENGLISH_CANADA`	`en-CA`
`ENGLISH_IRELAND`	`en-IE`
`ENGLISH_UK`	`en-GB`
`ESTONIAN`	`et-EE`
`FINNISH`	`fi-FI`
`FRENCH`	`fr-FR`
`FRENCH (Canada)`	`fr-CA`
`FRENCH (Switzerland)`	`fr-CH`
`GEORGIAN`	`ka-GE`
`GERMAN, STANDARD`	`de-DE`
`GERMAN_AUSTRIA`	`de-AT`
`GERMAN_SWITZERLAND`	`de-CH`
`GREEK`	`el-GR`
`GUJARATI`	`gu-IN`
`HEBREW`	`he-IL`
`HINDI`	`hi-IN`
`HUNGARIAN`	`hu-HU`
`ICELANDIC`	`is-IS`
`INDONESIAN`	`id-ID`
`IRISH`	`ga-IE`
`ITALIAN`	`it-IT`
`JAPANESE`	`ja-JP`
`KANNADA`	`kn-IN`
`KAZAKH`	`kk-KZ`
`KOREAN`	`ko-KR`
`LATVIAN`	`lv-LV`
`LITHUANIAN`	`lt-LT`
`MACEDONIAN`	`mk-MK`
`MALAY`	`ms-MY`
`MALAYALAM`	`ml-IN`
`MARATHI`	`mr-IN`
`NEPALI`	`ne-NP`
`NORWEGIAN_BOKMAL`	`nb-NO`
`ORIYA`	`or-IN`
`PASHTO_AFGHANISTAN`	`ps-AF`
`PASHTO_PAKISTAN`	`ps-AF`
`PERSIAN`	`fa-IR`
`POLISH`	`pl-PL`
`PORTUGUESE`	`pt-PT`
`PORTUGUESE_BRAZIL`	`pt-BR`
`ROMANIAN`	`ro-RO`
`RUSSIAN`	`ru-RU`
`SERBIAN`	`sr-RS`
`SINHALA`	`si-LK`
`SLOVAK`	`sk-SK`
`SLOVENE`	`sl-SI`
`SOMALI`	`so-SO`
`SPANISH`	`es-ES`
`SPANISH_MEXICO`	`es-MX`
`SWAHILI`	`sw-KE`
`SWEDISH`	`sv-SE`
`TAGALOG`	`fil-PH`
`TAMIL`	`ta-IN`
`TELUGU`	`te-IN`
`THAI`	`th-TH`
`TURKISH`	`tr-TR`
`UKRAINIAN`	`uk-UA`
`URDU`	`ur-PK`
`UZBEK, NORTHERN`	`uz-UZ`
`VIETNAMESE`	`vi-VN`
`WELSH`	`cy-GB`
`ZULU`	`zu-ZA`