Skip to main content
GET
/
v1
/
avatar
/
list
curl -X GET "https://api.slidevid.ai/v1/avatar/list?type=library" \
  -H "x-api-key: your_api_key_here"

{
  "success": true,
  "data": {
    "avatars": [
      {
        "id": "avatar_sarah_01",
        "name": "Sarah",
        "type": "Realistic",
        "gender": "Female",
        "age": "Young",
        "thumbnail": "https://cdn.tryslidevid.ai/avatars/sarah-thumb.jpg",
        "templateUrl": "https://cdn.tryslidevid.ai/avatars/sarah.mp4",
        "voiceActor": "Professional",
        "isHD": true,
        "isPro": false,
        "isNew": false,
        "situation": ["Business", "Casual"],
        "emotions": ["Happy", "Confident"],
        "skinTone": "medium",
        "isCustom": false,
        "source": "library"
      },
      {
        "id": "avatar_john_02",
        "name": "John",
        "type": "Realistic",
        "gender": "Male",
        "age": "Middle-aged",
        "thumbnail": "https://cdn.tryslidevid.ai/avatars/john-thumb.jpg",
        "templateUrl": "https://cdn.tryslidevid.ai/avatars/john.mp4",
        "voiceActor": "Professional",
        "isHD": true,
        "isPro": true,
        "isNew": false,
        "situation": ["Business", "Professional"],
        "emotions": ["Neutral", "Serious"],
        "skinTone": "light",
        "isCustom": false,
        "source": "library"
      }
    ],
    "total": 2,
    "library": 2,
    "custom": 0
  }
}

​
Overview

This endpoint returns all avatars available to your account, including both the SlideVid library avatars and any custom avatars you’ve created.

​
Query Parameters

​
type
string
default:"all"
Filter avatars by type:
  • library: Only library avatars from SlideVid
  • custom: Only custom avatars created by your team
  • all: Both library and custom avatars (default)

​
Response

​
success
boolean
Indicates if the request was successful
​
data
object
curl -X GET "https://api.slidevid.ai/v1/avatar/list?type=library" \
  -H "x-api-key: your_api_key_here"

{
  "success": true,
  "data": {
    "avatars": [
      {
        "id": "avatar_sarah_01",
        "name": "Sarah",
        "type": "Realistic",
        "gender": "Female",
        "age": "Young",
        "thumbnail": "https://cdn.tryslidevid.ai/avatars/sarah-thumb.jpg",
        "templateUrl": "https://cdn.tryslidevid.ai/avatars/sarah.mp4",
        "voiceActor": "Professional",
        "isHD": true,
        "isPro": false,
        "isNew": false,
        "situation": ["Business", "Casual"],
        "emotions": ["Happy", "Confident"],
        "skinTone": "medium",
        "isCustom": false,
        "source": "library"
      },
      {
        "id": "avatar_john_02",
        "name": "John",
        "type": "Realistic",
        "gender": "Male",
        "age": "Middle-aged",
        "thumbnail": "https://cdn.tryslidevid.ai/avatars/john-thumb.jpg",
        "templateUrl": "https://cdn.tryslidevid.ai/avatars/john.mp4",
        "voiceActor": "Professional",
        "isHD": true,
        "isPro": true,
        "isNew": false,
        "situation": ["Business", "Professional"],
        "emotions": ["Neutral", "Serious"],
        "skinTone": "light",
        "isCustom": false,
        "source": "library"
      }
    ],
    "total": 2,
    "library": 2,
    "custom": 0
  }
}

​
Use Cases

While the API doesn’t support direct gender/age filtering, you can filter the results client-side:
const youngFemaleAvatars = data.avatars.filter(
  avatar => avatar.gender === 'Female' && avatar.age === 'Young'
);
Get only avatars that support HD quality:
const hdAvatars = data.avatars.filter(avatar => avatar.isHD);
Identify which avatars require a Pro subscription:
pro_avatars = [a for a in avatars if a['isPro']]
free_avatars = [a for a in avatars if not a['isPro']]

​
Notes

Custom avatars require processing time after creation. Only avatars with status: 2 (completed) are included in the list.
Cache avatar lists for better performance. Avatar libraries don’t change frequently, so you can safely cache this data for 24 hours.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
type
enum<string>
default:all

Filter by avatar type

Available options:
library,
custom,
all

Response

200

Success