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
}
'
{
  "data": {
    "voices": [
      {
        "voice_id": "<string>",
        "name": "<string>",
        "language": "<string>",
        "gender": "<string>",
        "support_pause": true,
        "support_locale": true,
        "type": "public",
        "preview_audio_url": "https://files.heygen.ai/voice/preview_sara.mp3"
      }
    ],
    "seed": 123
  }
}

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.