REST API ReferenceEndpointsEntities

Get entity

Retrieve a single entity by its id, including its reference images.

Authentication

AuthorizationBearer
API key from [app.videogen.io/developers](https://app.videogen.io/developers). The full key is only shown once when you create it.

Path parameters

entityIdstringRequired

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

Response

Entity
entityIdstring

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

entityTypeenum

ACTOR features a consistent character; PRODUCT features a consistent product or object; VISUAL_STYLE guides the look of generated images.

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 null

Voice and presenter summary for ACTOR entities. Null for VISUAL_STYLE entities.