curl -X GET "https://app.hoox.video/api/public/v1/avatar/avtr_abc123" \
-H "Authorization: Bearer your_api_key"
import requests
url = "https://app.hoox.video/api/public/v1/avatar/avtr_abc123"
headers = {"Authorization": "Bearer your_api_key"}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch('https://app.hoox.video/api/public/v1/avatar/avtr_abc123', {
headers: {
'Authorization': 'Bearer your_api_key'
}
});
const data = await response.json();
console.log(data);
{
"id": "avtr_abc123",
"name": "Alex",
"gender": "male",
"age": "30",
"age_range": "adult",
"ethnicity": "white-western-european",
"hair_color": "brown",
"thumbnail": "https://cdn.example.com/avatar-thumbnail.jpg",
"looks": [
{
"id": "look_123",
"name": "Office Look",
"place": "office",
"accessories": ["laptop"],
"action": "working",
"emotion": "focused",
"selfie": false,
"format": "vertical",
"thumbnail": "https://cdn.example.com/look-thumbnail.jpg",
"preview": null,
"status": "ready",
"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_456",
"name": "Studio Look",
"place": "studio",
"accessories": ["microphone"],
"action": "presenting",
"emotion": "confident",
"selfie": false,
"format": "vertical",
"thumbnail": "https://cdn.example.com/look2-thumbnail.jpg",
"preview": null,
"status": "ready",
"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"]
}
],
"created_at": "2024-01-15T10:30:00Z"
}
{
"error": "Avatar not found",
"details": [
{
"code": "NOT_FOUND",
"message": "Avatar with id \"avtr_abc123\" not found"
}
]
}
Avatar
Get Avatar
Retrieve details of a specific avatar by its ID
GET
/
api
/
public
/
v1
/
avatar
/
{avatar_id}
curl -X GET "https://app.hoox.video/api/public/v1/avatar/avtr_abc123" \
-H "Authorization: Bearer your_api_key"
import requests
url = "https://app.hoox.video/api/public/v1/avatar/avtr_abc123"
headers = {"Authorization": "Bearer your_api_key"}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch('https://app.hoox.video/api/public/v1/avatar/avtr_abc123', {
headers: {
'Authorization': 'Bearer your_api_key'
}
});
const data = await response.json();
console.log(data);
{
"id": "avtr_abc123",
"name": "Alex",
"gender": "male",
"age": "30",
"age_range": "adult",
"ethnicity": "white-western-european",
"hair_color": "brown",
"thumbnail": "https://cdn.example.com/avatar-thumbnail.jpg",
"looks": [
{
"id": "look_123",
"name": "Office Look",
"place": "office",
"accessories": ["laptop"],
"action": "working",
"emotion": "focused",
"selfie": false,
"format": "vertical",
"thumbnail": "https://cdn.example.com/look-thumbnail.jpg",
"preview": null,
"status": "ready",
"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_456",
"name": "Studio Look",
"place": "studio",
"accessories": ["microphone"],
"action": "presenting",
"emotion": "confident",
"selfie": false,
"format": "vertical",
"thumbnail": "https://cdn.example.com/look2-thumbnail.jpg",
"preview": null,
"status": "ready",
"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"]
}
],
"created_at": "2024-01-15T10:30:00Z"
}
{
"error": "Avatar not found",
"details": [
{
"code": "NOT_FOUND",
"message": "Avatar with id \"avtr_abc123\" not found"
}
]
}
Overview
This endpoint retrieves details for a specific avatar by itsid. Results can come from your space (custom avatars) or from the public catalog. The response includes all looks associated with the avatar.
Authentication
This endpoint requires API key authentication. Include your API key in the
Authorization header.Path Parameters
The unique identifier of the avatar to retrieve.
Response
Unique identifier of the avatar.
Name of the avatar.
Gender of the avatar:
male or female.Age of the avatar.
Avatar age range.
Avatar ethnicity.
Avatar hair color.
URL of the avatar thumbnail image.
Array of looks associated with this avatar.
Show Look object properties
Show Look object properties
Unique identifier of the look.
Name of the look.
Place or context of the look.
Visible accessories or props in the look.
Main action detected for the look.
Emotion or mood detected for the look.
Whether the look is a selfie-style shot.
Image format:
vertical or horizontal.URL of the look thumbnail.
Preview URL if available, otherwise
null.Current status:
ready, pending, or error.Available models for this 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.Creation timestamp if available, otherwise
null.curl -X GET "https://app.hoox.video/api/public/v1/avatar/avtr_abc123" \
-H "Authorization: Bearer your_api_key"
import requests
url = "https://app.hoox.video/api/public/v1/avatar/avtr_abc123"
headers = {"Authorization": "Bearer your_api_key"}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch('https://app.hoox.video/api/public/v1/avatar/avtr_abc123', {
headers: {
'Authorization': 'Bearer your_api_key'
}
});
const data = await response.json();
console.log(data);
{
"id": "avtr_abc123",
"name": "Alex",
"gender": "male",
"age": "30",
"age_range": "adult",
"ethnicity": "white-western-european",
"hair_color": "brown",
"thumbnail": "https://cdn.example.com/avatar-thumbnail.jpg",
"looks": [
{
"id": "look_123",
"name": "Office Look",
"place": "office",
"accessories": ["laptop"],
"action": "working",
"emotion": "focused",
"selfie": false,
"format": "vertical",
"thumbnail": "https://cdn.example.com/look-thumbnail.jpg",
"preview": null,
"status": "ready",
"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_456",
"name": "Studio Look",
"place": "studio",
"accessories": ["microphone"],
"action": "presenting",
"emotion": "confident",
"selfie": false,
"format": "vertical",
"thumbnail": "https://cdn.example.com/look2-thumbnail.jpg",
"preview": null,
"status": "ready",
"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"]
}
],
"created_at": "2024-01-15T10:30:00Z"
}
{
"error": "Avatar not found",
"details": [
{
"code": "NOT_FOUND",
"message": "Avatar with id \"avtr_abc123\" not found"
}
]
}
Was this page helpful?
⌘I