Document Embedding

Generate Embed Session Token

Generates a short-lived, limited-scope temporary access token to allow your app to display embedded Lucid documents in an iframe. The token allows the embedding website to load the document picker and document viewer, but does not grant access to any additional resource within Lucid.

post/v1/embeds/token

Request

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

Request body

embedIdstring uuid

ID of the document embed. This is needed for viewing an existing embed.

originstring required

The URL (including protocol) of the webpage that will host the embed. Must use the https:// scheme (e.g., https://example.com, http://localhost).

Example request

{
  "origin": "https://example.com",
  "sessionConfig": {
    "products": [
      "lucidchart"
    ]
  }
}

Response

Valid token that can be used to embed a document picker or a document viewer.

Changes

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