Avatars
List Avatar Looks
Returns a paginated list of avatar looks (outfits, poses, styles). Filterable by group_id, avatar_type, and ownership. The look id is the avatar_id to pass when creating a video.
GET
/
v3
/
avatars
/
looks
List Avatar Looks
curl --request GET \
--url https://api.heygen.com/v3/avatars/looks \
--header 'x-api-key: <api-key>'import requests
url = "https://api.heygen.com/v3/avatars/looks"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.heygen.com/v3/avatars/looks', 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/looks",
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/looks"
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))
}HttpResponse<String> response = Unirest.get("https://api.heygen.com/v3/avatars/looks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heygen.com/v3/avatars/looks")
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": "lk_abc123",
"name": "Business Suit",
"avatar_type": "photo_avatar",
"group_id": "ag_abc123",
"preview_image_url": "https://files.heygen.ai/look/business_preview.jpg",
"preview_video_url": "https://files.heygen.ai/look/business_preview.mp4",
"gender": "female",
"tags": [
"business",
"formal"
],
"default_voice_id": "1bd001e7e50f421d891986aad5c8bbd2",
"supported_api_engines": [
"avatar_v",
"avatar_iv",
"avatar_iii"
],
"image_width": 1920,
"image_height": 1080,
"preferred_orientation": "portrait",
"status": "completed",
"error": {
"code": "training_failed",
"message": "Footage duration must be between 15s and 600s"
}
}
],
"has_more": true,
"next_token": "<string>"
}{
"error": {
"code": "invalid_parameter",
"message": "'limit' must be between 1 and 50.",
"param": "limit",
"doc_url": null
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid or expired API key. Verify your x-api-key header.",
"param": null,
"doc_url": null
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Retry after the duration specified in the Retry-After header.",
"param": null,
"doc_url": null
}
}Authorizations
ApiKeyAuthBearerAuth
HeyGen API key. Obtain from your HeyGen dashboard.
Query Parameters
Filter looks to a specific avatar group. Returns only looks belonging to this group.
Filter by avatar type: 'studio_avatar', 'digital_twin', or 'photo_avatar'.
Available options:
studio_avatar, digital_twin, photo_avatar Filter by ownership: 'public' for preset avatars, or 'private' for your own. Omit for all.
Available options:
public, private Maximum number of items to return per page (1-50).
Required range:
1 <= x <= 50Opaque cursor token for the next page.
⌘I
List Avatar Looks
curl --request GET \
--url https://api.heygen.com/v3/avatars/looks \
--header 'x-api-key: <api-key>'import requests
url = "https://api.heygen.com/v3/avatars/looks"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.heygen.com/v3/avatars/looks', 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/looks",
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/looks"
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))
}HttpResponse<String> response = Unirest.get("https://api.heygen.com/v3/avatars/looks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heygen.com/v3/avatars/looks")
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": "lk_abc123",
"name": "Business Suit",
"avatar_type": "photo_avatar",
"group_id": "ag_abc123",
"preview_image_url": "https://files.heygen.ai/look/business_preview.jpg",
"preview_video_url": "https://files.heygen.ai/look/business_preview.mp4",
"gender": "female",
"tags": [
"business",
"formal"
],
"default_voice_id": "1bd001e7e50f421d891986aad5c8bbd2",
"supported_api_engines": [
"avatar_v",
"avatar_iv",
"avatar_iii"
],
"image_width": 1920,
"image_height": 1080,
"preferred_orientation": "portrait",
"status": "completed",
"error": {
"code": "training_failed",
"message": "Footage duration must be between 15s and 600s"
}
}
],
"has_more": true,
"next_token": "<string>"
}{
"error": {
"code": "invalid_parameter",
"message": "'limit' must be between 1 and 50.",
"param": "limit",
"doc_url": null
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid or expired API key. Verify your x-api-key header.",
"param": null,
"doc_url": null
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Retry after the duration specified in the Retry-After header.",
"param": null,
"doc_url": null
}
}