Entities

Get entity

Retrieve a single entity by its id, including its reference images. Built-in catalog entities are included.

get/v1/entities/{entityId}

Path parameters

entityIdstring required

The entity id (e.g. vg_enti_...).

Response

Entity

entityIdstring required

The entity id (e.g. vg_enti_...).

entityType'ACTOR' | 'PRODUCT' | 'VISUAL_STYLE' | 'SLIDESHOW_THEME' required

ACTOR features a consistent character; PRODUCT features a consistent product or object; VISUAL_STYLE guides the look of generated images; SLIDESHOW_THEME is a shared slide design system (fonts, colors, layout) applied to every slide of a slideshow-to-video deck.

namestring required

Display name.

descriptionstring required

Optional description. Empty string when not set.

createdAtinteger required

Seconds since epoch (Unix timestamp) when the entity was created.

updatedAtinteger required

Seconds since epoch (Unix timestamp) when the entity was last updated.

isBuiltInboolean

When true, this is a VideoGen catalog entity. Built-in entities cannot be updated, archived, or have references added or removed.

Changes

No recorded changes to this endpoint across all 1 revision of this API.