GET
/v1/schemas/fal/video/fal-ai%2Fheygen%2Favatar5%2Fdigital-twin
Accept:
Request body
12 properties · 0 required · 2 $defs| property | type | description | constraints |
|---|---|---|---|
| avatar | string | Name of the Avatar V-eligible avatar to use. | nullable |
| aspect_ratio | enum | Aspect ratio of the output video. Supported values: '16:9', '9:16', '4:5', '5:4', '1:1', and 'auto'. 'auto' preserves the source aspect ratio when HeyGen can read it, falling back to '16:9' otherwise. | 16:9 | 9:16 | 4:5 | 5:4 | 1:1 | auto · default: "16:9" |
| caption | boolean | Generate a sidecar SRT caption file alongside the video. | default: false |
| watermark | AvatarVWatermark | Watermark configuration for Avatar V videos. | nullable |
| audio_url | string | HTTP(S) URL of an audio file for the avatar to lip-sync to. When provided, the avatar uses this audio instead of text-to-speech and ``prompt``/``voice`` are ignored. | nullable |
| background | AvatarVBackground | Background configuration for Avatar V videos. | nullable |
| prompt | string | Text the avatar will speak. Required when ``audio_url`` is not provided. | nullable |
| voice | enum | Name of the text-to-speech voice to use for the avatar when ``audio_url`` is not provided. | Warm Pro Narrator | Chill Brian | Ivy | John Doe | Monika Sogam | Hope · +96 more · default: "Warm Pro Narrator" |
| resolution | enum | Output resolution preset. | 720p | 1080p | 4k · default: "720p" |
| fit | enum | How the avatar fits within the output frame. 'contain' keeps the full avatar in view (may letterbox); 'cover' fills the frame (may crop). | contain | cover · default: "cover" |
| output_format | enum | Output container format. 'webm' produces a transparent video (automatically removes the background) and ignores the ``background`` field. | mp4 | webm · default: "mp4" |
| remove_background | boolean | Remove the avatar's background. Requires a matting-enabled avatar. | default: false |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"fal","endpointId":"fal-ai/heygen/avatar5/digital-twin","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}