---
updatedAt: 2026-06-01T19:53:51.000Z
---

Fetch the complete documentation index at: https://lucid.readme.io/llms.txt. Use this file to discover all available pages before exploring further.

# 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.

Generates a tightly-controlled, limited scope, short-term temporary access token to allow your app to display embedded Lucid documents in an `<iframe>`.

* The token is short-lived, and allows the embedding website to load the document picker and document viewer, but does not grant access to any additional resource within Lucid.

***

## Valid Authentication Methods

### OAuth 2.0 User Token and Account Token Scopes:

* lucidchart.document.app.picker.share.embed
* lucidscale.document.app.picker.share.embed
* lucidspark.document.app.picker.share.embed

***

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Lucid Rest API",
    "description": "The Lucid REST API provides programmatic access to manage documents, users, folders, sharing, licensing, and audit logs across the Lucid Suite (Lucidchart, Lucidspark, and Lucidscale). Authenticate via OAuth 2.0 or API key.",
    "termsOfService": "https://lucid.co/developer-terms",
    "contact": {
      "name": "Lucid Software",
      "url": "https://community.lucid.co/developer-community-6/"
    },
    "license": {
      "name": "Lucid",
      "url": "https://lucid.co/developer-terms"
    },
    "version": "1.0.0"
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": false
  },
  "servers": [
    {
      "url": "https://api.lucid.co"
    }
  ],
  "tags": [
    {
      "name": "Document Embedding",
      "description": "Generate session tokens and render the embedded viewer iframe used to display Lucid documents in external applications."
    }
  ],
  "paths": {
    "/v1/embeds/token": {
      "post": {
        "summary": "Generate Embed Session Token",
        "description": "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.",
        "operationId": "documentEmbedsToken",
        "tags": [
          "Document Embedding"
        ],
        "security": [
          {
            "OAuth2": [
              "lucidchart.document.app.picker.share.embed",
              "lucidscale.document.app.picker.share.embed",
              "lucidspark.document.app.picker.share.embed"
            ]
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "embedId": {
                    "type": "string",
                    "format": "uuid",
                    "description": "ID of the document embed. This is needed for viewing an existing embed."
                  },
                  "origin": {
                    "type": "string",
                    "description": "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": "https://example.com"
                  },
                  "sessionConfig": {
                    "$ref": "#/components/schemas/SessionConfig"
                  }
                },
                "required": [
                  "origin"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Valid token that can be used to embed a document picker or a document viewer.",
            "content": {
              "application/jwt": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request. Occurs when `origin` is missing a protocol, uses an unsupported scheme, or is not a valid URL."
          },
          "401": {
            "description": "Access token is missing or invalid."
          },
          "403": {
            "description": "Access to the embed is forbidden."
          },
          "404": {
            "description": "The embed id in the parameter is not found."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Product": {
        "type": "string",
        "enum": [
          "lucidchart",
          "lucidscale",
          "lucidspark"
        ],
        "description": "The Lucid Suite product that a document was created in.",
        "example": "lucidchart"
      },
      "SessionConfig": {
        "type": "object",
        "properties": {
          "products": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Product"
            },
            "description": "A list of Products that a user can choose a document from to be embedded. Defaults to all products."
          },
          "viewerType": {
            "type": "object",
            "properties": {
              "default": {
                "$ref": "#/components/schemas/ViewerType"
              }
            },
            "description": "What type of viewer to load by defaults. If not specified, defaults to rich. Users can change this later."
          },
          "ui": {
            "$ref": "#/components/schemas/UI"
          },
          "customSettings": {
            "$ref": "#/components/schemas/ViewerCustomSettings"
          }
        }
      },
      "ViewerType": {
        "type": "string",
        "enum": [
          "rich",
          "simple"
        ],
        "description": "- rich: The standard Lucid viewer experience. A fully interactive viewer with zoom, panning, and support for hotspots and other interactive elements.\n- simple: A basic Lucid viewer experience that can be used in place of the rich viewer if there are performance or load time concerns. The simple viewer renders non-interactive raster images instead of a high-fidelity vector experience and is a poorer fit for viewing larger documents.\n"
      },
      "UI": {
        "type": "string",
        "enum": [
          "viewer",
          "settings"
        ],
        "description": "- viewer: When loading an existing embed, go directly to the standard embedded view of the document.\n- settings: When loading an existing embed, show the user the embed settings interface before taking them to the standard embed view of the document.\n"
      },
      "ViewerCustomSettings": {
        "type": "string",
        "enum": [
          "postMessage",
          "none"
        ],
        "description": "- postMessage: Display a \"Settings for <app>\" link in the embed settings view where users can update the settings. When clicked, the OpenCustomSettings postMessage event would be fired so the app can display its own customized settings view.\n- none: \"Settings for <app>\" link would not be available in the settings editor.\n"
      }
    },
    "securitySchemes": {
      "OAuth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://lucid.app/oauth2/authorize",
            "tokenUrl": "https://api.lucid.co/oauth2/token",
            "refreshUrl": "https://api.lucid.co/oauth2/token",
            "scopes": {
              "account.audit.logs": "View audit logs on your account.",
              "account.info": "View basic information about your account (e.g., account ID and account name) .",
              "account.user": "Create, view, edit, and delete users on your account.",
              "account.user:readonly": "View users on your account.",
              "account.users:admin.readonly": "View all users and their roles on your account.",
              "account.user.transfercontent": "Transfer ownership of a user's resources to another user on your account.",
              "account.settings:readonly": "View settings on your account.",
              "account.legalhold": "Create, view, and expire legal holds on your account.",
              "account.legalhold:readonly": "View legal holds on your account.",
              "account.legalhold.users": "Manage legal hold users on your account.",
              "account.legalhold.users:readonly": "View legal hold users on your account.",
              "folder": "Create, view, edit, share, and delete your folders. Organize your folders and their contents.",
              "folder:readonly": "View any of your folders and list their contents.",
              "folder:admin": "Perform admin actions on folders belonging to the account.",
              "folder:admin.readonly": "View all folders belonging to the account with admin permissions.",
              "invitation": "Accept document and folder share links.",
              "invitation.accept": "Accept document and folder share links.",
              "cloud.credential": "Manage cloud credentials.",
              "cloud.credential:readonly": "View cloud credentials.",
              "cloud.datasource": "Manage cloud data sources.",
              "cloud.datasource:readonly": "View cloud data sources.",
              "cloud.model": "Manage cloud models.",
              "repository": "Manage repositories.",
              "repository:readonly": "View repositories.",
              "repository:admin": "Perform admin actions on repositories.",
              "lucid.document.content": "Create, view, edit, and delete any Lucid document accessible by the user.",
              "lucid.document.content:readonly": "View and download any Lucid document accessible by the user.",
              "lucid.document.content:admin": "Perform admin actions on Lucid documents belonging to the account.",
              "lucid.document.content:admin.readonly": "View all Lucid documents belonging to the account with admin permissions.",
              "lucid.document.content.share": "Create, view, edit, and delete document collaborators, embeds, and share links for any Lucid document accessible by the user.",
              "lucid.document.content.share:readonly": "View document collaborators, embeds, and share links for any Lucid document accessible by the user.",
              "lucid.document.content.share.collaborator": "Create, view, edit, and delete document collaborators for any Lucid document accessible by the user.",
              "lucid.document.content.share.collaborator:readonly": "View document collaborators for any Lucid document accessible by the user.",
              "lucid.document.content.share.embed": "Create, view, edit, and delete document embeds for any Lucid document accessible by the user.",
              "lucid.document.content.share.embed:readonly": "View document embeds for any Lucid document accessible by the user.",
              "lucid.document.content.share.link": "Create, view, edit, and delete share links for any Lucid document accessible by the user.",
              "lucid.document.content.share.link:readonly": "View share links for any Lucid document accessible by the user.",
              "lucid.document.storage:admin.readonly": "Perform admin actions backing up Lucid documents belonging to the account.",
              "lucid.document.app": "View, edit, create, and manage folders and documents within an app.",
              "lucid.document.app.folder": "Create, view, edit, and manage any Lucid document within its app-specific folder.",
              "lucid.document.app.picker": "View, edit, and manage any Lucid document selected within an app.",
              "lucid.document.app.picker:readonly": "View and download any Lucid document selected within an app.",
              "lucid.document.app.picker.share": "Create, view, edit, and delete document collaborators, embeds, and share links for any Lucid document selected within an app.",
              "lucid.document.app.picker.share:readonly": "View document collaborators, embeds, and share links for any Lucid document selected within an app.",
              "lucid.document.app.picker.share.collaborator": "Create, view, edit, and delete document collaborators for any Lucid document selected within an app.",
              "lucid.document.app.picker.share.collaborator:readonly": "View document collaborators for any Lucid document selected within an app.",
              "lucid.document.app.picker.share.embed": "Create, view, edit, and delete document embeds for any Lucid document selected within an app.",
              "lucid.document.app.picker.share.embed:readonly": "View document embeds for any Lucid document selected within an app.",
              "lucid.document.app.picker.share.link": "Create, view, edit, and delete share links for any Lucid document selected within an app.",
              "lucid.document.app.picker.share.link:readonly": "View share links for any Lucid document selected within an app.",
              "lucid.document.accessRequest": "Request access to Lucid documents.",
              "licenses:admin": "Perform admin actions on licenses and subscriptions belonging to the account.",
              "licenses:admin.readonly": "View licenses and subscriptions belonging to the account with admin permissions.",
              "teams": "Create, view, and edit, archive, and restore any teams on your account. Control which users belong to teams.",
              "teams:readonly": "View any teams on your account and list which users belong to them.",
              "teams:admin": "Manage teams on your account.",
              "lucidchart.document.app": "View, edit, and manage any Lucidchart document selected for this third-party application. Create, view, edit, and manage any Lucidchart document within its app-specific folder.",
              "lucidchart.document.app.folder": "Create, view, edit, and manage any Lucidchart document within its app-specific folder.",
              "lucidchart.document.app.picker": "View, edit, and manage any Lucidchart document selected for this third-party application.",
              "lucidchart.document.app.picker:readonly": "View and download any Lucidchart document selected for this third-party application.",
              "lucidchart.document.app.picker.share": "Create, view, edit, and delete document collaborators, embeds, and share links for any Lucidchart document selected for this third-party application.",
              "lucidchart.document.app.picker.share:readonly": "View document collaborators, embeds, and share links for any Lucidchart document selected for this third-party application.",
              "lucidchart.document.app.picker.share.collaborator": "Create, view, edit, and delete collaborators and invitations of any Lucidchart document on your team or enterprise account selected for the third-party application.",
              "lucidchart.document.app.picker.share.collaborator:readonly": "View collaborators and invitations of any Lucidchart document on your team or enterprise account selected for the third-party application.",
              "lucidchart.document.app.picker.share.embed": "Create, view, edit, and delete embeds of any Lucidchart document on your team or enterprise account selected for the third-party application.",
              "lucidchart.document.app.picker.share.embed:readonly": "View embeds of any Lucidchart document on your team or enterprise account selected for the third-party application.",
              "lucidchart.document.app.picker.share.link": "Create, view, edit, and delete the third party application's share links of any Lucidchart document on your team or enterprise account selected for the third-party application.",
              "lucidchart.document.app.picker.share.link:readonly": "View the third party application's share links of any Lucidchart document on your team or enterprise account selected for the third-party application.",
              "lucidchart.document.content": "Create, view, edit, and delete any Lucidchart document on your account.",
              "lucidchart.document.content:readonly": "View and download any Lucidchart document on your account.",
              "lucidchart.document.content:admin": "Perform admin actions on Lucidchart documents belonging to the account.",
              "lucidchart.document.content:admin.readonly": "View all Lucidchart documents belonging to the account with admin permissions.",
              "lucidchart.document.content.share": "Create, view, edit, and delete document collaborators, embeds, and share links for any of your Lucidchart documents.",
              "lucidchart.document.content.share:readonly": "View document collaborators, embeds, and share links for any of your Lucidchart documents.",
              "lucidchart.document.content.share.collaborator": "Create, view, edit, and delete collaborators and invitations for any of your Lucidchart documents on your team or enterprise account.",
              "lucidchart.document.content.share.collaborator:readonly": "View collaborators and invitations for any of your Lucidchart documents on your team or enterprise account.",
              "lucidchart.document.content.share.embed": "Create, view, edit, and delete embeds for any of your Lucidchart documents on your team or enterprise account.",
              "lucidchart.document.content.share.embed:readonly": "View embeds for any of your Lucidchart documents on your team or enterprise account.",
              "lucidchart.document.content.share.link": "Create, view, edit, and delete the third party application's share links for any of your Lucidchart documents on your team or enterprise account.",
              "lucidchart.document.content.share.link:readonly": "View the third party application's share links for any of your Lucidchart documents on your team or enterprise account.",
              "lucidchart.document.storage:admin.readonly": "Perform admin actions backing up Lucidchart documents belonging to the account.",
              "lucidchart.document.accessRequest": "Request access to Lucidchart documents.",
              "lucidspark.document.app": "View, edit, and manage any Lucidspark board selected for this third-party application. Create, view, edit, and manage any Lucidspark board within its app-specific folder.",
              "lucidspark.document.app.folder": "Create, view, edit, and manage any Lucidspark board within its app-specific folder.",
              "lucidspark.document.app.picker": "View, edit, and manage any Lucidspark board selected for this third-party application.",
              "lucidspark.document.app.picker:readonly": "View and download any Lucidspark board selected for this third-party application.",
              "lucidspark.document.app.picker.share": "Create, view, edit, and delete document collaborators, embeds, and share links for any Lucidspark board selected for this third-party application.",
              "lucidspark.document.app.picker.share:readonly": "View document collaborators, embeds, and share links for any Lucidspark board selected for this third-party application.",
              "lucidspark.document.app.picker.share.collaborator": "Create, view, edit, and delete collaborators and invitations of any Lucidspark board on your team or enterprise account selected for the third-party application.",
              "lucidspark.document.app.picker.share.collaborator:readonly": "View collaborators and invitations of any Lucidspark board on your team or enterprise account selected for the third-party application.",
              "lucidspark.document.app.picker.share.embed": "Create, view, edit, and delete embeds of any Lucidspark board on your team or enterprise account selected for the third-party application.",
              "lucidspark.document.app.picker.share.embed:readonly": "View embeds of any Lucidspark board on your team or enterprise account selected for the third-party application.",
              "lucidspark.document.app.picker.share.link": "Create, view, edit, and delete the third party application's share links of any Lucidspark board on your team or enterprise account selected for the third-party application.",
              "lucidspark.document.app.picker.share.link:readonly": "View the third party application's share links of any Lucidspark board on your team or enterprise account selected for the third-party application.",
              "lucidspark.document.content": "Create, view, edit, and delete any Lucidspark board on your account.",
              "lucidspark.document.content:readonly": "View and download any Lucidspark board on your account.",
              "lucidspark.document.content:admin": "Perform admin actions on Lucidspark boards belonging to the account.",
              "lucidspark.document.content:admin.readonly": "View all Lucidspark boards belonging to the account with admin permissions.",
              "lucidspark.document.content.share": "Create, view, edit, and delete document collaborators, embeds, and share links for any of your Lucidspark boards.",
              "lucidspark.document.content.share:readonly": "View document collaborators, embeds, and share links for any of your Lucidspark boards.",
              "lucidspark.document.content.share.collaborator": "Create, view, edit, and delete collaborators and invitations for any of your Lucidspark boards on your team or enterprise account.",
              "lucidspark.document.content.share.collaborator:readonly": "View collaborators and invitations for any of your Lucidspark boards on your team or enterprise account.",
              "lucidspark.document.content.share.embed": "Create, view, edit, and delete embeds for any of your Lucidspark boards on your team or enterprise account.",
              "lucidspark.document.content.share.embed:readonly": "View embeds for any of your Lucidspark boards on your team or enterprise account.",
              "lucidspark.document.content.share.link": "Create, view, edit, and delete the third party application's share links for any of your Lucidspark boards on your team or enterprise account.",
              "lucidspark.document.content.share.link:readonly": "View the third party application's share links for any of your Lucidspark boards on your team or enterprise account.",
              "lucidspark.document.storage:admin.readonly": "Perform admin actions backing up Lucidspark boards belonging to the account.",
              "lucidspark.document.accessRequest": "Request access to Lucidspark boards.",
              "lucidscale.document.app": "View, edit, and manage any Lucidscale model selected for this third-party application. Create, view, edit, and manage any Lucidscale model within its app-specific folder.",
              "lucidscale.document.app.folder": "Create, view, edit, and manage any Lucidscale model within its app-specific folder.",
              "lucidscale.document.app.picker": "View, edit, and manage any Lucidscale model selected for this third-party application.",
              "lucidscale.document.app.picker:readonly": "View and download any Lucidscale model selected for this third-party application.",
              "lucidscale.document.app.picker.share": "Create, view, edit, and delete document collaborators, embeds, and share links for any Lucidscale model selected for this third-party application.",
              "lucidscale.document.app.picker.share:readonly": "View document collaborators, embeds, and share links for any Lucidscale model selected for this third-party application.",
              "lucidscale.document.app.picker.share.collaborator": "Create, view, edit, and delete collaborators and invitations of any Lucidscale model on your team or enterprise account selected for the third-party application.",
              "lucidscale.document.app.picker.share.collaborator:readonly": "View collaborators and invitations of any Lucidscale model on your team or enterprise account selected for the third-party application.",
              "lucidscale.document.app.picker.share.embed": "Create, view, edit, and delete embeds of any Lucidscale model on your team or enterprise account selected for the third-party application.",
              "lucidscale.document.app.picker.share.embed:readonly": "View embeds of any Lucidscale model on your team or enterprise account selected for the third-party application.",
              "lucidscale.document.app.picker.share.link": "Create, view, edit, and delete the third party application's share links of any Lucidscale model on your team or enterprise account selected for the third-party application.",
              "lucidscale.document.app.picker.share.link:readonly": "View the third party application's share links of any Lucidscale model on your team or enterprise account selected for the third-party application.",
              "lucidscale.document.content": "Create, view, edit, and delete any Lucidscale model on your account.",
              "lucidscale.document.content:readonly": "View and download any Lucidscale model on your account.",
              "lucidscale.document.content:admin": "Perform admin actions on Lucidscale models belonging to the account.",
              "lucidscale.document.content:admin.readonly": "View all Lucidscale models belonging to the account with admin permissions.",
              "lucidscale.document.content.share": "Create, view, edit, and delete document collaborators, embeds, and share links for any of your Lucidscale models.",
              "lucidscale.document.content.share:readonly": "View document collaborators, embeds, and share links for any of your Lucidscale models.",
              "lucidscale.document.content.share.collaborator": "Create, view, edit, and delete collaborators and invitations for any of your Lucidscale models on your team or enterprise account.",
              "lucidscale.document.content.share.collaborator:readonly": "View collaborators and invitations for any of your Lucidscale models on your team or enterprise account.",
              "lucidscale.document.content.share.embed": "Create, view, edit, and delete embeds for any of your Lucidscale models on your team or enterprise account.",
              "lucidscale.document.content.share.embed:readonly": "View embeds for any of your Lucidscale models on your team or enterprise account.",
              "lucidscale.document.content.share.link": "Create, view, edit, and delete the third party application's share links for any of your Lucidscale models on your team or enterprise account.",
              "lucidscale.document.content.share.link:readonly": "View the third party application's share links for any of your Lucidscale models on your team or enterprise account.",
              "lucidscale.document.storage:admin.readonly": "Perform admin actions backing up Lucidscale models belonging to the account.",
              "lucidscale.document.accessRequest": "Request access to Lucidscale models.",
              "offline_access": "Continue to perform authorized actions when you're not logged in (required to refresh tokens).",
              "user.profile": "Allow applications to view basic information about you (e.g., full name, username, and email).",
              "document.app": "View, edit, and manage any Lucidchart document selected for this third-party application. Create, view, edit, and manage any Lucidchart document within its app-specific folder.",
              "document.app.folder": "Create, view, edit, and manage any Lucidchart document within its app-specific folder.",
              "document.app.picker": "View, edit, and manage any Lucidchart document selected for this third-party application.",
              "document.app.picker:readonly": "View and download any Lucidchart document selected for this third-party application.",
              "document.content": "Create, view, edit, and delete any Lucidchart document on your account.",
              "document.content:readonly": "View and download any Lucidchart document on your account."
            }
          }
        }
      }
    }
  }
}
```