Skip to content

HeyGen Avatar 4 Image to Video

POST/v1/run

Heygen Avatar4 is HeyGen's image-to-video AI model. Bring static images to life with fluid animation, consistent character motion, and professional-grade video output.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to heygen/heygen-avatar4/image-to-video.

Default: heygen/heygen-avatar4/image-to-video

Optional<string>prompt

The text the avatar will speak

stringimagerequired

URL of the image to animate. The image should contain a clear face.

Optional<string>audio

URL of an audio file for the avatar to lip-sync to. When provided, overrides prompt and voice.

Optional<string>aspect_ratio

Aspect ratio of the output video. 'auto' preserves the source aspect ratio when available.

Allowed values: 16:9, 9:16, 4:5, 5:4, 1:1, auto

Default: 16:9

Optional<string>voice

The voice ID to use for the avatar.

Default: Melissa

Optional<string>resolution

Video resolution preset.

Allowed values: 360p, 480p, 540p, 720p, 1080p

Default: 720p

Optional<string>talking_style

Talking style: 'stable' for minimal movement, 'expressive' for more animation.

Allowed values: stable, expressive

Default: stable

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: image-to-video

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async