---
title: "Change Document Embed Version"
method: POST
path: "/v1/documents/{documentId}/embeds/{embedId}/changeVersion"
tags: ["Embedding Utils"]
---

# Change Document Embed Version

`POST /v1/documents/{documentId}/embeds/{embedId}/changeVersion`

Updates the version type of an existing document embed. When called with an embedVersion of "snapshot-version", the endpoint associates the existing embed with a snapshot of the document's current state. Updating an embed's version to snapshot-version cannot be reversed.

## Path parameters

- `documentId` string, uuid, required
- `embedId` string, uuid, required

## Request body

- object
  - `embedVersion` 'latest-version' | 'snapshot-version', required — Determines what version of the document will be loaded in the document viewer.

## Response `200`

OK. Returns a Document Embed Resource containing information about the updated document embed.

- EmbedInformation — Information about the requested Embed.
  - `embedId` string, uuid — Unique identifier of the embed.
  - `documentId` string, uuid — Unique identifier of the document.
  - `embedVersion` string — The version of the embed.
  - `created` string, date — When the embed was created.
  - `modified` string, date — When the embed was last modified.

## Other responses

- `400` — Bad Request. Occurs if the embed version provided in the request body is invalid.
- `403` — Forbidden. Occurs when the access token isn't allowed to change the embed version.

---

[API](https://skmtc.net/lucid/apis/lucid-rest-api.md) · [All operations](https://skmtc.net/lucid/apis/lucid-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lucid/lucid-rest-api/revisions/6a32cb9e1aa7/schema)