Skip to main content
POST
/
voices
/
design
Design Voices
curl --request POST \
  --url https://api.revring.ai/v1/voices/design \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "instruction": "<string>",
  "n": 2
}
'
import requests

url = "https://api.revring.ai/v1/voices/design"

payload = {
"instruction": "<string>",
"n": 2
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({instruction: '<string>', n: 2})
};

fetch('https://api.revring.ai/v1/voices/design', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.revring.ai/v1/voices/design",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'instruction' => '<string>',
'n' => 2
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.revring.ai/v1/voices/design"

payload := strings.NewReader("{\n \"instruction\": \"<string>\",\n \"n\": 2\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.revring.ai/v1/voices/design")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"instruction\": \"<string>\",\n \"n\": 2\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.revring.ai/v1/voices/design")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"instruction\": \"<string>\",\n \"n\": 2\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "candidates": [
      {
        "index": 123,
        "audioBase64": "<string>",
        "durationMs": 123,
        "sampleRate": 123
      }
    ]
  }
}
{
"error": "invalid_body",
"details": {}
}
{
"error": "unauthorized"
}
{
"error": "billing_inactive"
}

Authorizations

x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

Body

application/json
instruction
string
required

A description of the voice you want (1 to 2000 characters), e.g. 'A warm, confident female voice with a natural American accent.'

n
integer
default:2

How many candidate voices to generate

Required range: 1 <= x <= 4

Response

Generated voice candidates

data
object