Integration

HeyGen

Generate an approved HeyGen video as part of a follow-up workflow.

Description

AIM AI can be configured to request a HeyGen avatar video after a qualifying conversation. Templates, voices, delivery channels, consent, and the final message are confirmed before implementation.

Authentication

A HeyGen API key is required.
Exact templates, assets, and approved actions are confirmed during workflow scoping.

Supported Actions (8)

These are the operations this integration can perform after the required credentials and permissions are approved.

Generate videos (sync, async, or with callback)
Generate videos from templates
List avatars and get avatar details
List voices and voice locales
Get/poll video status
List videos
Delete videos
List templates and get template details

Examples

Use these representative payloads as a technical starting point, then replace the sample values with the approved workflow data.

HeyGen - Generate Video (Basic)

Representative workflow configuration for HeyGen - Generate Video (Basic).

JSON

{
  "automationType": "heygen",
  "nodeId": "heygen-generate-video-001",
  "nodeParams": {
    "action": "generate_video",
    "params": {
      "apiKey": "YOUR_HEYGEN_API_KEY",
      "avatar_id": "Abigail_expressive_2024112501",
      "script": {
        "input": "Hello, this is a test video generated from the HeyGen integration.",
        "type": "text"
      }
    }
  }
}

HeyGen - Generate Video (Sync with Polling)

Representative workflow configuration for HeyGen - Generate Video (Sync with Polling).

JSON

{
  "automationType": "heygen",
  "nodeId": "heygen-generate-video-sync-001",
  "nodeParams": {
    "action": "generate_video_sync",
    "params": {
      "apiKey": "YOUR_HEYGEN_API_KEY",
      "avatar_id": "Abigail_expressive_2024112501",
      "script": {
        "input": "Hello, this video will be generated synchronously.",
        "type": "text"
      },
      "pollIntervalMs": 2000,
      "timeoutMs": 300000
    }
  }
}

HeyGen - Get Avatar Details

Representative workflow configuration for HeyGen - Get Avatar Details.

JSON

{
  "automationType": "heygen",
  "nodeId": "heygen-get-avatar-details-001",
  "nodeParams": {
    "action": "get_avatar_details",
    "params": {
      "apiKey": "YOUR_HEYGEN_API_KEY",
      "avatar_id": "Abigail_expressive_2024112501"
    }
  }
}

HeyGen - List Voice Locales

Representative workflow configuration for HeyGen - List Voice Locales.

JSON

{
  "automationType": "heygen",
  "nodeId": "heygen-list-voice-locales-001",
  "nodeParams": {
    "action": "list_voice_locales",
    "params": {
      "apiKey": "YOUR_HEYGEN_API_KEY"
    }
  }
}

HeyGen - Get Video Status

Representative workflow configuration for HeyGen - Get Video Status.

JSON

{
  "automationType": "heygen",
  "nodeId": "heygen-get-video-status-001",
  "nodeParams": {
    "action": "get_video_status",
    "params": {
      "apiKey": "YOUR_HEYGEN_API_KEY",
      "video_id": "video_123456"
    }
  }
}

HeyGen - List Videos

Representative workflow configuration for HeyGen - List Videos.

JSON

{
  "automationType": "heygen",
  "nodeId": "heygen-list-videos-001",
  "nodeParams": {
    "action": "list_videos",
    "params": {
      "apiKey": "YOUR_HEYGEN_API_KEY",
      "limit": 50,
      "offset": 0
    }
  }
}

HeyGen - List Templates

Representative workflow configuration for HeyGen - List Templates.

JSON

{
  "automationType": "heygen",
  "nodeId": "heygen-list-templates-001",
  "nodeParams": {
    "action": "list_templates",
    "params": {
      "apiKey": "YOUR_HEYGEN_API_KEY"
    }
  }
}

HeyGen - Generate Video from Template

Representative workflow configuration for HeyGen - Generate Video from Template.

JSON

{
  "automationType": "heygen",
  "nodeId": "heygen-generate-video-from-template-001",
  "nodeParams": {
    "action": "generate_video_from_template",
    "params": {
      "apiKey": "YOUR_HEYGEN_API_KEY",
      "template_id": "template_123456",
      "variables": {
        "name": "John Doe",
        "company": "Acme Corp"
      },
      "dimension": {
        "width": 1920,
        "height": 1080
      },
      "caption": true,
      "title": "My Template Video"
    }
  }
}