Jump to Content

Developer Guide API Reference Updates Discussions Feature Requests

API Reference

Developer Guide API Reference Updates Discussions Feature Requests

All

Pages

Start typing to search…

Overview

Authentication
API Limits and Credit Consumption Costs
Postman Collections
Error Responses

Video Generation

Create Avatar Video (V2)post
Retrieve Video Status/Detailsget
Create a WebM Videopost
Create Avatar IV Videopost

PHOTO AVATAR Generation

Generate Photo Avatar Photospost
Check Photo/Look Generation Statusget
Create Photo Avatar Grouppost
Add Looks to Photo Avatar Grouppost
Train Photo Avatar Grouppost
Get Training Job Statusget
Generate Photo Avatar Lookspost
Add Motionpost
Add Sound Effectpost
Photo Avatar Detailsget
Upscale an Avatarpost
Delete Photo Avatardel
Delete Photo Avatar Groupdel

Video Avatar Generation

Submit Video Avatar Creation Requestpost
Check Video Avatar Generation Statusget
Delete Video Avatardel

video translation

List Supported Languagesget
Translate Videopost
Check Translation Statusget
Video Translate Captionget
Generate Proofreadpost
Check Proofread Statusget
Download Proofread SRTget
Upload Proofread SRTpost
Translate Video from Proofreadpost

templates

List Templatesget
Retrieve Template Detailsget
- Retrieve Template Details (V3)get
Generate Video from Templatepost

Video Management

Retrieve Video Listget
Retrieve Sharable Video URLpost
Delete an Avatar Videodel

Avatar Management

List All Avatar Groupsget
List All Avatars in One Avatar Groupget
List All Avatars (V2)get
Retrieve Avatar Detailsget

Voice Management

List All Voices (V2)get
List All Locales for Voicesget
List Brand Voicesget
Update Brand Voicepost

STREAMING API

New Sessionpost
Start Sessionpost
List Sessions (Active)get
List Sessions (History)get
Send Taskpost
Close Sessionpost
Interrupt Taskpost
Create Session Tokenpost
List Streaming Avatarsget
Keep Alivepost
WSS Audio to Video API (Beta)

Streaming API Knowledge Base

List Knowledge Basesget
Create a Knowledge Basepost
Update Knowledge Basepost
Delete Knowledge Basepost

User

Get Remaining Quotaget
Get Current User Informationget

Assets

Upload Assetpost
List Assetsget
Delete Assetpost

WEBHOOK

List Webhook Endpointsget
Add a Webhook Endpointpost
Update a Webhook Endpointpatch
Delete a Webhook Endpointdel
List Available Webhook Eventsget

Folders

List Foldersget
Create Folderpost
Update Folder (Rename Only)post
Trash Folderpost
Restore Folderpost

[Beta] Voice Audio Preview

Generate Voice Audio Previewpost

Powered by

Postman Collections

Easily test and integrate HeyGen APIs with pre-configured Postman collections