Entities

Archive entity

Archive an entity. Archived entities no longer appear in GET /v1/entities and can't be attached to new workflows. Built-in entities (isBuiltIn: true) cannot be archived.

post/v1/entities/{entityId}/archive

Request

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

Path parameters

entityIdstring required

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

Response

Archive acknowledged

entityIdstring required

The id of the archived entity.

archivedboolean required

Always true on success.

Changes

No recorded changes to this operation across all 7 revisions of this API.