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&tags=business" \
  -H "Authorization: Bearer your_api_key"

[
  {
    "id": "avatar_business_woman_office_1",
    "name": "Professional Sarah - Office",
    "gender": "female",
    "place": "office",
    "format": "vertical",
    "tags": ["business", "professional", "modern", "office"],
    "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"
  },
  {
    "id": "avatar_business_man_studio_1",
    "name": "Executive James - Studio",
    "gender": "male",
    "place": "studio",
    "format": "square",
    "tags": ["business", "executive", "authoritative", "studio"],
    "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"
  },
  {
    "id": "avatar_casual_woman_home_1",
    "name": "Friendly Emma - Home",
    "gender": "female",
    "place": "home",
    "format": "vertical",
    "tags": ["casual", "friendly", "relatable", "home"],
    "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"
  },
  {
    "id": "custom_avatar_user_456",
    "name": "My Brand Ambassador",
    "gender": "female",
    "place": "branded_office",
    "format": "vertical",
    "tags": ["custom", "brand", "professional"],
    "thumbnail": "https://storage.hoox.video/avatars/thumbnails/custom_avatar_user_456.jpg",
    "preview": "https://storage.hoox.video/avatars/previews/custom_avatar_user_456.mp4"
  }
]

​
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
string
Filter avatars by gender: male or female.
​
tags
string
Comma-separated list of tags to filter by (e.g., “business,professional”).

​
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.
​
place
string
Setting/background of the avatar (e.g., “office”, “studio”, “outdoor”).
​
format
string
Optimal video format for this avatar (e.g., “vertical”, “square”).
​
tags
array
Array of descriptive tags (e.g., [“business”, “professional”, “modern”]).
​
thumbnail
string
URL to a static thumbnail image of the avatar.
​
preview
string
URL to a short video preview of the avatar in action.

​
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&tags=business" \
  -H "Authorization: Bearer your_api_key"

[
  {
    "id": "avatar_business_woman_office_1",
    "name": "Professional Sarah - Office",
    "gender": "female",
    "place": "office",
    "format": "vertical",
    "tags": ["business", "professional", "modern", "office"],
    "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"
  },
  {
    "id": "avatar_business_man_studio_1",
    "name": "Executive James - Studio",
    "gender": "male",
    "place": "studio",
    "format": "square",
    "tags": ["business", "executive", "authoritative", "studio"],
    "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"
  },
  {
    "id": "avatar_casual_woman_home_1",
    "name": "Friendly Emma - Home",
    "gender": "female",
    "place": "home",
    "format": "vertical",
    "tags": ["casual", "friendly", "relatable", "home"],
    "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"
  },
  {
    "id": "custom_avatar_user_456",
    "name": "My Brand Ambassador",
    "gender": "female",
    "place": "branded_office",
    "format": "vertical",
    "tags": ["custom", "brand", "professional"],
    "thumbnail": "https://storage.hoox.video/avatars/thumbnails/custom_avatar_user_456.jpg",
    "preview": "https://storage.hoox.video/avatars/previews/custom_avatar_user_456.mp4"
  }
]
⌘I