List voices viaDocumentation Index
Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
GET /v3/voices; inspect one via GET /v3/voices/{voice_id}. To create a new voice instead, see Design Voices or Clone a Voice. For TTS, see Text to Speech.
Quick Example
Query Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | No | "public" | "public" for the shared library or "private" for your cloned voices. |
engine | string | No | — | Filter by voice engine (e.g. "starfish"). Only compatible voices are returned. |
language | string | No | — | Filter by language (e.g. "English", "Spanish"). |
gender | string | No | — | Filter by "male" or "female". |
limit | integer | No | 20 | Results per page (1–100). |
token | string | No | — | Opaque cursor token for the next page (from a previous response’s next_token). |
Response Fields
Each voice object in thedata array contains:
| Field | Type | Description |
|---|---|---|
voice_id | string | Unique identifier. Pass this to POST /v3/voices/speech, POST /v3/videos, or POST /v3/video-agents. |
name | string | Display name of the voice. |
language | string | Primary language (e.g. "English"). |
gender | string | "male" or "female". |
type | string | "public" (shared library) or "private" (your cloned voice). |
preview_audio_url | string or null | URL to a short audio preview. |
support_pause | boolean | Whether the voice supports SSML pause/break tags. |
support_locale | boolean | Whether the voice supports locale variants (e.g. en-US vs en-GB). |
Filtering Examples
By Language
curl
By Gender
curl
Your Private (Cloned) Voices
curl
TTS-Compatible Voices Only
To get voices that work withPOST /v3/voices/speech, filter by the starfish engine:
curl
Pagination
Ifhas_more is true, pass the next_token value as the token query parameter to fetch the next page.
curl