Skip to main content
GET
https://app.hoox.video
/
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"

{
  "id": "avtr_abc123",
  "name": "Alex",
  "gender": "male",
  "age": "30",
  "tags": ["business", "professional"],
  "thumbnail": "https://cdn.example.com/avatar-thumbnail.jpg",
  "looks": [
    {
      "id": "look_123",
      "name": "Office Look",
      "place": "office",
      "format": "vertical",
      "thumbnail": "https://cdn.example.com/look-thumbnail.jpg",
      "preview": null,
      "status": "ready",
      "model_available": ["premium", "ultra", "veo-3", "veo-3-fast"]
    },
    {
      "id": "look_456",
      "name": "Studio Look",
      "place": "studio",
      "format": "vertical",
      "thumbnail": "https://cdn.example.com/look2-thumbnail.jpg",
      "preview": null,
      "status": "ready",
      "model_available": ["premium", "ultra", "veo-3", "veo-3-fast"]
    }
  ],
  "created_at": "2024-01-15T10:30:00Z"
}

​
Overview

This endpoint retrieves details for a specific avatar by its id. 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

​
avatar_id
string
required
The unique identifier of the avatar to retrieve.

​
Response

​
id
string
Unique identifier of the avatar.
​
name
string
Name of the avatar.
​
gender
string
Gender of the avatar: male or female.
​
age
string
Age of the avatar.
​
tags
array
Array of tags associated with the avatar.
​
thumbnail
string
URL of the avatar thumbnail image.
​
looks
array
Array of looks associated with this avatar.
​
created_at
string
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"

{
  "id": "avtr_abc123",
  "name": "Alex",
  "gender": "male",
  "age": "30",
  "tags": ["business", "professional"],
  "thumbnail": "https://cdn.example.com/avatar-thumbnail.jpg",
  "looks": [
    {
      "id": "look_123",
      "name": "Office Look",
      "place": "office",
      "format": "vertical",
      "thumbnail": "https://cdn.example.com/look-thumbnail.jpg",
      "preview": null,
      "status": "ready",
      "model_available": ["premium", "ultra", "veo-3", "veo-3-fast"]
    },
    {
      "id": "look_456",
      "name": "Studio Look",
      "place": "studio",
      "format": "vertical",
      "thumbnail": "https://cdn.example.com/look2-thumbnail.jpg",
      "preview": null,
      "status": "ready",
      "model_available": ["premium", "ultra", "veo-3", "veo-3-fast"]
    }
  ],
  "created_at": "2024-01-15T10:30:00Z"
}