Actions8
Video → Create Avatar Video
AI-generatedSummary
Create a HeyGen avatar video from a selected avatar look, using either a text script and voice or an audio file URL, with a color, image, or video background. Return the new video ID and status, or wait for rendering to finish if using the node’s Generate and Wait operation.
Inputs
- Avatar Type — Optionally filter the avatar picker to studio avatars, digital twins, or photo avatars.
- Avatar (required) — Select the avatar look to use; its look ID is sent to HeyGen.
- Input Mode — Choose Text or Audio URL. Text requires a script and voice; Audio URL requires a publicly accessible HTTP or HTTPS audio file.
- Script (required) — Text for the avatar to speak when Input Mode is Text.
- Voice (required) — Voice to use for text input, selected from the HeyGen voice library.
- Audio URL (required) — Publicly accessible HTTP or HTTPS audio file used when Input Mode is Audio URL.
- Background Type — Choose a solid color, image URL, or video URL background.
- Background Color (required) — Hex color for a Color background.
- Background Image URL (required) — HTTP or HTTPS image URL for an Image URL background.
- Background Video URL (required) — HTTP or HTTPS video URL for a Video URL background.
- Options — Optionally set aspect ratio (automatic by default), resolution (1080p by default), and a video title.
Output shape
A single record per input item containing video_id and status; with Generate and Wait, a record containing the completed video status and output URLs.
Create Avatar Video submits the render and returns its ID with the API status, defaulting to processing when none is provided. Generate and Wait polls until completion or failure, subject to its poll interval and maximum wait time. Video backgrounds use HeyGen’s v2 generation endpoint; other backgrounds use v3.