Documentation 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.
Quick Example
Response
Finding a Compatible Voice
Before calling this endpoint, find a Starfish-compatiblevoice_id:
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
text | string | Yes | — | Text to synthesize (1–5,000 characters). |
voice_id | string | Yes | — | A Starfish-compatible voice ID. |
input_type | string | No | "text" | "text" for plain text or "ssml" for SSML markup. |
speed | number | No | 1.0 | Speed multiplier (0.5–2.0). |
language | string | No | auto-detected | Base language code (e.g. "en", "pt", "zh"). Auto-detected when omitted. |
locale | string | No | — | BCP-47 locale tag (e.g. "en-US", "pt-BR"). Overrides language when set. |
Response Fields
| Field | Type | Description |
|---|---|---|
audio_url | string | URL of the generated audio file. |
duration | number | Duration of the audio in seconds. |
request_id | string or null | Unique identifier for this generation request. |
word_timestamps | array or null | Word-level timing data — each entry has word, start, and end in seconds. |
SSML Support
For finer control over pronunciation, pauses, and emphasis, setinput_type to "ssml". Check support_pause on the voice object from GET /v3/voices to confirm the voice supports SSML break tags.

