
HeyGen Text to Speech
Generate natural speech audio from text using HeyGen's Starfish TTS engine. Supports configurable voice, speed, SSML input, and multiple languages.
api reference
about
generate natural speech audio from text using heygen's starfish tts engine. supports configurable voice, speed, ssml input, and multiple languages.
get an api key
create one in settings → api keys. the examples read it from INFERENCE_API_KEY.
1export INFERENCE_API_KEY="inf_your_key"1. calling the api
install the client
nothing to install. any http client works; the examples use curl, and jq to read responses. every response wraps its result in a data field.
run and get result
send "wait": true to hold the connection until the task finishes. without it the call returns right away with the task still running.
12# "wait": true holds the connection until the task finishes.3# the response is {"data": {"id", "status", "status_text", "output", ...}}4curl -X POST https://api.inference.sh/apps/run \5 -H "Authorization: Bearer $INFERENCE_API_KEY" \6 -H "Content-Type: application/json" \7 -d '{8 "app": "heygen/text-to-speech",9 "input": {10 "text": "Hello! Welcome to our platform. We'\''re excited to have you here.",11 "voice_id": "voice_id"12 },13 "wait": true14 }'stream live updates
get real-time progress updates as the task runs. ideal for showing progress bars, partial results, or long-running tasks. send "stream": true and the response is a server-sent event stream that ends when the task does.
12# "stream": true answers with server-sent events until the task finishes3curl -N -X POST https://api.inference.sh/apps/run \4 -H "Authorization: Bearer $INFERENCE_API_KEY" \5 -H "Content-Type: application/json" \6 -d '{7 "app": "heygen/text-to-speech",8 "input": {9 "text": "Hello! Welcome to our platform. We'\''re excited to have you here.",10 "voice_id": "voice_id"11 },12 "stream": true13 }'run in the background
start the task and get its id back right away, then check on it later. for long tasks, or when you'd rather be called back, see webhooks.
1# without "wait" the call returns the task right away (status 1, "received")2TASK_ID=$(curl -s -X POST https://api.inference.sh/apps/run \3 -H "Authorization: Bearer $INFERENCE_API_KEY" \4 -H "Content-Type: application/json" \5 -d '{6 "app": "heygen/text-to-speech",7 "input": {8 "text": "Hello! Welcome to our platform. We'\''re excited to have you here.",9 "voice_id": "voice_id"10 }11 }' | jq -r '.data.id')1213# later: read its state. done when status is 10 (completed), 11 (failed) or 12 (cancelled)14curl -s https://api.inference.sh/tasks/$TASK_ID \15 -H "Authorization: Bearer $INFERENCE_API_KEY" | jq '.data | {status, status_text, output}'2. authentication
the api uses api keys for authentication. see the authentication docs for detailed setup instructions.
3. files
file inputs are automatically handled by the sdk. you can pass local paths, urls, or base64 data.
automatic upload
pass urls directly or use data uris for inline content.
1# pass URLs or data URIs as input values2curl -X POST https://api.inference.sh/apps/run \3 -H "Authorization: Bearer $INFERENCE_API_KEY" \4 -H "Content-Type: application/json" \5 -d '{6 "app": "heygen/text-to-speech",7 "input": {8 "image": "https://example.com/image.png",9 "audio": "data:audio/mp3;base64,..."10 },11 "wait": true12 }'manual upload
you can also upload files manually and use the returned url.
1# 1. create the file: the response has an upload_url and the file's uri2FILE=$(curl -s -X POST https://api.inference.sh/files \3 -H "Authorization: Bearer $INFERENCE_API_KEY" \4 -H "Content-Type: application/json" \5 -d '{"files": [{"filename": "image.png", "content_type": "image/png"}]}')67# 2. PUT the bytes to upload_url8curl -X PUT "$(echo "$FILE" | jq -r '.data[0].upload_url')" \9 -H "Content-Type: image/png" \10 --data-binary @image.png1112# 3. pass the uri as an input value13echo "$FILE" | jq -r '.data[0].uri'4. webhooks
get notified when a task completes by providing a webhook url. when the task reaches a terminal state (completed, failed, or cancelled), a POST request is sent to your url with the task result.
1curl -X POST https://api.inference.sh/apps/run \2 -H "Authorization: Bearer $INFERENCE_API_KEY" \3 -H "Content-Type: application/json" \4 -d '{5 "app": "heygen/text-to-speech",6 "input": {7 "text": "Hello! Welcome to our platform. We're excited to have you here.",8 "voice_id": "voice_id"9 },10 "webhook": "https://your-server.com/webhook"11 }'webhook payload
your endpoint receives a JSON POST with the task result:
1{2 "event": "task.completed",3 "timestamp": "2024-01-15T10:30:05Z",4 "data": {5 "id": "task_abc123",6 "short_id": "abc123",7 "status": 10,8 "status_text": "completed",9 "output": { ... },10 "created_at": "2024-01-15T10:30:00Z",11 "updated_at": "2024-01-15T10:30:05Z"12 }13}5. schema
input
text to convert to speech (1-5000 characters).
voice id to use. must support the starfish engine.
input format: 'text' for plain text, 'ssml' for ssml markup.
speech speed multiplier (0.5-2.0).
iso language code (e.g., 'en', 'es', 'pt').
bcp-47 locale (e.g., 'en-us', 'pt-br').
Pika H3 Flex Audio Stems
pika/pika-h3-flex-audio-stems
$0.001/stem-sec (3 stems: dialogue, music, effect)
Fish Audio Drama 3
fish-audio/drama-3
$50.00/1M UTF-8 bytes
Eleven Flash v2.5
elevenlabs/eleven-flash-v2-5
$0.04/1K characters
Eleven Multilingual v2
elevenlabs/eleven-multilingual-v2
$0.08/1K characters
Eleven v3
elevenlabs/eleven-v3
$0.08/1K characters
HeyGen Instant Voice Clone
heygen/voice-clone
$0.0007/sec audio (clone-only runs: free)
HeyGen Create Avatar
heygen/create-avatar
$1.00/call
HeyGen Lip Sync
heygen/lipsync
$0.033/sec speed, $0.067/sec precision
HeyGen Video Translate
heygen/video-translate
$0.033/sec (speed), $0.067/sec (precision), $0.033/sec (audio-only)
new models

Seedream 5.5
bytedance/seedream-5-5
image$0.020 per 1K/1.5K image, $0.035 per 2K image, plus $0.008 per reference image
Kling Video V4 Flash
klingai/video-v4-flash
video$0.094/s at 720p
Kling Video V4
klingai/video-v4
video$0.157/s at 720p, $0.235/s at 1080p
MiniMax H3 Image
minimax/h3-image
image$2.30/M text in, $1.50/M image in, $3.80/M image out (token-based)
Pika H3 Flex (self-hosted)
pika/pika-h3-flex-oss
videoGPU time, billed per millisecond
ready to run HeyGen Text to Speech?
we use cookies
we use cookies to ensure you get the best experience on our website. for more information on how we use cookies, please see our cookie policy.
by clicking "accept", you agree to our use of cookies.
learn more.