Guide to HeyGen Template API

In this guide, we will explore how to use the HeyGen Template API to create and customize videos using JavaScript. This tutorial will provide step-by-step instructions, along with code examples, to help you integrate HeyGen's powerful video generation capabilities into your applications.

Introduction

HeyGen's Template API allows you to generate videos by customizing templates with dynamic content. This is particularly useful for creating personalized videos at scale.

Prerequisites

Before you begin, ensure you have the following:

An active HeyGen account
API key for authentication
Basic knowledge of JavaScript and Node.js

Step 1: Set Up Your Project

First, create a new Node.js project and install the necessary packages.

mkdir heygen-video-generator
cd heygen-video-generator
npm init -y
npm install axios

Step 2: Retrieve Your Templates

To start, you'll need to retrieve a list of your templates from HeyGen. This will help you identify the template ID you want to use.

const axios = require('axios');
 
async function getTemplates() {
  try {
    const response = await axios.get('https://api.heygen.com/v2/templates', {
      headers: {
        'accept': 'application/json',
        'x-api-key': '<your-api-key>'
      }
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error fetching templates:', error);
  }
}
 
getTemplates();

Step 3: Retrieve Video Elements

Once you have your template ID, you can retrieve the video elements for that specific template.

async function getTemplateElements(templateId) {
  try {
    const response = await axios.get(`https://api.heygen.com/v2/template/${templateId}`, {
      headers: {
        'accept': 'application/json',
        'x-api-key': '<your-api-key>'
      }
    });
    console.log(response.data);
  } catch (error) {
    console.error('Error fetching template elements:', error);
  }
}
 
getTemplateElements('<template_id>');

Step 4: Modify Template Elements and Generate Video

Now, modify the template elements and generate a new video.

async function generateVideo(templateId) {
  try {
    const response = await axios.post(`https://api.heygen.com/v2/template/${templateId}/generate`, {
      caption: false,
      title: 'New Video',
      variables: {
        first_name: {
          name: 'first_name',
          type: 'text',
          properties: {
            content: 'John'
          }
        }
      }
    }, {
      headers: {
        'X-Api-Key': '<your-api-key>',
        'Content-Type': 'application/json'
      }
    });
    console.log('Video generated:', response.data);
  } catch (error) {
    console.error('Error generating video:', error);
  }
}
 
generateVideo('<template_id>');

Conclusion

By following these steps, you can effectively use HeyGen's Template API to create customized videos. This guide provides a foundation for integrating video generation into your applications, allowing for dynamic and personalized content creation.

Reference: This guide is based on the HeyGen API documentation. For more details, visit HeyGen API Documentation by HeyGen.