
HeyGen Create Avatar
Create HeyGen avatars from video footage (digital twin), a photo (photo avatar), or a text prompt (AI-generated). Returns a look ID for use with avatar-video.
api reference
about
create heygen avatars from video footage (digital twin), a photo (photo avatar), or a text prompt (ai-generated). returns a look id for use with avatar-video.
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/create-avatar",9 "input": {10 "type": "digital_twin",11 "name": "name",12 "prompt": "A professional woman in her 30s with short dark hair, wearing a navy blazer, in a modern office setting"13 },14 "wait": true15 }'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/create-avatar",8 "input": {9 "type": "digital_twin",10 "name": "name",11 "prompt": "A professional woman in her 30s with short dark hair, wearing a navy blazer, in a modern office setting"12 },13 "stream": true14 }'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/create-avatar",7 "input": {8 "type": "digital_twin",9 "name": "name",10 "prompt": "A professional woman in her 30s with short dark hair, wearing a navy blazer, in a modern office setting"11 }12 }' | jq -r '.data.id')1314# later: read its state. done when status is 10 (completed), 11 (failed) or 12 (cancelled)15curl -s https://api.inference.sh/tasks/$TASK_ID \16 -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/create-avatar",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/create-avatar",6 "input": {7 "type": "digital_twin",8 "name": "name",9 "prompt": "A professional woman in her 30s with short dark hair, wearing a navy blazer, in a modern office setting"10 },11 "webhook": "https://your-server.com/webhook"12 }'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
avatar creation method. 'digital_twin' from video, 'photo' from image, 'prompt' from text description.
display name for the avatar.
video file (digital_twin) or image file (photo). required for digital_twin and photo types.
text description of the avatar to generate. required for prompt type.
attach this look to an existing avatar group/character identity.
Kling Video V4 Flash
klingai/video-v4-flash
$0.094/s at 720p
Kling Video V4
klingai/video-v4
$0.157/s at 720p, $0.235/s at 1080p
Pika H3 Flex (self-hosted)
pika/pika-h3-flex-oss
GPU time, billed per millisecond
Pika H3 Flex Upscale
pika/pika-h3-flex-upscale
$0.05-$0.14/sec (480p src), $0.03-$0.12/sec (768p src); 1080p/2K/4K targets
Pika H3 Flex Reference to Video
pika/pika-h3-flex-reference
$0.06/sec 480p, $0.12/sec 768p, $0.15/sec 1080p, $0.16/sec 2k, $0.20/sec 4k (output+input video sec). Stems: $0.001/sec
HeyGen Instant Voice Clone
heygen/voice-clone
$0.0007/sec audio (clone-only runs: free)
HeyGen Text to Speech
heygen/text-to-speech
$0.0007/sec
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 Create Avatar?
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.