Skip to main content
GET
/
api
/
public
/
v1
/
resources
/
avatars
curl -X GET "https://app.hoox.video/api/public/v1/resources/avatars" \
  -H "Authorization: Bearer your_api_key"

# With filters
curl -X GET "https://app.hoox.video/api/public/v1/resources/avatars?gender=female&place=office&hair_color=brown" \
  -H "Authorization: Bearer your_api_key"
[
  {
    "id": "avatar_business_woman_office_1",
    "name": "Professional Sarah - Office",
    "gender": "female",
    "age_range": "adult",
    "ethnicity": "white-western-european",
    "hair_color": "brown",
    "place": "office",
    "accessories": ["laptop"],
    "action": "working",
    "emotion": "focused",
    "selfie": false,
    "format": "vertical",
    "thumbnail": "https://storage.hoox.video/avatars/thumbnails/avatar_business_woman_office_1.jpg",
    "preview": "https://storage.hoox.video/avatars/previews/avatar_business_woman_office_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "avatar_business_man_studio_1",
    "name": "Executive James - Studio",
    "gender": "male",
    "age_range": "adult",
    "ethnicity": "white-western-european",
    "hair_color": "brown",
    "place": "studio",
    "accessories": ["microphone"],
    "action": "presenting",
    "emotion": "confident",
    "selfie": false,
    "format": "vertical",
    "thumbnail": "https://storage.hoox.video/avatars/thumbnails/avatar_business_man_studio_1.jpg",
    "preview": "https://storage.hoox.video/avatars/previews/avatar_business_man_studio_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "avatar_casual_woman_home_1",
    "name": "Friendly Emma - Home",
    "gender": "female",
    "age_range": "young_adult",
    "ethnicity": "white-western-european",
    "hair_color": "blonde",
    "place": "home",
    "accessories": [],
    "action": "relaxing",
    "emotion": "happy",
    "selfie": false,
    "format": "vertical",
    "thumbnail": "https://storage.hoox.video/avatars/thumbnails/avatar_casual_woman_home_1.jpg",
    "preview": "https://storage.hoox.video/avatars/previews/avatar_casual_woman_home_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "custom_avatar_user_456",
    "name": "My Brand Ambassador",
    "gender": "female",
    "age_range": "adult",
    "ethnicity": "hispanic-or-latino",
    "hair_color": "brown",
    "place": "office",
    "accessories": [],
    "action": "presenting",
    "emotion": "neutral",
    "selfie": false,
    "format": "vertical",
    "thumbnail": "https://storage.hoox.video/avatars/thumbnails/custom_avatar_user_456.jpg",
    "model_available": ["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"]
  }
]

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 returns all available avatar looks that you can use in video generation. Avatar looks are specific appearances/styles of digital presenters that can deliver your video content.

Authentication

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

Query Parameters

gender
enum
Filter avatars 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.

Response

Array of available avatar look objects:
id
string
Unique identifier for the avatar look (use this in generation requests).
name
string
Human-readable name of the avatar look.
gender
string
Avatar gender: male or female.
age_range
string
Avatar age range.
ethnicity
string
Avatar ethnicity.
hair_color
string
Avatar hair color.
place
string
Setting/background of the avatar (e.g., “office”, “studio”, “outdoor”).
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
Optimal video format for this avatar (e.g., “vertical”, “horizontal”).
thumbnail
string
URL to a static thumbnail image of the avatar.
preview
string
URL to a short video preview of the avatar in action.
model_available
array
Array of avatar model IDs compatible with this avatar look. Possible values: standard, 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.

Example

curl -X GET "https://app.hoox.video/api/public/v1/resources/avatars" \
  -H "Authorization: Bearer your_api_key"

# With filters
curl -X GET "https://app.hoox.video/api/public/v1/resources/avatars?gender=female&place=office&hair_color=brown" \
  -H "Authorization: Bearer your_api_key"
[
  {
    "id": "avatar_business_woman_office_1",
    "name": "Professional Sarah - Office",
    "gender": "female",
    "age_range": "adult",
    "ethnicity": "white-western-european",
    "hair_color": "brown",
    "place": "office",
    "accessories": ["laptop"],
    "action": "working",
    "emotion": "focused",
    "selfie": false,
    "format": "vertical",
    "thumbnail": "https://storage.hoox.video/avatars/thumbnails/avatar_business_woman_office_1.jpg",
    "preview": "https://storage.hoox.video/avatars/previews/avatar_business_woman_office_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "avatar_business_man_studio_1",
    "name": "Executive James - Studio",
    "gender": "male",
    "age_range": "adult",
    "ethnicity": "white-western-european",
    "hair_color": "brown",
    "place": "studio",
    "accessories": ["microphone"],
    "action": "presenting",
    "emotion": "confident",
    "selfie": false,
    "format": "vertical",
    "thumbnail": "https://storage.hoox.video/avatars/thumbnails/avatar_business_man_studio_1.jpg",
    "preview": "https://storage.hoox.video/avatars/previews/avatar_business_man_studio_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "avatar_casual_woman_home_1",
    "name": "Friendly Emma - Home",
    "gender": "female",
    "age_range": "young_adult",
    "ethnicity": "white-western-european",
    "hair_color": "blonde",
    "place": "home",
    "accessories": [],
    "action": "relaxing",
    "emotion": "happy",
    "selfie": false,
    "format": "vertical",
    "thumbnail": "https://storage.hoox.video/avatars/thumbnails/avatar_casual_woman_home_1.jpg",
    "preview": "https://storage.hoox.video/avatars/previews/avatar_casual_woman_home_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "custom_avatar_user_456",
    "name": "My Brand Ambassador",
    "gender": "female",
    "age_range": "adult",
    "ethnicity": "hispanic-or-latino",
    "hair_color": "brown",
    "place": "office",
    "accessories": [],
    "action": "presenting",
    "emotion": "neutral",
    "selfie": false,
    "format": "vertical",
    "thumbnail": "https://storage.hoox.video/avatars/thumbnails/custom_avatar_user_456.jpg",
    "model_available": ["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"]
  }
]