HeyGen

HeyGen is an AI Video Generator that lets you create explainer videos, marketing and sales promos, product demos, training and onboarding content.

Categories: Artificial Intelligence

Type: heyGen/v1

Connections

Version: 1

API Key

Properties

Name	Label	Type	Description	Required
key	API key	STRING		true

Connection Setup

Navigate to your dashboard.
Go to your account and click on Settings.
Click on Usage & Billing.
Click on HeyGen API.
Under API Token, click Activate.
Copy your API key and use it in ByteChef.

Actions

Generate Video From Template

Name: generateVideoFromTemplateAction

Generates a video based on the specified template.

Properties

Name	Label	Type	Description	Required
template_id	Template ID	STRING	The ID of the template.	true
folder_id	Folder ID	STRING	Unique identifier of the folder where the video is stored.	false
caption	Caption	BOOLEAN Options true, false	Whether to enable captions in the video.	false
enable_sharing	Enable Sharing	BOOLEAN Options true, false	Whether to make the video publicly shareable immediately after creation.	false

Example JSON Structure

{
  "label" : "Generate Video From Template",
  "name" : "generateVideoFromTemplateAction",
  "parameters" : {
    "template_id" : "",
    "folder_id" : "",
    "caption" : false,
    "enable_sharing" : false
  },
  "type" : "heyGen/v1/generateVideoFromTemplateAction"
}

Properties

Name	Type	Description
video_id	STRING	Unique identifier of the generated video.

Output Example

{
  "video_id" : ""
}

Translate Video

Name: translateVideoAction

Translates a video into one or more of 175+ supported languages with natural-sounding voice and accurate lip-sync.

Properties

Name	Label	Type	Description	Required
video_url	Video URL	STRING	URL of the video file to be translated. Supports direct video file URLs, Google Drive URLs, and YouTube URLs.	true
output_language	Output Language	STRING	The target language in which the video will be translated.	true
title	Title	STRING	Title of the video.	false
translate_audio_only	Translate Audio Only	BOOLEAN Options true, false	Translate only the audio; ideal for videos where the speaker is not visible, such as narrations, voiceovers, etc.	false

Example JSON Structure

{
  "label" : "Translate Video",
  "name" : "translateVideoAction",
  "parameters" : {
    "video_url" : "",
    "output_language" : "",
    "title" : "",
    "translate_audio_only" : false
  },
  "type" : "heyGen/v1/translateVideoAction"
}

Properties

Name	Type	Description
video_translate_id	STRING	Unique identifier of the translated video.

Output Example

{
  "video_translate_id" : ""
}

Upload Asset

Name: uploadAssetAction

Uploads a media file to the authenticated user's HeyGen account.

Properties

Name	Label	Type	Description	Required
fileEntry	File Entry	FILE_ENTRY	Asset file to upload.	true

Example JSON Structure

{
  "label" : "Upload Asset",
  "name" : "uploadAssetAction",
  "parameters" : {
    "fileEntry" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    }
  },
  "type" : "heyGen/v1/uploadAssetAction"
}

Properties

Name	Type	Description
id	STRING	Unique identifier of the uploaded asset.
name	STRING	ID assigned to the uploaded asset.
file_type	STRING	Type of the uploaded asset, for example, audio, video, or image.
folder_id	STRING	Unique identifier of the folder that contains the asset.
meta	STRING	Metadata related to the uploaded asset.
created_ts	INTEGER	Unix timestamp when the asset was created.
url	STRING	URL to access or download the uploaded file.
image_key	STRING	Image key for image-type assets.

Output Example

{
  "id" : "",
  "name" : "",
  "file_type" : "",
  "folder_id" : "",
  "meta" : "",
  "created_ts" : 1,
  "url" : "",
  "image_key" : ""
}

Triggers

Video Generation Completed

Name: videoGenerationCompletedTrigger

Triggers when a video generation completes successfully.

Type: DYNAMIC_WEBHOOK

Properties

Name	Type	Description
video_id	STRING
url	STRING
gif_download_url	STRING
video_share_page_url	STRING
folder_id	STRING
callback_id	STRING

JSON Example

{
  "label" : "Video Generation Completed",
  "name" : "videoGenerationCompletedTrigger",
  "type" : "heyGen/v1/videoGenerationCompletedTrigger"
}

Video Generation Failed

Name: videoGenerationFailedTrigger

Triggers when a video fails to generate.

Type: DYNAMIC_WEBHOOK

Properties

Name	Type	Description
video_id	STRING
msg	STRING
callback_id	STRING

JSON Example

{
  "label" : "Video Generation Failed",
  "name" : "videoGenerationFailedTrigger",
  "type" : "heyGen/v1/videoGenerationFailedTrigger"
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

On this page