↑↓ Navigateenter Openesc Close
Dashboard
MODEL IDheygen:avatar@5
live

HeyGen Avatar V

HeyGen
by HeyGen

HeyGen Avatar V is an avatar video generation model for talking digital twins and other eligible registered avatar looks. It improves identity preservation, lip sync accuracy, facial expressiveness, and motion coherence across angle changes, scene changes, and long-form videos, making it well suited to presenter, training, and localization workflows where avatar stability matters.

HeyGen Avatar V

API Options

Platform-level options for task execution and delivery.

taskType

stringrequiredvalue: videoInference

Identifier for the type of task being performed

taskUUID

stringrequiredUUID v4

UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

outputType

stringdefault: URL

Video output type.

Allowed values1 value

outputFormat

stringdefault: MP4

Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.

  • `MP4`: Widely supported video container (H.264), recommended for general use.
  • `WEBM`: Optimized for web delivery.
  • `MOV`: QuickTime format, common in professional workflows (Apple ecosystem).
Allowed values3 values

outputQuality

integermin: 20max: 99default: 95

Compression quality of the output. Higher values preserve quality but increase file size.

webhookURL

stringURI

Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.

Learn more1 resource

deliveryMethod

stringdefault: async

Determines how the API delivers task results.

Allowed values1 value
Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse. Required for long-running tasks like video generation.
Learn more1 resource

uploadEndpoint

stringURI

Specifies a URL where the generated content will be automatically uploaded using the HTTP PUT method. The raw binary data of the media file is sent directly as the request body. For secure uploads to cloud storage, use presigned URLs that include temporary authentication credentials.

Common use cases:

  • Cloud storage: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.
  • CDN integration: Upload to content delivery networks for immediate distribution.
// S3 presigned URL for secure upload
https://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600

// Google Cloud Storage presigned URL
https://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789

// Custom storage endpoint
https://storage.example.com/uploads/generated-image.jpg

The content data will be sent as the request body to the specified URL when generation is complete.

safety

object

Content safety checking configuration for video generation.

Properties2 properties
safety » checkContent

checkContent

booleandefault: false

Enable or disable content safety checking.

safety » mode

mode

stringdefault: none

Safety checking mode for video generation.

Allowed values3 values
Disables checking.
Checks key frames.
Checks all frames.

ttl

integermin: 60

Time-to-live (TTL) in seconds for generated content. Only applies when outputType is URL.

includeCost

booleandefault: false

Include task cost in the response.

numberResults

integermin: 1max: 4default: 1

Number of results to generate. Each result uses a different seed, producing variations of the same parameters.

Inputs

Input resources for the task (images, audio, etc). These must be nested inside the inputs object.

inputs » audio

audio

string

Audio input (UUID or URL).

inputs » avatar

avatar

stringrequired

HeyGen avatar ID for a photo or video avatar.

Allowed values500 values
inputs » background

background

string

Background image for the generated video (UUID, URL, Data URI, or Base64).

Core Parameters

Primary parameters that define the task output.

model

stringrequiredvalue: heygen:avatar@5

Identifier of the model to use for generation.

Learn more3 resources

width

integerrequired*paired with height

Width of the generated media in pixels.

Learn more2 resources

height

integerrequired*paired with width

Height of the generated media in pixels.

Learn more2 resources

resolution

stringdefault: 1080p

Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input.

Allowed values3 values

speech

objectrequired*

Settings for speech generation.

Properties6 properties
speech » text

text

stringmin: 1max: 5000

Text to convert to speech.

speech » voice

voice

string

Voice identifier to use for speech generation.

Allowed values2300 values
speech » language

language

stringmin: 1

Language code for speech generation.

Allowed values186 values
speech » volume

volume

floatmin: 0max: 1step: 0.1default: 1

Volume level of the generated speech.

speech » speed

speed

floatmin: 0.5max: 1.5step: 0.01default: 1

Playback speed of the generated speech.

speech » pitch

pitch

floatmin: -50max: 50step: 0.1default: 0

Pitch adjustment for the voice.

Settings

Technical parameters to fine-tune the inference process. These must be nested inside the settings object.

settings » backgroundColor

backgroundColor

string

Hex color code for solid background (e.g. #ff0000).

settings » caption

caption

booleandefault: false

Enable captions. When true, returns a sidecar SRT file and burns captions into the rendered video.

settings » fit

fit

string

How the avatar is scaled to the output canvas. 'cover' scales to fill (may crop edges), 'contain' scales to fit entirely (may show background). When omitted, the server picks the best option based on source and canvas orientations.

Allowed values2 values
settings » removeBackground

removeBackground

booleandefault: false

Remove the avatar background. Video avatars must be trained with matting enabled.

Ask AI
Send feedback