Sign in
Entities

Add entity reference

Attach an image file as a reference for the entity. Upload the image first via POST /v1/files/upload. Returns the updated entity. Built-in entities (isBuiltIn: true) cannot have references added.

post/v1/entities/{entityId}/references

Path parameters

entityIdstring required

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

Request body

fileIdstring required

The file id (e.g. vg_file_...) of an image to attach as a reference.

descriptionstring

Optional description of the reference.

isDefaultboolean

When true, make this the entity's primary reference (used for its thumbnail).

Response

The updated 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.