HeyGen Pro icon

HeyGen Pro

Create and monitor HeyGen avatar, template, and Video Agent videos

Video → Generate and Wait

AI-generated

Summary

Creates a HeyGen avatar video from text or an audio URL, then polls until rendering completes or fails. Choose an avatar and background, and optionally set the aspect ratio, resolution, and title.

Inputs

  • Avatar Type — Optionally filter the avatar picker by type: studio avatar, digital twin, or photo avatar.
  • Avatar (required) — Select the avatar look to use.
  • Input Mode — Choose Text or Audio URL. Text mode requires a script and voice; Audio URL mode requires a publicly accessible HTTP or HTTPS audio file.
  • Script (required) — Text for the avatar to speak; used in Text mode.
  • Voice (required) — Voice for the script; used in Text mode.
  • Audio URL (required) — Publicly accessible HTTP or HTTPS audio file; used in Audio URL mode.
  • 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.
  • Poll Interval (required) — Seconds between status checks (1–300; default 10).
  • Max Wait Time (required) — Maximum seconds to wait for rendering (10–86400; default 900).
  • Options — Optional aspect ratio (default Automatic), resolution (default 1080p), and title.

Output shape

A single item containing the completed video status record.

The record includes video_id, status, video_url, thumbnail_url, and duration; failure_code and failure_message may also be present. The operation errors if generation fails, times out, or HeyGen reports completion without a video URL. With Continue On Fail enabled, an error is returned as an item with an error field. Video backgrounds use HeyGen's legacy video generation endpoint.

Links

Discussion