Back

Generate an avatar video

This action will submit a script to be rendered into a talking-avatar video using a chosen avatar and voice; the finished video is delivered by the "A video finished rendering" trigger.

Developer info

API endpoint slug: heygen.generate_avatar_video
Filter code method: Heygen.generateAvatarVideo.skip(string?: reason)
Runtime method: runAction("heygen.generate_avatar_video", {})

Action fields

Script Text input

Label: What should the avatar say?
Helper text: The text the avatar will speak in the video. Each generated video uses HeyGen API credits.
Slug: script
Required: true
Can have default value: true
Filter code method: Heygen.generateAvatarVideo.setScript(string: script)

Owned avatar Dropdown list

Label: Your avatar
Helper text: Pick one of your own HeyGen avatars. Takes precedence over Avatar ID below.
Slug: owned_avatar_id
Required: false
Can have default value: false

Avatar Text input > Other

Label: Avatar ID
Helper text: An avatar's ID from the "Find an avatar" query, or a pasted HeyGen photo-avatar ID (classic studio avatars aren't supported). Used when "Your avatar" is left blank.
Slug: avatar_id
Required: false
Can have default value: true
Filter code method: Heygen.generateAvatarVideo.setAvatarId(string: avatar_id)

Owned voice Dropdown list

Label: Your voice
Helper text: Pick one of your own HeyGen voices. Takes precedence over Voice ID below.
Slug: owned_voice_id
Required: false
Can have default value: false

Voice Text input > Other

Label: Voice ID
Helper text: A voice's ID from the "Find a voice" query, or pasted from HeyGen. If both voice fields are blank, the avatar's default voice is used.
Slug: voice_id
Required: false
Can have default value: true
Filter code method: Heygen.generateAvatarVideo.setVoiceId(string: voice_id)

Aspect ratio Dropdown list

Label: Aspect ratio
Helper text: The shape of the finished video.
Slug: aspect_ratio
Required: false
Can have default value: true
Filter code method: Heygen.generateAvatarVideo.setAspectRatio(string: aspect_ratio)