API reference · HeyGen

heygen/heygen-avatar4/image-to-video

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

VIDEOAsyncOpen model
Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run
Model IDheygen/heygen-avatar4/image-to-video
01

Input Schema

7 parameters · 1 required · 6 optional

ParameterTypeRequiredDescription
imagestringRequiredURL of the image to animate. The image should contain a clear face.
audiostringOptionalURL of an audio file for the avatar to lip-sync to. When provided, overrides prompt and voice.
voicestringOptionalThe voice ID to use for the avatar. · Default: "Melissa"
promptstringOptionalThe text the avatar will speak
resolutionstringOptionalVideo resolution preset. · Options: 360p, 480p, 540p, 720p, 1080p · Default: "720p"
360p480p540p720p1080p
aspect_ratiostringOptionalAspect ratio of the output video. 'auto' preserves the source aspect ratio when available. · Options: 16:9, 9:16, 4:5, 5:4, 1:1, auto · Default: "16:9"
16:99:164:55:41:1auto
talking_stylestringOptionalTalking style: 'stable' for minimal movement, 'expressive' for more animation. · Options: stable, expressive · Default: "stable"
stableexpressive
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

  1. Submit — POST to /v1/run, receive an id
  2. Poll — GET /v1/run/{id} until status is completed, failed, or timeout
  3. Retrieve — Read outputs from the completed response
03

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "heygen/heygen-avatar4/image-to-video",
  "image": "https://v3b.fal.media/files/b/0a90062c/A7EIviZqNxZ2HAs0yHeZ6_77a05b99-8588-4ffc-90aa-be7f9d34e9d3.png",
  "voice": "Melissa",
  "prompt": "Hey friends! Welcome to the GPU force podcast and today we are going to discuss about the rising GPU cost!",
  "resolution": "720p",
  "aspect_ratio": "16:9",
  "talking_style": "stable"
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"