List Available Avatars

curl -X GET "https://app.axeimmo.com/api/public/v1/resources/avatars" \
  -H "Authorization: Bearer your_api_key"

# With filters
curl -X GET "https://app.axeimmo.com/api/public/v1/resources/avatars?gender=female&tags=business" \
  -H "Authorization: Bearer your_api_key"

import requests

url = "https://app.axeimmo.com/api/public/v1/resources/avatars"
headers = {
    "Authorization": "Bearer your_api_key"
}

# Get all avatars
response = requests.get(url, headers=headers)
avatars = response.json()

# Filter for business avatars
params = {
    "gender": "female",
    "tags": "business,professional"
}
response = requests.get(url, headers=headers, params=params)
business_avatars = response.json()

print(f"Found {len(business_avatars)} business avatars")
for avatar in business_avatars:
    print(f"- {avatar['name']} ({avatar['id']}) - {avatar['place']}")

// Get all avatars
const response = await fetch('https://app.axeimmo.com/api/public/v1/resources/avatars', {
  headers: {
    'Authorization': 'Bearer your_api_key'
  }
});

const data = await response.json();
console.log(`Found ${data.length} avatars`);

// Filter for specific criteria
const filteredResponse = await fetch(
  'https://app.axeimmo.com/api/public/v1/resources/avatars?gender=female&tags=business',
  {
    headers: {
      'Authorization': 'Bearer your_api_key'
    }
  }
);

const filteredData = await filteredResponse.json();
console.log('Business avatars:', filteredData);

[
  {
    "id": "avatar_business_woman_office_1",
    "name": "Professional Sarah - Office",
    "gender": "female",
    "place": "office",
    "format": "vertical",
    "tags": ["business", "professional", "modern", "office"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/avatar_business_woman_office_1.jpg",
    "preview": "https://storage.axeimmo.com/avatars/previews/avatar_business_woman_office_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "avatar_business_man_studio_1",
    "name": "Executive James - Studio",
    "gender": "male",
    "place": "studio",
    "format": "square",
    "tags": ["business", "executive", "authoritative", "studio"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/avatar_business_man_studio_1.jpg",
    "preview": "https://storage.axeimmo.com/avatars/previews/avatar_business_man_studio_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "avatar_casual_woman_home_1",
    "name": "Friendly Emma - Home",
    "gender": "female",
    "place": "home",
    "format": "vertical",
    "tags": ["casual", "friendly", "relatable", "home"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/avatar_casual_woman_home_1.jpg",
    "preview": "https://storage.axeimmo.com/avatars/previews/avatar_casual_woman_home_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "custom_avatar_user_456",
    "name": "My Brand Ambassador",
    "gender": "female",
    "place": "branded_office",
    "format": "vertical",
    "tags": ["custom", "brand", "professional"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/custom_avatar_user_456.jpg",
    "model_available": ["premium", "ultra", "veo-3-fast", "veo-3"]
  }
]

GET

api

public

resources

avatars

curl -X GET "https://app.axeimmo.com/api/public/v1/resources/avatars" \
  -H "Authorization: Bearer your_api_key"

# With filters
curl -X GET "https://app.axeimmo.com/api/public/v1/resources/avatars?gender=female&tags=business" \
  -H "Authorization: Bearer your_api_key"

import requests

url = "https://app.axeimmo.com/api/public/v1/resources/avatars"
headers = {
    "Authorization": "Bearer your_api_key"
}

# Get all avatars
response = requests.get(url, headers=headers)
avatars = response.json()

# Filter for business avatars
params = {
    "gender": "female",
    "tags": "business,professional"
}
response = requests.get(url, headers=headers, params=params)
business_avatars = response.json()

print(f"Found {len(business_avatars)} business avatars")
for avatar in business_avatars:
    print(f"- {avatar['name']} ({avatar['id']}) - {avatar['place']}")

// Get all avatars
const response = await fetch('https://app.axeimmo.com/api/public/v1/resources/avatars', {
  headers: {
    'Authorization': 'Bearer your_api_key'
  }
});

const data = await response.json();
console.log(`Found ${data.length} avatars`);

// Filter for specific criteria
const filteredResponse = await fetch(
  'https://app.axeimmo.com/api/public/v1/resources/avatars?gender=female&tags=business',
  {
    headers: {
      'Authorization': 'Bearer your_api_key'
    }
  }
);

const filteredData = await filteredResponse.json();
console.log('Business avatars:', filteredData);

[
  {
    "id": "avatar_business_woman_office_1",
    "name": "Professional Sarah - Office",
    "gender": "female",
    "place": "office",
    "format": "vertical",
    "tags": ["business", "professional", "modern", "office"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/avatar_business_woman_office_1.jpg",
    "preview": "https://storage.axeimmo.com/avatars/previews/avatar_business_woman_office_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "avatar_business_man_studio_1",
    "name": "Executive James - Studio",
    "gender": "male",
    "place": "studio",
    "format": "square",
    "tags": ["business", "executive", "authoritative", "studio"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/avatar_business_man_studio_1.jpg",
    "preview": "https://storage.axeimmo.com/avatars/previews/avatar_business_man_studio_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "avatar_casual_woman_home_1",
    "name": "Friendly Emma - Home",
    "gender": "female",
    "place": "home",
    "format": "vertical",
    "tags": ["casual", "friendly", "relatable", "home"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/avatar_casual_woman_home_1.jpg",
    "preview": "https://storage.axeimmo.com/avatars/previews/avatar_casual_woman_home_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "custom_avatar_user_456",
    "name": "My Brand Ambassador",
    "gender": "female",
    "place": "branded_office",
    "format": "vertical",
    "tags": ["custom", "brand", "professional"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/custom_avatar_user_456.jpg",
    "model_available": ["premium", "ultra", "veo-3-fast", "veo-3"]
  }
]

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

string

Filter avatars by gender: male or female.

string

Comma-separated list of tags to filter by (e.g., “business,professional”).

Response

Array of available avatar look objects:

string

Unique identifier for the avatar look (use this in generation requests).

string

Human-readable name of the avatar look.

string

Avatar gender: male or female.

string

Setting/background of the avatar (e.g., “office”, “studio”, “outdoor”).

string

Optimal video format for this avatar (e.g., “vertical”, “square”).

array

Array of descriptive tags (e.g., [“business”, “professional”, “modern”]).

string

URL to a static thumbnail image of the avatar.

string

URL to a short video preview of the avatar in action.

array

Array of avatar model IDs compatible with this avatar look. Possible values: standard, premium, ultra, veo-3-fast, veo-3.

Example

curl -X GET "https://app.axeimmo.com/api/public/v1/resources/avatars" \
  -H "Authorization: Bearer your_api_key"

# With filters
curl -X GET "https://app.axeimmo.com/api/public/v1/resources/avatars?gender=female&tags=business" \
  -H "Authorization: Bearer your_api_key"

import requests

url = "https://app.axeimmo.com/api/public/v1/resources/avatars"
headers = {
    "Authorization": "Bearer your_api_key"
}

# Get all avatars
response = requests.get(url, headers=headers)
avatars = response.json()

# Filter for business avatars
params = {
    "gender": "female",
    "tags": "business,professional"
}
response = requests.get(url, headers=headers, params=params)
business_avatars = response.json()

print(f"Found {len(business_avatars)} business avatars")
for avatar in business_avatars:
    print(f"- {avatar['name']} ({avatar['id']}) - {avatar['place']}")

// Get all avatars
const response = await fetch('https://app.axeimmo.com/api/public/v1/resources/avatars', {
  headers: {
    'Authorization': 'Bearer your_api_key'
  }
});

const data = await response.json();
console.log(`Found ${data.length} avatars`);

// Filter for specific criteria
const filteredResponse = await fetch(
  'https://app.axeimmo.com/api/public/v1/resources/avatars?gender=female&tags=business',
  {
    headers: {
      'Authorization': 'Bearer your_api_key'
    }
  }
);

const filteredData = await filteredResponse.json();
console.log('Business avatars:', filteredData);

[
  {
    "id": "avatar_business_woman_office_1",
    "name": "Professional Sarah - Office",
    "gender": "female",
    "place": "office",
    "format": "vertical",
    "tags": ["business", "professional", "modern", "office"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/avatar_business_woman_office_1.jpg",
    "preview": "https://storage.axeimmo.com/avatars/previews/avatar_business_woman_office_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "avatar_business_man_studio_1",
    "name": "Executive James - Studio",
    "gender": "male",
    "place": "studio",
    "format": "square",
    "tags": ["business", "executive", "authoritative", "studio"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/avatar_business_man_studio_1.jpg",
    "preview": "https://storage.axeimmo.com/avatars/previews/avatar_business_man_studio_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "avatar_casual_woman_home_1",
    "name": "Friendly Emma - Home",
    "gender": "female",
    "place": "home",
    "format": "vertical",
    "tags": ["casual", "friendly", "relatable", "home"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/avatar_casual_woman_home_1.jpg",
    "preview": "https://storage.axeimmo.com/avatars/previews/avatar_casual_woman_home_1.mp4",
    "model_available": ["standard"]
  },
  {
    "id": "custom_avatar_user_456",
    "name": "My Brand Ambassador",
    "gender": "female",
    "place": "branded_office",
    "format": "vertical",
    "tags": ["custom", "brand", "professional"],
    "thumbnail": "https://storage.axeimmo.com/avatars/thumbnails/custom_avatar_user_456.jpg",
    "model_available": ["premium", "ultra", "veo-3-fast", "veo-3"]
  }
]

List Available Voices

Script

Generation

Export

Resources

Overview

Authentication

Query Parameters

Response

Example

​Overview

​Authentication

​Query Parameters

​Response

​Example

Overview

Authentication

Query Parameters

Response

Example