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-fast", "veo-3-lite", "omni-flash", "ora-lite", "ora-standard", "ora-pro", "seedance-2-fast", "seedance-2-5", "seedance-2-5-1080p"]
},
{
"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"]
}
]
Avatar
List Avatars
Retrieve available avatar looks for your space and public catalog
GET
/
api
/
public
/
v1
/
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-fast", "veo-3-lite", "omni-flash", "ora-lite", "ora-standard", "ora-pro", "seedance-2-fast", "seedance-2-5", "seedance-2-5-1080p"]
},
{
"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
Filter by avatar age range. Accepts a comma-separated list. Available values:
senior, adult, young_adult, adolescent.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.Filter by hair color. Accepts a comma-separated list. Available values:
black, brown, blonde, red, gray, white, bald.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.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.Filter by look emotion. Accepts a comma-separated list. Available values:
happy, calm, focused, relaxed, neutral, excited, confident, sad, skeptical, bored, engaged.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.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.Array of available models for this look. If
preview exists, only standard is available. Otherwise, models like premium, ultra, veo-3-fast, veo-3-lite, omni-flash, ora-lite, ora-standard, ora-pro, seedance-2-fast, seedance-2-5, and seedance-2-5-1080p 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-fast", "veo-3-lite", "omni-flash", "ora-lite", "ora-standard", "ora-pro", "seedance-2-fast", "seedance-2-5", "seedance-2-5-1080p"]
},
{
"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=trueto return only public catalog looks (excludes custom space avatars) - The
model_availablefield indicates which video generation models can be used with this look - If a look has a
previewURL, it means the look is pre-rendered and only thestandardmodel is available - Use the
avatar_idfield when referencing the parent avatar, and theidfield for the specific look when creating videos with the/generation/startendpoint
Was this page helpful?

