> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Lucid

> How to set up the Lucid connector, plus the actions that are available.

![Lucid](https://stackone-logos.com/api/lucid/filled/svg)

Betav1.0.0[See changelog](https://docs.stackone.com/connectors/lucid/changelog.md)

[60 actions](#actions) · 2 auth methods

IAM
Documents
Storage

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/lucid/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an OAuth 2.0 client on the Lucid developer portal. Uses the authorization code flow with granular p...

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/lucid/guides/connector-profile/api-key.md)
>
> Uses a long-lived Lucid API key created on the Lucid team administration page. The key acts on behalf of the user who cr...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/lucid/guides/link-account/oauth-2-0.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/lucid/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

account.info

account.user:readonly

folder

folder:readonly

lucid.document.content

lucid.document.content:readonly

lucidchart.document.content.share.collaborator

lucidchart.document.content.share.collaborator:readonly

lucidchart.document.content.share.link

lucidchart.document.content.share.link:readonly

teams

teams:readonly

user.profile

No scopes found

60 actions

ActionDescriptionRequired scopes

Get Account`lucid_get_account`

Retrieve basic information about the authenticated Lucid account, including the account ID and name.

`account.info`

List Document Collaborators`lucid_list_document_collaborators`

List all collaborators (users) on a specific document.

`lucidchart.document.content.share.collaborator:readonly`

Get Document User Collaborator`lucid_get_document_user_collaborator`

Retrieve a specific user's access role on a document.

`lucidchart.document.content.share.collaborator:readonly`

Set Document User Collaborator`lucid_set_document_user_collaborator`

Grant or update a user's access role on a document.

`lucidchart.document.content.share.collaborator`

Remove Document User Collaborator`lucid_remove_document_user_collaborator`

Revoke a user's access to a document.

`lucidchart.document.content.share.collaborator`

Get Document Team Collaborator`lucid_get_document_team_collaborator`

Retrieve a specific team's access role on a document.

`lucidchart.document.content.share.collaborator:readonly`

Set Document Team Collaborator`lucid_set_document_team_collaborator`

Grant or update a team's access role on a document.

`lucidchart.document.content.share.collaborator`

Remove Document Team Collaborator`lucid_remove_document_team_collaborator`

Revoke a team's access to a document.

`lucidchart.document.content.share.collaborator`

List Folder Collaborators`lucid_list_folder_collaborators`

List all user collaborators on a specific folder.

`folder:readonly`

Get Folder User Collaborator`lucid_get_folder_user_collaborator`

Retrieve a specific user's access role on a folder.

`folder:readonly`

Set Folder User Collaborator`lucid_set_folder_user_collaborator`

Grant or update a user's access role on a folder.

`folder`

Remove Folder User Collaborator`lucid_remove_folder_user_collaborator`

Revoke a user's access to a folder.

`folder`

Get Folder Team Collaborator`lucid_get_folder_team_collaborator`

Retrieve a specific team's access role on a folder.

`folder:readonly`

Set Folder Team Collaborator`lucid_set_folder_team_collaborator`

Grant or update a team's access role on a folder.

`folder`

Remove Folder Team Collaborator`lucid_remove_folder_team_collaborator`

Revoke a team's access to a folder.

`folder`

List Document Threads`lucid_list_document_threads`

List all comment threads on a Lucid document, each with its ID, creation time, and open/closed status.

`lucid.document.content:readonly`

List Thread Comments`lucid_list_thread_comments`

List all comments within a specific comment thread on a Lucid document.

`lucid.document.content:readonly`

Post Thread Comment`lucid_create_thread_comment`

Post a new comment to an existing comment thread on a Lucid document.

`lucid.document.content`

Create Document`lucid_create_document`

Create a new blank Lucidchart or Lucidspark document with a title, optionally inside a specific folder.

`lucid.document.content`

Copy Document`lucid_copy_document`

Create a copy of an existing Lucid document with a new title, optionally inside a specific folder.

`lucid.document.content`

Get Document`lucid_get_document`

Retrieve metadata about a specific Lucid document, including its title, product, owner, and edit history.

`lucid.document.content:readonly`

Get Document Contents`lucid_get_document_content`

Retrieve the structured contents (pages, shapes, and data) of a specific Lucid document.

`lucid.document.content:readonly`

Update Document`lucid_update_document`

Update properties of an existing Lucid document, such as its title, parent folder, classification, or custom tags.

`lucid.document.content`

Trash Document`lucid_trash_document`

Move a Lucid document to the trash. This is a soft-delete — the document is recoverable, not permanently removed.

`lucid.document.content`

Search Documents`lucid_search_documents`

Search the requesting user's documents by keywords, product, owner, status, and creation or modification dates.

`lucid.document.content:readonly`

Export Document (Async)`lucid_export_document_async`

Start an asynchronous export of one or more pages of a Lucid document to an image or PDF format.

`lucid.document.content:readonly`

Get Document Export Status`lucid_get_document_export_status`

Check the status of an asynchronous document export job and retrieve the download URL when complete.

`lucid.document.content:readonly`

Create Folder`lucid_create_folder`

Create a new folder, optionally nested inside an existing parent folder.

`folder`

Get Folder`lucid_get_folder`

Retrieve information about a specific folder.

`folder:readonly`

Update Folder`lucid_update_folder`

Update a folder's name or move it to a different parent folder.

`folder`

Trash Folder`lucid_trash_folder`

Move a folder to the trash. This is a soft-delete — the folder is recoverable via restore\_folder, not permanently remove...

`folder`

Restore Folder`lucid_restore_folder`

Restore a previously trashed folder.

`folder`

List Folder Contents`lucid_list_folder_contents`

List the documents and subfolders contained in a specific folder.

`folder:readonly`

Search Folders`lucid_search_folders`

List folders the authenticated user has at least read-only access to, sorted by creation date.

`folder:readonly`

List Root Contents`lucid_list_root_contents`

List the documents and folders at the root of the authenticated user's Lucid workspace.

`folder:readonly`

Create Mermaid Diagram`lucid_create_mermaid_diagram`

Create a diagram in a Lucidchart or Lucidspark document from Mermaid markup.

`lucid.document.content`

List Mermaid Diagrams`lucid_list_mermaid_diagrams`

List the Mermaid diagrams in a Lucidchart or Lucidspark document.

`lucid.document.content:readonly`

Get Mermaid Diagram`lucid_get_mermaid_diagram`

Retrieve a specific Mermaid diagram in a document, including its markup.

`lucid.document.content:readonly`

Update Mermaid Diagram`lucid_update_mermaid_diagram`

Replace the markup of an existing Mermaid diagram in a document.

`lucid.document.content`

Create Document Share Link`lucid_create_document_share_link`

Create a share link that grants access to a document at a specified role.

`lucidchart.document.content.share.link`

Get Document Share Link`lucid_get_document_share_link`

Retrieve information about a share link on a document.

`lucidchart.document.content.share.link:readonly`

Update Document Share Link`lucid_update_document_share_link`

Update the settings of an existing share link on a document.

`lucidchart.document.content.share.link`

Delete Document Share Link`lucid_delete_document_share_link`

Delete a share link from a document.

`lucidchart.document.content.share.link`

Create Folder Share Link`lucid_create_folder_share_link`

Create a share link that grants access to a folder at a specified role.

`folder`

Get Folder Share Link`lucid_get_folder_share_link`

Retrieve information about a share link on a folder.

`folder:readonly`

Update Folder Share Link`lucid_update_folder_share_link`

Update the settings of an existing share link on a folder.

`folder`

Delete Folder Share Link`lucid_delete_folder_share_link`

Delete a share link from a folder.

`folder`

Create Team`lucid_create_team`

Create a new team on the account.

`teams`

List Teams`lucid_list_teams`

List the teams the authenticated user has access to.

`teams:readonly`

Get Team`lucid_get_team`

Retrieve information about a specific team.

`teams:readonly`

Update Team`lucid_update_team`

Update a team's properties, such as its name.

`teams`

Archive Team`lucid_archive_team`

Archive a team, removing it from active use while preserving its data.

`teams`

Restore Team`lucid_restore_team`

Restore a previously archived team.

`teams`

List Team Users`lucid_list_team_users`

List the members of a specific team.

`teams:readonly`

Add Team Users`lucid_add_team_users`

Add one or more users to a team.

`teams`

Remove Team Users`lucid_remove_team_users`

Remove one or more users from a team.

`teams`

Get Profile`lucid_get_profile`

Retrieve the profile of the authenticated Lucid user, including name, username, and email.

`user.profile`

Get User`lucid_get_user`

Retrieve information about a specific user on the account by their user ID.

`account.user:readonly`

List Users`lucid_list_users`

List all users on the authenticated Lucid account.

`account.user:readonly`

Search Users`lucid_search_users`

Find a user on the account by their email address.

`account.user:readonly`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.