HeyGen Integration — ModuleX AI

Field	Description	Required	Format
HeyGen API Key	Your HeyGen API key from app.heygen.com/settings	Yes	`xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

create_talking_photo — Creates a talking photo video from a provided image, text, and voice

Parameters

string

required

Identifier of the talking photo to use

string

required

The text that the character will speak

string

required

Identifier of the voice to use

string

Title of the video

boolean

Set to true to use test mode (no credits charged, watermark added)

boolean

Set to true to create video with captions

string

Talking photo scale, value between 0 and 2.0 (default 1.0)

string

Talking photo crop style: square, circle

string

Talking photo talking style: stable, expressive

string

Talking photo expression style: default, happy

boolean

Whether to enhance the photo image

boolean

Whether to apply matting to the photo

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "video_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Video Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateTalkingPhotoOutput",
  "type": "object"
}

create_video_from_template — Generates a video from a selected template with optional variable overrides

Parameters

string

required

Identifier of the template to use

string

Title of the video

boolean

Set to true to use test mode (no credits charged, watermark added)

boolean

Set to true to create video with captions

object

Template variable overrides as a JSON object where keys are variable names and values are objects with variable properties

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "video_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Video Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateVideoFromTemplateOutput",
  "type": "object"
}

list_custom_events_options — Retrieves available options for webhook custom events

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "events": {
      "items": {
        "type": "string"
      },
      "title": "Events",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListCustomEventsOptionsOutput",
  "type": "object"
}

list_voice_id_options — Retrieves available voice options for video generation

Response

{
  "$defs": {
    "VoiceInfo": {
      "additionalProperties": false,
      "description": "A voice entry returned by the list voices endpoint.",
      "properties": {
        "voice_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Voice Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        }
      },
      "title": "VoiceInfo",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "voices": {
      "items": {
        "$ref": "#/$defs/VoiceInfo"
      },
      "title": "Voices",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListVoiceIdOptionsOutput",
  "type": "object"
}

retrieve_video_link — Fetches the status and download link for a specific HeyGen video

Parameters

string

required

Identifier of the HeyGen video to retrieve

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "video_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Video Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "video_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Video Url"
    },
    "thumbnail_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Thumbnail Url"
    },
    "duration": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Duration"
    },
    "caption_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Caption Url"
    }
  },
  "required": [
    "success"
  ],
  "title": "RetrieveVideoLinkOutput",
  "type": "object"
}

Using

Providers

Building

Tools

HeyGen Integration for AI Agents & Workflows

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Response

Response

Parameters

Response

Limits & Quotas

Browser Use

Amazon Alexa

ElevenLabs

Links

​Overview

​Authentication

​API Key Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Response

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Browser Use

Amazon Alexa

ElevenLabs

​Links

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Response

Response

Parameters

Response

Limits & Quotas

Related integrations

Links