Skip to main content
POST
/
v3
/
voices
Design a Voice
curl --request POST \
  --url https://api.heygen.com/v3/voices \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "prompt": "<string>",
  "gender": "<string>",
  "locale": "<string>",
  "seed": 0
}
'
import requests

url = "https://api.heygen.com/v3/voices"

payload = {
    "prompt": "<string>",
    "gender": "<string>",
    "locale": "<string>",
    "seed": 0
}
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({prompt: '<string>', gender: '<string>', locale: '<string>', seed: 0})
};

fetch('https://api.heygen.com/v3/voices', 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.heygen.com/v3/voices",
  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([
    'prompt' => '<string>',
    'gender' => '<string>',
    'locale' => '<string>',
    'seed' => 0
  ]),
  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.heygen.com/v3/voices"

	payload := strings.NewReader("{\n  \"prompt\": \"<string>\",\n  \"gender\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"seed\": 0\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.heygen.com/v3/voices")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"<string>\",\n  \"gender\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"seed\": 0\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/voices")

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  \"prompt\": \"<string>\",\n  \"gender\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"seed\": 0\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "voices": [
      {
        "voice_id": "<string>",
        "name": "<string>",
        "language": "<string>",
        "gender": "<string>",
        "support_pause": true,
        "support_locale": true,
        "preview_audio_url": "https://files.heygen.ai/voice/preview_sara.mp3"
      }
    ],
    "seed": 123
  }
}
{
  "error": {
    "code": "invalid_parameter",
    "message": "'prompt' is required.",
    "param": "prompt",
    "doc_url": null
  }
}
{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid or expired API key. Verify your x-api-key header.",
    "param": null,
    "doc_url": null
  }
}
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Retry after the duration specified in the Retry-After header.",
    "param": null,
    "doc_url": null
  }
}

Authorizations

​
x-api-key
string
header
required

HeyGen API key. Obtain from your HeyGen dashboard.

Body

application/json

Request body for POST /v3/voices — design a voice via semantic search.

​
prompt
string
required

Natural language description of the desired voice (e.g., 'warm, confident female narrator').

Required string length: 1 - 1000
​
gender
string | null

Filter by gender: 'male' or 'female'.

​
locale
string | null

BCP-47 locale tag to filter by (e.g., 'en-US', 'pt-BR').

​
seed
integer
default:0

Controls which batch of results to return. seed=0 returns the top matches, seed=1 the next batch, etc. Same prompt + seed always returns the same voices.

Required range: x >= 0

Response

Successful response

​
data
DesignVoiceResponseData · object

Response payload for POST /v3/voices.