Skip to main content
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"
[
  {
    "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"]
  },
  {
    "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"]
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.hoox.video/llms.txt

Use this file to discover all available pages before exploring further.

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

gender
enum
Filter by gender. Available values: male, female.
age_range
enum
Filter by avatar age range. Accepts a comma-separated list. Available values: senior, adult, young_adult, adolescent.
ethnicity
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.
hair_color
enum
Filter by hair color. Accepts a comma-separated list. Available values: black, brown, blonde, red, gray, white, bald.
place
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.
selfie
boolean
Filter by selfie looks. Use true or false.
action
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.
emotion
enum
Filter by look emotion. Accepts a comma-separated list. Available values: happy, calm, focused, relaxed, neutral, excited, confident, sad, skeptical, bored, engaged.
accessories
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.
onlyPublic
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.
id
string
Unique identifier of the look.
avatar_id
string
Unique identifier of the parent avatar.
avatar_name
string
Name of the avatar.
look_name
string
Name of the avatar look.
gender
string
Gender of the avatar: male or female.
age_range
string
Avatar age range.
ethnicity
string
Avatar ethnicity.
hair_color
string
Avatar hair color.
place
string
Place or context of the look (e.g., “studio”, “office”).
accessories
array
Visible accessories or props in the look.
action
string
Main action detected for the look.
emotion
string
Emotion or mood detected for the look.
selfie
boolean
Whether the look is a selfie-style shot.
format
string
Image format: vertical or horizontal.
thumbnail
string
URL of the look thumbnail image.
preview
string
Preview URL if available, otherwise null.
model_available
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, and seedance-2-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"
[
  {
    "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"]
  },
  {
    "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