Sign in

v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Embedding Utils

Change Document Embed Version

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.

post/v1/documents/{documentId}/embeds/{embedId}/changeVersion

Path parameters

documentIdstring uuid required

ID of the embedded document to retrieve.

embedIdstring uuid required

ID of the document embed to retrieve.

Request body

embedVersion'latest-version' | 'snapshot-version' required

Determines what version of the document will be loaded in the document viewer.

Example request

{
  "embedVersion": "snapshot-version"
}

Response

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

embedIdstring uuid

Unique identifier of the embed.

documentIdstring uuid

Unique identifier of the document.

embedVersionstring

The version of the embed.

createdstring date

When the embed was created.

modifiedstring date

When the embed was last modified.

Example response

{
  "embedId": "ec890631-c150-461c-992f-b96533aa05f4",
  "documentId": "001bd56d-1b10-4196-8ac6-45e3c22bd1c6",
  "embedVersion": "snapshot-version",
  "created": "2021-10-01T20:49:36.169Z",
  "modified": "2021-10-01T20:49:36.169Z"
}