HeyGen Avatar V Digital Twin

{
  "model_id": "fal-ai/heygen/avatar5/digital-twin",
  "prompt": "Hi there! I'm here to introduce our new product line — let me walk you through the key features.",
  "avatar_id": "",
  "voice_id": ""
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://www.artemotion.ai/api/v1/models?id=fal-ai%2Fheygen%2Favatar5%2Fdigital-twin",
  "title": "HeyGen Avatar V Digital Twin generation request",
  "description": "Request body accepted by POST /api/v1/generate for fal-ai/heygen/avatar5/digital-twin.",
  "type": "object",
  "properties": {
    "model_id": {
      "type": "string",
      "const": "fal-ai/heygen/avatar5/digital-twin",
      "description": "ArtEmotion model identifier."
    },
    "extra": {
      "type": "object",
      "additionalProperties": true,
      "description": "Model-specific settings may also be nested here."
    },
    "max_credits": {
      "type": "number",
      "minimum": 1,
      "description": "Reject before submission if the estimated list price exceeds this cap."
    },
    "webhook_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048
    },
    "webhook_secret": {
      "type": "string",
      "maxLength": 512
    },
    "folder_id": {
      "type": "string"
    },
    "prompt": {
      "type": "string"
    },
    "avatar_id": {
      "title": "Digital Twin ID",
      "description": "Your HeyGen Digital Twin look id — GET /v3/avatars/looks?avatar_type=digital_twin. Required.",
      "default": "",
      "type": "string"
    },
    "voice_id": {
      "title": "Voice ID",
      "description": "Your HeyGen voice_id (GET /v2/voices) — the voice the twin speaks your script in. Required.",
      "default": "",
      "type": "string"
    },
    "voice_speed": {
      "title": "Voice Speed",
      "description": "Speech speed multiplier (0.5–1.5).",
      "default": 1,
      "type": "number",
      "minimum": 0.5,
      "maximum": 1.5,
      "multipleOf": 0.05
    },
    "voice_pitch": {
      "title": "Voice Pitch",
      "description": "Voice pitch adjustment (-50 to 50).",
      "default": 0,
      "type": "number",
      "minimum": -50,
      "maximum": 50,
      "multipleOf": 1
    },
    "voice_volume": {
      "title": "Voice Volume",
      "description": "Voice audio volume. 1.0 = full, 0.0 = silent — useful when mixing with background audio.",
      "default": 1,
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "multipleOf": 0.05
    },
    "remove_background": {
      "title": "Remove Background",
      "description": "Render with a removed/transparent background (overrides the Background setting).",
      "default": false,
      "type": "boolean"
    },
    "fit": {
      "title": "Fit",
      "description": "How the avatar is fitted to the output canvas. Auto picks based on source/canvas orientation.",
      "default": "",
      "type": "string",
      "enum": [
        "",
        "cover",
        "contain"
      ]
    },
    "locale": {
      "title": "Locale",
      "description": "Optional BCP-47 locale for multilingual delivery (e.g. en-US, es-ES). Leave empty to auto-detect.",
      "default": "",
      "type": "string"
    },
    "bg_type": {
      "title": "Background Type",
      "description": "Background behind the avatar (ignored when Remove Background is on).",
      "default": "color",
      "type": "string",
      "enum": [
        "color",
        "image"
      ]
    },
    "bg_value": {
      "title": "Background",
      "description": "Hex color (e.g. #1144FF) for 'color', or HTTP(S) image URL for 'image'.",
      "default": "",
      "type": "string"
    },
    "output_format": {
      "title": "Output Format",
      "description": "Video output format.",
      "default": "mp4",
      "type": "string",
      "enum": [
        "mp4",
        "webm"
      ]
    },
    "aspect_ratio": {
      "type": "string",
      "enum": [
        "16:9",
        "9:16",
        "4:5",
        "5:4",
        "1:1"
      ]
    },
    "resolution": {
      "type": "string",
      "enum": [
        "720p",
        "1080p",
        "4k"
      ]
    }
  },
  "required": [
    "model_id",
    "prompt",
    "avatar_id",
    "voice_id"
  ],
  "additionalProperties": false
}