Embedding Utils

Create Document Embed

Creates an embed resource associated with a particular document. The request must be authenticated with an OAuth 2.0 token that has access to the document being embedded.

post/v1/documents/{id}/embeds

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/documents/{id}/embeds
  • Auth: OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: lucidchart.document.content.share.embed, lucidchart.document.app.picker.share.embed, lucidscale.document.content.share.embed, lucidscale.document.app.picker.share.embed, lucidspark.document.content.share.embed, lucidspark.document.app.picker.share.embed)

Path parameters

idstring uuid required

ID of the document to be embedded.

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 newly created 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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.