↑↓ Navigate enter Open esc Close
Dashboard
MODEL ID heygen:video-agent@0
live

HeyGen Video Agent

HeyGen
by HeyGen

HeyGen Video Agent is an AI video production model that generates complete, multi-scene videos from a single text prompt. It automates the full production pipeline — scriptwriting, avatar selection, shot planning, B-roll integration, motion graphics, captions, and editing — producing broadcast-ready videos with consistent branding. The agent supports customizable avatars, voice cloning, and iterative editing without full regeneration, enabling scalable video content creation for marketing, training, and social media.

HeyGen Video Agent

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

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

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.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.

Properties 2 properties
safety » checkContent

checkContent

boolean default: false

Enable or disable content safety checking. When enabled, defaults to fast mode.

safety » mode

mode

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 outputType is URL.

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 » image

image

string

Image to animate as an avatar (UUID, URL, Data URI, or Base64).

inputs » avatar

avatar

string

HeyGen avatar ID for a photo or video avatar.

Allowed values 1287 values

Core Parameters

Primary parameters that define the task output.

model

string required value: heygen:video-agent@0

Identifier of the model to use for generation.

positivePrompt

string required min: 1 max: 10000

Text prompt describing elements to include in the generated output.

width

integer paired with height

Width of the generated media in pixels.

height

integer paired with width

Height of the generated media in pixels.

duration

integer min: 5 max: 300

Length of the generated video in seconds. The total number of frames produced is determined by duration multiplied by the model's frame rate (fps).

Ask AI
Send feedback