latestOpenAPI 3.1.12026-08-22330162.7 KB

35448566f143

Elements

List your elements

Returns your saved elements: people/characters, products/props, and places, plus the built-in ones. Elements carry a real reference photo.

How to use them: mention an element in a video script as @handle (for example [@Dhiva holding @Red-Bottle] Meet the founder...) and its photo is fed to the image model, so the same face or product appears consistently across the whole video. Characters can also be used as avatarId for talking-head videos.

Create new elements with POST /elements or in the AITuber dashboard.

get/elements

Query parameters

type'character' | 'prop' | 'location'

Filter by element type. Omit for all.

Response

idstring uuid required

Element ID. For characters, this is also a valid avatarId for avatar videos.

namestring required

Element name.

handlestring required

Mention this element in a video script as @handle to put it in the video.

type'character' | 'prop' | 'location' required

character = a person or mascot, prop = an object or product, location = a place.

descriptionstring nullable required

Optional context notes. Appearance always comes from the photo, not from this text.

customboolean required

True for elements you created, false for built-in ones.

previewImageUrlstring nullable required

The reference photo.