Skip to navigation
REST API ReferenceEndpointsEntities

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.

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequired

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

Response

Archive acknowledged
entityIdstring
The id of the archived entity.
archivedboolean
Always true on success.