latestOpenAPI 3.1.12026-08-22330162.7 KB

35448566f143

Videos

List avatars for talking-head videos

Returns every avatar you can use for talking-head videos: built-in avatars available to everyone, plus your own characters.

Pass the id as avatarId in POST /videos/generate with mediaType: "avatar". Create a new avatar with POST /elements (type character, with a photo) or in the AITuber dashboard.

get/avatars

Response

idstring uuid required

Avatar ID. Pass as avatarId in POST /videos/generate with mediaType: "avatar".

namestring required

Display name.

descriptionstring nullable required

Look description, when set.

customboolean required

True for avatars you created in the dashboard, false for built-in avatars.

previewImageUrlstring nullable required

The avatar reference image.

defaultVoiceIdstring nullable required

A voice previously paired with this avatar, when set. You can pass it as voiceId, or pick any voice from GET /voices.