Skip to main content
GET

Overview

Returns the avatars available to your team: the Hooked library avatars first, then your team’s custom avatars. Avatars are the Actors of the dashboard, and your custom avatars are the ones under My Actors. Only custom avatars that finished processing are listed. The list is paged with limit (default 50, at most 100) and offset; you are done when offset + limit >= total. Use an avatar’s id as avatarId in the create endpoints (Talking Avatar, UGC Studio, Podcast / Dualcast, Scenes, TikTok Slideshow, …). Each avatar is a still image; every video is generated from it. Voice, lip movement and gestures come from the video model.

Errors

Notes

Custom avatars only appear once they have finished processing.
The library changes rarely; caching this list for a few hours is fine. The call is free and safe to retry.

Authorizations

x-api-key
string
header
required

Query Parameters

type
enum<string>
default:all

library (Hooked library only), custom (your team's only) or all. Any other value returns an empty list.

Available options:
library,
custom,
all
limit
integer
default:50

Page size, 1 to 100. Larger values are capped at 100; missing or invalid values fall back to 50.

Required range: 1 <= x <= 100
offset
integer
default:0

Rows to skip. Missing or invalid values fall back to 0. You are done when offset + limit >= total.

Required range: x >= 0

Response

Avatars

success
boolean
data
object