v1

latestOpenAPI 3.1.02026-07-2665164286.3 KB

Voices

Design a Voice

Returns up to 3 voices matching a natural language description (e.g. 'warm, confident female narrator'). Use the seed parameter to get different batches of results.

post/v3/voices

Request body

promptstring required

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

genderstring nullable

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

localestring nullable

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

seedinteger

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.

Response

Successful response

Example response

{
  "data": {
    "voices": [
      {
        "voice_id": "1bd001e7e50f421d891986aad5c8bbd2",
        "name": "Sara",
        "language": "English",
        "gender": "female",
        "preview_audio_url": "https://files.heygen.ai/voice/preview_sara.mp3",
        "support_pause": true,
        "support_locale": true
      }
    ]
  }
}