GET

/v1/schemas/fal/video/fal-ai/heygen/avatar3/digital-twin

Accept:

kind inputactivity videohash 99bc8d0d…extracted Oct 9, 2026version currentsource upstream spec ↗

field	recorded source
schema	Source linked above. upstream-spec Source trace `7c6e85c102954e849f596a36daf7daec9698c349f221ea120bf3c25f589cfc60` { "fetchedAt": 1791522002, "extractorVersion": "1", "verifiedAt": null }

Request body

6 properties · 2 required · 2 $defs

property	type	description	constraints
voice*	TextVoice	Voice configuration for the character
character*	Character	Character configuration for the video
aspect_ratio	enum	Aspect ratio of the output video. Use '9:16' for portrait (vertical) videos, '16:9' for landscape, '1:1' for square, '4:5' for portrait social video, or '5:4' for landscape social video.	16:9 \| 9:16 \| 4:5 \| 5:4 \| 1:1 · default: "16:9"
audio_url	string	URL of an audio file for the avatar to lip-sync to. When provided, the avatar uses this audio instead of text-to-speech.	nullable
resolution	enum	Video resolution preset. Options: 360p, 480p, 540p, 720p, 1080p	360p \| 480p \| 540p \| 720p \| 1080p · default: "720p"
enable_safety_checker	boolean	Authorized callers may set false to request relaxed screening.	default: true

Types

2 $defs

Characterobject

avatar_style	enum	Style of the avatar display	normal \| circle \| closeUp · default: "closeUp"
avatar*	enum	ID of the avatar to use in the video	Abigail (Upper Body) \| Abigail Office Front \| Abigail Office Side \| Abigail Sofa Front \| Abigail Sofa Side \| Aditya in Brown blazer · +1280 more

TextVoiceobject

prompt	string	The text that the avatar will speak in the video	nullable
voice_id	string	Direct voice ID. When provided, this is used instead of looking up the voice by name.	nullable
voice	enum	Name of the voice to use for the avatar	Warm Pro Narrator \| Chill Brian \| Ivy \| John Doe \| Monika Sogam \| Hope · +96 more
speed	number	Speed of the speech (0.5 to 2.0)	0.5 ≤ n ≤ 2 · nullable

Validate a payload

before you spend tokens

shell

$ curl -X POST https://modelschemas.com/v1/validate \
    -d '{"provider":"fal","endpointId":"fal-ai/heygen/avatar3/digital-twin","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}