Back

Find an avatar

This query returns a matching HeyGen avatar, including its ID, so the "Generate an avatar video" action can use it.

Developer info

API endpoint slug: heygen.find_avatar
Runtime method: performQuery("heygen.find_avatar"}

Query fields

Name contains Text input > Other

Label: Name contains
Helper text: Optionally, part of the avatar name to match.
Slug: name_contains
Required: false
Can have default value: true

Gender Dropdown list

Label: Gender
Helper text: Optionally narrow by gender (best-effort). A name match takes precedence and is returned even if its gender can't be determined.
Slug: gender
Required: true
Can have default value: true

Ingredients

Avatar The avatar's ID. Feed this into the Generate an avatar video action's Avatar ID field.

Slug: avatar_id
Filter code: Heygen.findAvatar.AvatarId
Type: String
Example: Hello World!

Avatar name The avatar's display name.

Slug: avatar_name
Filter code: Heygen.findAvatar.AvatarName
Type: String
Example: Hello World!

Gender The avatar's gender.

Slug: gender
Filter code: Heygen.findAvatar.Gender
Type: String
Example: Hello World!

Preview image url A preview image of the avatar.

Slug: preview_image_url
Filter code: Heygen.findAvatar.PreviewImageUrl
Type: Image URL
Example: https://example.com/image.jpg