> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.videogen.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.videogen.io/_mcp/server.

# Archive entity

POST https://api.videogen.io/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.

Reference: https://docs.videogen.io/rest-api-reference/entities/archive-entity

## Authentication

- `Authorization` header (bearer token, required) — API key from [app.videogen.io/api](https://app.videogen.io/api). The full key is only shown once when you create it.

## Request

### Path parameters

- `entityId` (string, required) — The entity id (e.g. `vg_enti_...`).

## Response

### 200

Archive acknowledged

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

## Examples

**Response**

```json
{
  "entityId": "vg_enti_a1b2c3d4e5f6",
  "archived": true
}
```

**SDK Code**

```python
import requests

url = "https://api.videogen.io/v1/entities/vg_enti_a1b2c3d4e5f6/archive"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.json())
```