v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB

Embedding Utils

Get Document Embed Document

Retrieves limited metadata about an embedded document. If the embed is a snapshot-version embed, the metadata will be drawn from the state of the document at the time that the snapshot was created.

get/v1/documents/{documentId}/embeds/{embedId}/document

Path parameters

documentIdstring uuid required

ID of the embedded document to retrieve.

embedIdstring uuid required

ID of the document embed to retrieve.

Response

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

embedIdstring uuid

Unique identifier of the embed.

documentIdstring uuid

Unique identifier of the document.

pageCountnumber

The number of pages on the document

titlestring

The title of the document.

Example response

{
  "embedId": "ec890631-c150-461c-992f-b96533aa05f4",
  "documentId": "001bd56d-1b10-4196-8ac6-45e3c22bd1c6",
  "pageCount": 5,
  "title": "Documentation example document"
}