Lucid Unfurling API
Retrieve metadata for Lucid document links to power rich previews, and serve direct iframe embeds for Lucid documents in external applications.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/lucid-unfurling-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Lucid REST Unfurling API
version: '1.0'
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.
contact:
name: Lucid Developer Platform
url: https://developer.lucid.co/
x-documentation: https://developer.lucid.co/reference/api
servers:
- url: https://api.lucid.co
tags:
- name: Unfurling
description: Retrieve metadata for Lucid document links to power rich previews, and serve direct iframe embeds for Lucid documents in external applications.
paths:
/v1/describeLink:
post:
summary: Describe Link
description: 'Retrieve metadata about a Lucid document from its URL, including the document title, product, and type. Use this to generate rich link previews (unfurling) in external applications.
'
operationId: describeLink
tags:
- Unfurling
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- url
properties:
url:
type: string
description: The URL of the Lucid document link to parse information from.
responses:
'200':
description: Successfully retrieved information about the document link.
content:
application/json:
schema:
$ref: '#/components/schemas/LinkResource'
'403':
description: The URL is not a valid Lucid link.
security:
- ApiKey: []
- OAuth2: []
/v1/embeds/link:
get:
summary: Direct Embed
description: Display an embed within an iframe. If the clientId is valid with the registered embed domain in the developer portal, the iframe will show either a login page or an embedded document viewer depending on the user's authorization status via browser cookies.
operationId: directEmbed
tags:
- Unfurling
parameters:
- name: document
in: query
required: true
schema:
type: string
description: The URL of the Lucid document link or the documentId retrieved from the Describe Link endpoint.
- name: clientId
in: query
required: true
schema:
type: string
description: The client ID obtained during App registration.
responses:
'200':
description: OK - The iframe content displaying the embedded document picker or viewer.
'400':
description: Bad Request
components:
schemas:
LinkDocument:
type: object
properties:
documentId:
type: string
format: uuid
example: 110808fd-4553-4316-bccf-4f25ff59a532
description: Unique identifier of the document.
page:
type:
- string
- 'null'
description: Page information of the document, if applicable.
product:
type: string
example: lucidspark
description: The Lucid product the document belongs to.
description: Information about the Document contained in the link if it exists.
LinkInvitation:
type: object
properties:
invitationId:
type: string
format: uuid
example: inv_288b9365-685b-4bf2-9f6f-8aa9e2082542
description: Unique identifier of the invitation.
description: Information about the Invitation contained in the link if it exists.
LinkResource:
type: object
properties:
document:
$ref: '#/components/schemas/LinkDocument'
invitation:
$ref: '#/components/schemas/LinkInvitation'
description: Resource representing information contained in a Lucid link.
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.
ApiKey:
type: http
scheme: bearer
x-harvest:
harvested: '2026-08-01'
method: searched
source: https://lucid-developer-docs.readme.io/mcp
note: 'Assembled operation-by-operation from Lucid''s own documentation MCP server (tools list-endpoints + get-endpoint), which returns verbatim OpenAPI 3.0.3 fragments out of the spec Lucid uploaded to its ReadMe hub (/branches/1.4/apis/lucid-rest-api.json). Paths, operations, parameters, request bodies, responses, components and securitySchemes are provider content, unmodified. Only the info block is ours: ReadMe''s per-endpoint fragments omit info, so title/description are copied verbatim from the provider''s own list-specs description for this spec.'