HeyGen Avatar V
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.
API Options
Platform-level options for task execution and delivery.
-
taskType
string required value: videoInference -
Identifier for the type of task being performed
-
taskUUID
string required UUID v4 -
UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.
-
outputType
string default: URL -
Video output type.
Allowed values 1 value
-
outputFormat
string default: 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 values 3 values
-
outputQuality
integer min: 20 max: 99 default: 95 -
Compression quality of the output. Higher values preserve quality but increase file size.
-
webhookURL
string URI -
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 more 1 resource
- Webhooks PLATFORM
- Webhooks
-
deliveryMethod
string default: async -
Determines how the API delivers task results.
Allowed values 1 value
- Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse. Required for long-running tasks like video generation.
Learn more 1 resource
- Task Polling PLATFORM
-
uploadEndpoint
string URI -
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.jpgThe 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.
Properties 2 properties
-
safety»checkContentcheckContent
boolean default: false -
Enable or disable content safety checking. When enabled, defaults to
fastmode.
-
safety»modemode
string default: none -
Safety checking mode for video generation.
Allowed values 3 values
- Disables checking.
- Checks key frames.
- Checks all frames.
-
-
ttl
integer min: 60 -
Time-to-live (TTL) in seconds for generated content. Only applies when
outputTypeisURL.
-
includeCost
boolean default: false -
Include task cost in the response.
-
numberResults
integer min: 1 max: 4 default: 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 object.-
inputs»audioaudio
string -
Audio input (UUID or URL).
-
inputs»avataravatar
string required -
HeyGen avatar ID for a photo or video avatar.
Allowed values 500 values
-
inputs»backgroundbackground
string -
Background image for the generated video (UUID, URL, Data URI, or Base64).
Core Parameters
Primary parameters that define the task output.
-
model
string required value: heygen:avatar@5 -
Identifier of the model to use for generation.
-
width
integer paired with height -
Width of the generated media in pixels.
-
height
integer paired with width -
Height of the generated media in pixels.
-
speech
object -
Settings for speech generation.
Properties 6 properties
-
speech»texttext
string min: 1 max: 5000 -
Text to convert to speech.
-
speech»voicevoice
string default: auto -
Voice identifier to use. Set to
autofor automatic selection.Allowed values 2300 values
-
speech»languagelanguage
string min: 1 -
Language code for speech generation.
Allowed values 186 values
-
speech»volumevolume
float min: 0 max: 1 step: 0.1 default: 1 -
Volume level of the generated speech.
-
speech»speedspeed
float min: 0.5 max: 1.5 step: 0.01 default: 1 -
Playback speed of the generated speech.
-
speech»pitchpitch
float min: -50 max: 50 step: 0.1 default: 0 -
Pitch adjustment for the voice.
-
Settings
Technical parameters to fine-tune the inference process. These must be nested inside the settings object.
settings object.-
settings»backgroundColorbackgroundColor
string -
Hex color code for solid background (e.g. #ff0000).
-
settings»captioncaption
boolean default: false -
Enable captions. When true, returns a sidecar SRT file and burns captions into the rendered video.
-
settings»fitfit
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 values 2 values
-
settings»removeBackgroundremoveBackground
boolean default: false -
Remove the avatar background. Video avatars must be trained with matting enabled.