Premium Voices

For the impatient

You may explore this data model via the API Playground, by clicking here

Description

The Cloudonix premium voices model is used to list which voice models are available for use by applications in a Cloudonix domain, as made available by Cloudonix provided Speech-To-Text services, Cloudonix Premium (OTT - "over the top") Speech-To-Text services, and customer provided credentials for additional Speech-To-Text servics (BYOV - Bring Your Own Voice).

Properties

Property	Type	Description
provider	String	The name of the Text-To-Speech (TTS) service provider through which this voice is available.
voice	String	The value to use with the <Say> verb's voice attribute to use this voice.
language	Array	An array of language codes, any of which can be used for the <Say> verb's language attribute, with this voice.
gender	String	A description of the gender this voice may sound like.
pricing	String	The Cloudonix pricing for this voice. Either: standard - included in the Cloudonix billing plan premium - consumes AI "usage minutes" customer-pay - available through customer provided 3rd-party credentials

Available Speech-To-Text Services

The following Speech-To-Text Services are currently supported:

• Amazon Polly (Provided as standard, or BYOV)
• Amazon Polly Neural (Premium OTT, or BYOV)
• Google Speech To Text (Premium OTT, or BYOV)
• Azure Speech AI (BYOV only)
• ElevenLabs (BYOV only)

To set up customer credentials for using BYOV voices, use the Cloudonix Cockpit's domain setting's 3rd-party authorizations page, or using the Domain Authorizations API endpoint.

API Reference

Base Path /domains/{domain}/resources/voices

Parameters

Parameter	Description
{domain}	A Cloudonix domain name.

List Available Voices

GET /domains/{domain}/resources/voices

Example

Request

curl 'https://api.cloudonix.io/domains/example.com/resources/voices' \
--header 'Authorization: Bearer XI1234567890ABCDEF'

Response

[
  {
    "voice": "man",
    "gender": "male",
    "languages": [],
    "provider": "Cloudonix",
    "pricing": "standard"
  },
  {
    "voice": "woman",
    "gender": "female",
    "languages": [],
    "provider": "Cloudonix",
    "pricing": "standard"
  },
  …
]

var https = require('https');
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': 'api.cloudonix.io',
  'path': '/domains/example.com/resources/voices',
  'headers': {
    'Authorization': 'Bearer XI1234567890ABCDEF'
  }
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

req.end();

import http.client

conn = http.client.HTTPSConnection("api.cloudonix.io")
payload = ''
headers = {
  'Authorization': 'Bearer XI1234567890ABCDEF'
}

conn.request("GET", "/domains/example.com/resources/voices", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.cloudonix.io/domains/example.com/resources/voices',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer XI1234567890ABCDEF'
    ],
  ]
);

$response = curl_exec($curl);

curl_close($curl);
echo $response;

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.cloudonix.io/domains/example.com/resources/voices"
  method := "GET"

  client := &http.Client {
  }

  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer XI1234567890ABCDEF")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}