Avatars

List Look Templates

Returns the curated templates this workspace may apply with POST /v3/avatars/looks, so template ids can be discovered over the API instead of read out of the HeyGen app. Each item’s id is the template_id to send and its type is the type to send with it: look_pack for a Look Pack, which generates the number of looks in looks_count, or template for a single look template, which generates two. Packs are curated per gender, so filter with gender to get the variant matching your avatar. Enterprise custom packs assigned to the workspace are listed alongside the public ones. Flattened pack members are not listed separately.

GET

avatars

look-templates

List Look Templates

curl --request GET \
  --url https://api.heygen.com/v3/avatars/look-templates \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.heygen.com/v3/avatars/look-templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heygen.com/v3/avatars/look-templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.heygen.com/v3/avatars/look-templates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/avatars/look-templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "5a8e6be843ee4321a014946bf62aa322",
      "type": "look_pack",
      "looks_count": 5,
      "name": "Modern Corporate",
      "gender": "female",
      "preview_image_url": "https://resource2.heygen.ai/avatar_remix_template/modern_corporate_female/profile.png"
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

Authorizations

x-api-key

string

header

required

HeyGen API key. Obtain from your HeyGen dashboard.

Query Parameters

type

enum<string>

Filter by generation method: 'look_pack' for Look Packs, 'template' for single look templates. Omit for both.

Available options:

look_pack,

template

gender

enum<string>

Filter to templates built for 'male' or 'female'. Templates with no gender of their own are returned for either value. Omit for all.

Available options:

male,

female

limit

integer

default:20

Maximum number of items to return per page (1-50).

Required range: 1 <= x <= 50

token

string

Opaque cursor token for the next page.

Response

Successful response

data

LookTemplateItem · object[]

Show child attributes

has_more

boolean

Whether more pages are available

next_token

string | null

Opaque cursor for the next page

⌘I

List Look Templates

curl --request GET \
  --url https://api.heygen.com/v3/avatars/look-templates \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.heygen.com/v3/avatars/look-templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heygen.com/v3/avatars/look-templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.heygen.com/v3/avatars/look-templates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/avatars/look-templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "5a8e6be843ee4321a014946bf62aa322",
      "type": "look_pack",
      "looks_count": 5,
      "name": "Modern Corporate",
      "gender": "female",
      "preview_image_url": "https://resource2.heygen.ai/avatar_remix_template/modern_corporate_female/profile.png"
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

Video Agent

Brand

Avatars

Audio

Voices

Models

Videos

Templates

Video Translate

Lipsync

HyperFrames

User

API Keys

Webhooks

Assets

AI Clipping

Filler Word Removal

Batches

Video Translation Batches

Lipsync Batches

Asset Batches

List Look Templates

Authorizations

Query Parameters

Response