Quick Start

Get started with HeyGen API.

Welcome to HeyGen! 👋

This guide shows you how to build videos programmatically with AI avatars and voices, translate them into other languages, or even power real-time streaming avatars for interactive use cases, and more.

Getting Started with HeyGen APIs

This Quick Start guide is designed to give you just enough orientation to start experimenting. It covers:

  • How to configure HeyGen authentication
  • How to use the HeyGen Postman collection
  • Links to advanced guides and recipes.
📘

Note:

The HeyGen API is available as a standalone service, separate from the HeyGen App.

  • Your HeyGen App plan - Free, Creator, Team, or Enterprise - controls what you can access in the HeyGen web application.
  • All HeyGen App users automatically receive Free Trial API access, which includes Video Generation, Video Translation, and Interactive Avatar endpoints.
  • For higher usage, the API offers three paid subscription tiers: Pro, Scale, and Enterprise.

For more information on pricing and usage, please refer to our limits page.

Step 1: Obtain your API Key

  1. Register or sign in to your HeyGen account. This is the first step to make professional avatar videos by leveraging HeyGen's powerful AI capabilities.

  2. Go to Settings > Subscriptions & API > HeyGen API > API token.

You will use this key in all API requests.

❗️

Caution

Keep your API token secure. Do not expose it in client-side code. Store it in environment variables or a secrets manager.

Every request to the HeyGen API must be authenticated with an API key. You need to include the key in the request header as X-API-KEY.

📘

Note:

For more information on:

  • Use of API key, see the Authentication page.
  • Usage quotas, request limits, and subscription tiers, see the Limits page.

Step 2: Try the API in docs, Postman, or your client

You can run HeyGen API requests in several ways:

  • Directly in the API docs: Each endpoint in the HeyGen API Reference guide offers an interactive console to the right, where you can enter your API key and try requests immediately.
  • Postman Collection: Import the official HeyGen Postman Collection to explore request templates you can fill in with your own values and run instantly.
  • Your own terminal or client: Send requests from your terminal or any HTTP client.

Step 3: Explore the Use Cases

RecipeDescription
Create an Avatar Video (V2)Create an avatar video using selected avatars and voices
Generate Video from TemplateGenerate a video from an existing template by updating text, image, or voice variables.
Translate Video in Any LanguageTranslate existing videos into one or more target languages using the HeyGen Video Translate API.
Proofread Video CaptionsFetch, proofread, download, and generate translated video captions seamlessly.

Explore our developer guides

Now that you’ve completed the Quick Start, explore more specialized guides to deepen your understanding of HeyGen APIs and integrations.