HeyGen Video Agent
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.
API Options
Platform-level options for task execution and delivery.
taskType
stringrequiredvalue: videoInferenceIdentifier for the type of task being performed
taskUUID
stringrequiredUUID v4UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.
outputType
stringdefault: URLVideo output type.
Allowed values1 value
outputFormat
stringdefault: MP4Specifies 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: 95Compression quality of the output. Higher values preserve quality but increase file size.
webhookURL
stringuriSpecifies 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
- WebhooksPLATFORM
- Webhooks
deliveryMethod
stringdefault: asyncDetermines 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
- Task PollingPLATFORM
uploadEndpoint
stringuriSpecifies 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
objectContent safety checking configuration for video generation.
Properties2 properties
safety»checkContentcheckContent
booleanEnable or disable content safety checking.
safety»modemode
stringdefault: noneSafety checking mode for video generation.
Allowed values3 values
- Disables checking.
- Checks key frames.
- Checks all frames.
ttl
integermin: 60Time-to-live (TTL) in seconds for generated content. Only applies when
outputTypeisURL.
includeCost
booleanInclude task cost in the response.
numberResults
integermin: 1max: 4default: 1Number 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.Core Parameters
Primary parameters that define the task output.
model
stringrequiredvalue: heygen:video-agent@0Identifier of the model to use for generation.
Learn more3 resources
positivePrompt
stringrequiredmin: 1max: 10000Text prompt describing elements to include in the generated output.
Learn more1 resource
- PromptsLEARN
- Prompts
Width of the generated media in pixels.
Learn more2 resources
Height of the generated media in pixels.
Learn more2 resources
duration
integermin: 5max: 300Length of the generated video in seconds. The total number of frames produced is determined by duration multiplied by the model's frame rate (fps).