VIvideogen
Entities

Add entity reference

Changed on

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

Request

  • Base URL
    https://api.videogen.io
  • Auth
    HTTP bearer

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.

role'REFERENCE' | 'BRAND_LOGO' | 'BRAND_STYLE_GUIDE'

What the file is used for. BRAND_LOGO and BRAND_STYLE_GUIDE are only allowed on BRAND entities, and attaching one replaces the brand's previous logo or style guide. BRAND_LOGO is applied as the video logo overlay and is never used as a generation 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' | 'BRAND' | 'LOCATION' | 'PROP' required

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 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

  • 2976ed641a0cRevision changes
    • warning

      added the new BRAND enum value to the response property for the response status

    • warning

      added the new LOCATION enum value to the response property for the response status

    • warning

      added the new PROP enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the required property // to the response with the status