Skip to main content
GET
https://app.hoox.video
/
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"
{
  "avatar_id": "avtr_123",
  "look_id": "look_abc",
  "status": "pending"
}

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

avatar_id
string
required
Unique identifier of the avatar.
look_id
string
required
Unique identifier of the look to check.

Response

avatar_id
string
Unique identifier of the avatar.
look_id
string
Unique identifier of the look.
status
string
Current status: pending, processing, completed, or failed.
result
object
Result object (only present when status is completed).
error
object
Error object (only present when status is failed).
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"
{
  "avatar_id": "avtr_123",
  "look_id": "look_abc",
  "status": "pending"
}

Error Codes

  • INVALID_VALUE: Missing required parameter (avatar_id or look_id)
  • Space not found: The space associated with the API key doesn’t exist
  • Avatar not found: No avatar found with the specified avatar_id
  • Look not found: No look found with the specified look_id for the avatar
  • LOOK_GENERATION_FAILED: The look generation process failed (returned in status response when status is failed)