curl -X GET "https://app.hoox.video/api/public/v1/avatar/status?avatar_id=avtr_123&look_id=look_abc" \
-H "Authorization: Bearer your_api_key"
import requests
url = "https://app.hoox.video/api/public/v1/avatar/status"
params = {"avatar_id": "avtr_123", "look_id": "look_abc"}
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/status');
url.searchParams.set('avatar_id', 'avtr_123');
url.searchParams.set('look_id', 'look_abc');
const response = await fetch(url, {
headers: {
'Authorization': 'Bearer your_api_key'
}
});
const data = await response.json();
console.log(data);
{
"avatar_id": "avtr_123",
"look_id": "look_abc",
"status": "pending"
}
{
"avatar_id": "avtr_123",
"look_id": "look_abc",
"status": "completed",
"result": {
"id": "look_abc",
"avatar_name": "Avatar name",
"look_name": "Professional Office",
"gender": "male",
"place": "office",
"accessories": ["laptop"],
"action": "working",
"emotion": "focused",
"selfie": false,
"format": "vertical",
"thumbnail": "https://cdn.example.com/thumbnail.jpg",
"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"]
}
}
{
"avatar_id": "avtr_123",
"look_id": "look_abc",
"status": "failed",
"error": {
"code": "LOOK_GENERATION_FAILED",
"message": "Generation failed"
}
}
{
"error": "Validation failed",
"details": [
{
"code": "MISSING_AVATAR_ID",
"message": "avatar_id is required",
"field": "avatar_id"
}
]
}
{
"error": "Look not found"
}
Avatar
Avatar Status
Check the generation status of a specific avatar look
GET
/
api
/
public
/
v1
/
avatar
/
status
curl -X GET "https://app.hoox.video/api/public/v1/avatar/status?avatar_id=avtr_123&look_id=look_abc" \
-H "Authorization: Bearer your_api_key"
import requests
url = "https://app.hoox.video/api/public/v1/avatar/status"
params = {"avatar_id": "avtr_123", "look_id": "look_abc"}
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/status');
url.searchParams.set('avatar_id', 'avtr_123');
url.searchParams.set('look_id', 'look_abc');
const response = await fetch(url, {
headers: {
'Authorization': 'Bearer your_api_key'
}
});
const data = await response.json();
console.log(data);
{
"avatar_id": "avtr_123",
"look_id": "look_abc",
"status": "pending"
}
{
"avatar_id": "avtr_123",
"look_id": "look_abc",
"status": "completed",
"result": {
"id": "look_abc",
"avatar_name": "Avatar name",
"look_name": "Professional Office",
"gender": "male",
"place": "office",
"accessories": ["laptop"],
"action": "working",
"emotion": "focused",
"selfie": false,
"format": "vertical",
"thumbnail": "https://cdn.example.com/thumbnail.jpg",
"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"]
}
}
{
"avatar_id": "avtr_123",
"look_id": "look_abc",
"status": "failed",
"error": {
"code": "LOOK_GENERATION_FAILED",
"message": "Generation failed"
}
}
{
"error": "Validation failed",
"details": [
{
"code": "MISSING_AVATAR_ID",
"message": "avatar_id is required",
"field": "avatar_id"
}
]
}
{
"error": "Look not found"
}
Overview
This endpoint allows you to check the generation status of a specific avatar look. Use this to monitor the progress of avatar creation or editing operations.Authentication
This endpoint requires API key authentication. Include your API key in the
Authorization header.Query Parameters
string
required
Unique identifier of the avatar.
string
required
Unique identifier of the look to check.
Response
string
Unique identifier of the avatar.
string
Unique identifier of the look.
string
Current status:
pending, processing, completed, or failed.object
Result object (only present when status is
completed).Show properties
Show properties
string
Unique identifier of the look.
string
Name of the avatar.
string
Name of the avatar look.
string
Gender of the avatar (
male or female).string
Setting or location of the look.
array
Visible accessories or props in the look.
string
Main action detected for the look.
string
Emotion or mood detected for the look.
boolean
Whether the look is a selfie-style shot.
string
Format of the look (
vertical or horizontal).string
URL of the generated avatar look thumbnail.
array
List of available AI models for this look.
object
curl -X GET "https://app.hoox.video/api/public/v1/avatar/status?avatar_id=avtr_123&look_id=look_abc" \
-H "Authorization: Bearer your_api_key"
import requests
url = "https://app.hoox.video/api/public/v1/avatar/status"
params = {"avatar_id": "avtr_123", "look_id": "look_abc"}
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/status');
url.searchParams.set('avatar_id', 'avtr_123');
url.searchParams.set('look_id', 'look_abc');
const response = await fetch(url, {
headers: {
'Authorization': 'Bearer your_api_key'
}
});
const data = await response.json();
console.log(data);
{
"avatar_id": "avtr_123",
"look_id": "look_abc",
"status": "pending"
}
{
"avatar_id": "avtr_123",
"look_id": "look_abc",
"status": "completed",
"result": {
"id": "look_abc",
"avatar_name": "Avatar name",
"look_name": "Professional Office",
"gender": "male",
"place": "office",
"accessories": ["laptop"],
"action": "working",
"emotion": "focused",
"selfie": false,
"format": "vertical",
"thumbnail": "https://cdn.example.com/thumbnail.jpg",
"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"]
}
}
{
"avatar_id": "avtr_123",
"look_id": "look_abc",
"status": "failed",
"error": {
"code": "LOOK_GENERATION_FAILED",
"message": "Generation failed"
}
}
{
"error": "Validation failed",
"details": [
{
"code": "MISSING_AVATAR_ID",
"message": "avatar_id is required",
"field": "avatar_id"
}
]
}
{
"error": "Look not found"
}
Error Codes
INVALID_VALUE: Missing required parameter (avatar_idorlook_id)Space not found: The space associated with the API key doesn’t existAvatar not found: No avatar found with the specifiedavatar_idLook not found: No look found with the specifiedlook_idfor the avatarLOOK_GENERATION_FAILED: The look generation process failed (returned in status response when status isfailed)
Was this page helpful?