Skip to navigation
REST API ReferenceEndpointsEntities

Create entity

Create a reusable entity. Attach reference images with POST /v1/entities/{entityId}/references.

Authentication

AuthorizationBearer

API key from app.videogen.io/api. The full key is only shown once when you create it.

Request

This endpoint expects an object.
entityTypeenumRequired

ACTOR features a consistent character; PRODUCT features a consistent product you sell or promote; 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; BRAND holds a logo, a style guide image, and a writing style; LOCATION features a consistent place or set; PROP features a consistent background object that is not a product.

namestringRequired
Display name.
descriptionstringOptional
Optional description.
brandConfigobjectOptional
Optional configuration for BRAND entities. Omit to create a blank brand.

Response

The created entity
entityIdstring

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

entityTypeenum

ACTOR features a consistent character; PRODUCT features a consistent product you sell or promote; 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; BRAND holds a logo, a style guide image, and a writing style; LOCATION features a consistent place or set; PROP features a consistent background object that is not a product.

namestring
Display name.
descriptionstring
Optional description. Empty string when not set.
referenceslist of objects
Reference images attached to the entity.
createdAtinteger

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

updatedAtinteger

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

actorConfigobject or nullOptional

Voice and presenter summary for ACTOR entities. Null for non-ACTOR entities.

brandConfigobject or nullOptional
Brand guidance for BRAND entities. Null for other entity types.
isBuiltInbooleanOptional

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