List Avatars

curl -X GET "https://app.hoox.video/api/public/v1/avatar/list?gender=male&place=podcast&accessories=microphone" \
  -H "Authorization: Bearer your_api_key"

import requests

url = "https://app.hoox.video/api/public/v1/avatar/list"
params = {"gender": "male", "place": "podcast", "accessories": "microphone"}
headers = {"Authorization": "Bearer your_api_key"}

response = requests.get(url, headers=headers, params=params)
print(response.json())

const url = new URL('https://app.hoox.video/api/public/v1/avatar/list');
url.searchParams.set('gender', 'male');
url.searchParams.set('place', 'podcast');
url.searchParams.set('accessories', 'microphone');

const response = await fetch(url, {
  headers: {
    'Authorization': 'Bearer your_api_key'
  }
});

const data = await response.json();
console.log(data);

[
  {
    "id": "look_id",
    "avatar_id": "avatar_id_1",
    "avatar_name": "Avatar name",
    "look_name": "Look name",
    "gender": "male",
    "age_range": "adult",
    "ethnicity": "white-western-european",
    "hair_color": "brown",
    "place": "studio",
    "accessories": ["microphone"],
    "action": "presenting",
    "emotion": "focused",
    "selfie": false,
    "format": "vertical",
    "thumbnail": "https://cdn.example.com/thumbnail.jpg",
    "preview": null,
    "model_available": ["premium", "ultra", "veo-3", "veo-3-fast", "veo-3-lite", "omni-flash", "ora-lite", "ora-standard", "ora-pro", "seedance-2", "seedance-2-fast", "seedance-2-1080p", "seedance-2-5"]
  },
  {
    "id": "look_id_2",
    "avatar_id": "avatar_id_1",
    "avatar_name": "Avatar name",
    "look_name": "Another Look",
    "gender": "female",
    "age_range": "young_adult",
    "ethnicity": "east-asian",
    "hair_color": "black",
    "place": "office",
    "accessories": ["laptop"],
    "action": "working",
    "emotion": "neutral",
    "selfie": false,
    "format": "horizontal",
    "thumbnail": "https://cdn.example.com/thumbnail2.jpg",
    "preview": "https://cdn.example.com/preview2.mp4",
    "model_available": ["standard"]
  }
]

GET

api

public

avatar

list

curl -X GET "https://app.hoox.video/api/public/v1/avatar/list?gender=male&place=podcast&accessories=microphone" \
  -H "Authorization: Bearer your_api_key"

import requests

url = "https://app.hoox.video/api/public/v1/avatar/list"
params = {"gender": "male", "place": "podcast", "accessories": "microphone"}
headers = {"Authorization": "Bearer your_api_key"}

response = requests.get(url, headers=headers, params=params)
print(response.json())

const url = new URL('https://app.hoox.video/api/public/v1/avatar/list');
url.searchParams.set('gender', 'male');
url.searchParams.set('place', 'podcast');
url.searchParams.set('accessories', 'microphone');

const response = await fetch(url, {
  headers: {
    'Authorization': 'Bearer your_api_key'
  }
});

const data = await response.json();
console.log(data);

[
  {
    "id": "look_id",
    "avatar_id": "avatar_id_1",
    "avatar_name": "Avatar name",
    "look_name": "Look name",
    "gender": "male",
    "age_range": "adult",
    "ethnicity": "white-western-european",
    "hair_color": "brown",
    "place": "studio",
    "accessories": ["microphone"],
    "action": "presenting",
    "emotion": "focused",
    "selfie": false,
    "format": "vertical",
    "thumbnail": "https://cdn.example.com/thumbnail.jpg",
    "preview": null,
    "model_available": ["premium", "ultra", "veo-3", "veo-3-fast", "veo-3-lite", "omni-flash", "ora-lite", "ora-standard", "ora-pro", "seedance-2", "seedance-2-fast", "seedance-2-1080p", "seedance-2-5"]
  },
  {
    "id": "look_id_2",
    "avatar_id": "avatar_id_1",
    "avatar_name": "Avatar name",
    "look_name": "Another Look",
    "gender": "female",
    "age_range": "young_adult",
    "ethnicity": "east-asian",
    "hair_color": "black",
    "place": "office",
    "accessories": ["laptop"],
    "action": "working",
    "emotion": "neutral",
    "selfie": false,
    "format": "horizontal",
    "thumbnail": "https://cdn.example.com/thumbnail2.jpg",
    "preview": "https://cdn.example.com/preview2.mp4",
    "model_available": ["standard"]
  }
]

Overview

This endpoint retrieves a list of available avatar looks. It returns looks from your space first (if any), followed by looks from the public catalog. Results can be filtered by avatar and look metadata.

Authentication

This endpoint requires API key authentication. Include your API key in the Authorization header.

Query Parameters

enum

Filter by gender. Available values: male, female.

enum

Filter by avatar age range. Accepts a comma-separated list. Available values: senior, adult, young_adult, adolescent.

enum

Filter by avatar ethnicity. Accepts a comma-separated list. Available values: black-or-african-american, white-western-european, white-eastern-european, hispanic-or-latino, middle-eastern-or-north-african, east-asian, southeast-asian, south-asian.

enum

Filter by hair color. Accepts a comma-separated list. Available values: black, brown, blonde, red, gray, white, bald.

enum

Filter by look place. Accepts a comma-separated list. Available values: bathroom, beach, car, bedroom, podcast, home, office, gym, outdoor, kitchen, restaurant, studio, street, classroom, hospital, hotel, park, store, cafe, other.

boolean

Filter by selfie looks. Use true or false.

enum

Filter by look action. Accepts a comma-separated list. Available values: working, eating, drinking, cooking, exercising, reading, driving, listening_to_music, getting_a_haircut, presenting, calling, relaxing, shopping, traveling, applying_skincare.

enum

Filter by look emotion. Accepts a comma-separated list. Available values: happy, calm, focused, relaxed, neutral, excited, confident, sad, skeptical, bored, engaged.

enum

Filter by visible accessories. Accepts a comma-separated list. Available values: microphone, laptop, phone, headphones, earbuds, glasses, watch, drink, skincare, book, bag, camera, pillow, earrings, necklace, bracelet, ring.

boolean

default:"false"

If true, returns only public catalog avatars (excludes custom space avatars). Defaults to false (returns both space and public avatars).

Response

Returns an array of avatar look objects.

string

Unique identifier of the look.

string

Unique identifier of the parent avatar.

string

Name of the avatar.

string

Name of the avatar look.

string

Gender of the avatar: male or female.

string

Avatar age range.

string

Avatar ethnicity.

string

Avatar hair color.

string

Place or context of the look (e.g., “studio”, “office”).

array

Visible accessories or props in the look.

string

Main action detected for the look.

string

Emotion or mood detected for the look.

boolean

Whether the look is a selfie-style shot.

string

Image format: vertical or horizontal.

string

URL of the look thumbnail image.

string

Preview URL if available, otherwise null.

array

Array of available models for this look. If preview exists, only standard is available. Otherwise, models like premium, ultra, veo-3-fast, veo-3, veo-3-lite, omni-flash, ora-lite, ora-standard, ora-pro, seedance-2, seedance-2-fast, seedance-2-1080p, and seedance-2-5 may be available.

curl -X GET "https://app.hoox.video/api/public/v1/avatar/list?gender=male&place=podcast&accessories=microphone" \
  -H "Authorization: Bearer your_api_key"

import requests

url = "https://app.hoox.video/api/public/v1/avatar/list"
params = {"gender": "male", "place": "podcast", "accessories": "microphone"}
headers = {"Authorization": "Bearer your_api_key"}

response = requests.get(url, headers=headers, params=params)
print(response.json())

const url = new URL('https://app.hoox.video/api/public/v1/avatar/list');
url.searchParams.set('gender', 'male');
url.searchParams.set('place', 'podcast');
url.searchParams.set('accessories', 'microphone');

const response = await fetch(url, {
  headers: {
    'Authorization': 'Bearer your_api_key'
  }
});

const data = await response.json();
console.log(data);

[
  {
    "id": "look_id",
    "avatar_id": "avatar_id_1",
    "avatar_name": "Avatar name",
    "look_name": "Look name",
    "gender": "male",
    "age_range": "adult",
    "ethnicity": "white-western-european",
    "hair_color": "brown",
    "place": "studio",
    "accessories": ["microphone"],
    "action": "presenting",
    "emotion": "focused",
    "selfie": false,
    "format": "vertical",
    "thumbnail": "https://cdn.example.com/thumbnail.jpg",
    "preview": null,
    "model_available": ["premium", "ultra", "veo-3", "veo-3-fast", "veo-3-lite", "omni-flash", "ora-lite", "ora-standard", "ora-pro", "seedance-2", "seedance-2-fast", "seedance-2-1080p", "seedance-2-5"]
  },
  {
    "id": "look_id_2",
    "avatar_id": "avatar_id_1",
    "avatar_name": "Avatar name",
    "look_name": "Another Look",
    "gender": "female",
    "age_range": "young_adult",
    "ethnicity": "east-asian",
    "hair_color": "black",
    "place": "office",
    "accessories": ["laptop"],
    "action": "working",
    "emotion": "neutral",
    "selfie": false,
    "format": "horizontal",
    "thumbnail": "https://cdn.example.com/thumbnail2.jpg",
    "preview": "https://cdn.example.com/preview2.mp4",
    "model_available": ["standard"]
  }
]

Notes

By default, looks from your space are returned first, followed by public catalog looks
Set onlyPublic=true to return only public catalog looks (excludes custom space avatars)
The model_available field indicates which video generation models can be used with this look
If a look has a preview URL, it means the look is pre-rendered and only the standard model is available
Use the avatar_id field when referencing the parent avatar, and the id field for the specific look when creating videos with the /generation/start endpoint

Script

Generation

Export

Avatar

Voices

Assets

Folder

Overview

Authentication

Query Parameters

Response

Notes

​Overview

​Authentication

​Query Parameters

​Response

​Notes

Overview

Authentication

Query Parameters

Response

Notes