---
title: "Archive entity"
method: POST
path: "/v1/entities/{entityId}/archive"
tags: ["Entities"]
---

# Archive entity

`POST /v1/entities/{entityId}/archive`

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.

## Path parameters

- `entityId` string, required

## Response `200`

Archive acknowledged

- EntityArchiveResponse
  - `entityId` string, required — The id of the archived entity.
  - `archived` boolean, required — Always true on success.

## Other responses

- `default` — Error

---

[API](https://skmtc.dev/videogen/apis/videogen-api.md) · [All operations](https://skmtc.dev/videogen/apis/videogen-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/videogen/videogen-api/revisions/33dda0455d67/schema)