Skip to main content
hamburger menu
+ Create a topic

Lucid for Developers

Learn from and collaborate with other developers. Find answers to your most technical questions and get support with Lucid's APIs.

  • 230 Topics
  • 821 Replies
230 Topics
S
Scott PLucidite
posted in Lucid for Developers
🚀 Announcing Editable Embeds on Lucid's API!

Hey Lucid Devs! 👋We’re excited to introduce Editable Embeds—a new way to integrate Lucid documents directly into your web applications! 📝 Now you can embed Lucid documents that are not just viewable but fully editable with our token-based embed solution, allowing for seamless collaboration right within your own platform. Why Editable Embeds?By embedding the Lucid experience in other apps, you can improve documentation and minimize the need to switch between apps. With Editable Embeds, you can:Enable users to edit and collaborate on Lucid documents directly within your app. Streamline development and testing with an easy-to-use embedding process. Add comprehensive diagramming and collaboration tools to your application. 🛠 How to Get StartedPut simply, here’s the setup: create an application > obtain an access token > generate an embed session token > embed the viewer in your app > configure “editable” access level. See the details (and example implementations!) in our Tok

4263
Eric Padron
Lucid Legend Level 4
S
Scott PLucidite
posted in Lucid for Developers
🚀 Announcing New API Keys available on Lucid’s API!

Hey Lucid Devs! 👋We’re excited to introduce a new way to securely access the Lucid API using API Keys! 🔑  Even seasoned engineers sometimes find OAuth2 complex and time-consuming—it can take hours to set up properly. With API Keys, the process is far more straightforward. Simply generate an API Key in the Dev Portal and include it in your API requests!🛠 How to Get StartedCheck out our API Keys Guide!🔒 Are there Admin Controls?Yes, Admins can choose to enable/disable API Keys. Apps with API Keys will only be accessible from the Developer Portal by the App creator and any Lucid Developer added as a collaborator to the app. See our App Collaborator roles guide for more information.  🚨 Important NotesTreat your API Keys like passwords. Do not expose them in your client-side code or share them publicly.  Regularly review and rotate your API Keys to maintain security. Generally, an API Key can be used in place of an OAuth 2.0 User token, however certain endpoints– such as the Document S

6397
Richard U
S
Scott PLucidite
posted in Lucid for Developers
Recent webinar recording: See firsthand how easy it is to build in Lucid

Curious to see what’s possible for your org to build through the Lucid developer platform?In our most recent webinar, our developers demonstrated how easy it is to build an extension on Lucid’s developer platform by building one in real time.During the webinar, you’ll also see the types of integrations you can build on the developer platform as well as open-source examples to use as starting points in your own projects. Here is a link to the recording: How to build an extension on Lucid’s developer platformRecorded on May 30, 2024 You can also check out the demo integration for yourself on Lucid's integration marketplace and an accompanying guide in our developer documentation. We’d love to hear what you’re building and are happy to answer any questions you have about our demo. Drop a comment below!   

1460
S
R
Rajath
asked in Lucid for Developers
Latest Version of Mermaid in Lucidchart

Can the latest version of mermaid be supported in Lucidchart? With the current supported version, I am getting a few syntax error while testing out the default syntax from mermaid website.  Once the flowcharts have been created using the code, can we have the following features? Conditional formatting to update the block, line (arrow) and text color, size, font style. Provide an option to copy the generated flow into a new image so that conditional formatting can be applied as needed.

665
Richard U
T
tony.cox.gboutdoorfires.co.uk
asked in Lucid for Developers
Do I have access to API with a free trial?

I have signed up for a 7-day Free Trial of the ‘Teams’ level of subscription and want to create some templates in bulk via the API before my company sorts out it licensing. I have followed some guides and managed to create an API Key, but it is not working when I try to test it via Google Colab. I’ve tried it several times now and wonder if it is just not going to work while I’m on the ‘Free’ trial status?

334
Richard U
Q
quodsimDan
asked in Lucid for Developers
What is the difference in icons

When I add an item to a collection from a data connector vs extension editor, it appears different in the Data Tools UI.  model_definitions were created in the extension editor and does not have a paper icon next to it.  The other collections were created in my data connector and they have a paper icon next to them.  What does the paper icon mean? Perhaps on a related note, but, when I add an model_definitions item with the exact same primary key, I am getting duplicates of that item.  Despite my best efforts (so far), I am unable to “update” an existing collection item when using the extension editor.  Items added to collections from my data connector do not create duplicates.Thanks,Dan

101
Richard U
H
Hampton
asked in Lucid for Developers
Width & Height under Advance Options

Are there any shapes available or that I can make through illustrator that will allow for ‘shapes data’ controlled Width & Height?  This would be extremely helpful for bubble diagramming as I have a table of sizes that may change and I’d like to use this function to see the bubbles automatically change. Thank you,Hampton

212
H
N
nikolai
asked in Lucid for Developers
Programmatically create shapes and lines using REST API?

Hello Lucidchart Developer Community,I'm currently exploring the functionalities of the Lucidchart API and I've hit a roadblock. My project requires dynamic creation and manipulation of diagram elements, specifically shapes and lines, and I'm curious about the extent of Lucidchart's API capabilities in this regard.Does Lucidchart offer a REST API that allows for the programmatic creation of shapes and lines within a diagram? I'm interested in understanding how detailed this control is, such as specifying types, sizes, positions, and custom styling for these elements. Additionally, how feasible is it to dynamically add, modify, or interconnect these elements within a Lucidchart document via automated processes or external applications?Any insights, documentation references, or examples of similar implementations would be greatly appreciated. Looking forward to your responses and guidance!Best regards,Nikolai

4158
J
Michel L
Michel L
asked in Lucid for Developers
Detection of running mode of Lucidchart Extension

Hi there,is there a way to detect by code if my extension is running locally in testing mode or remotely using the published application.It could be interesting like - displaying debug message or not - to know whether the dataconnectors are served locally (using the local express server (debug-server.js) or remotely server of the published application, -…Regards.

251
Ian Baenziger
wasiq.hussain
wasiq.hussain
asked in Lucid for Developers
Lucidchart data import from Snowflake via API

HiI would appreciate if you could provide me with more information regarding Lucidchart's API capabilities for importing data. Specifically I would like to know if it is possible to develop an organization chart in Lucidchart by importing data from an external source such as Snowflake using the Lucidchart API. I do know for a fact that it is not possible to directly connect to Snowflake.It would be helpful if you could direct us to relevant documentation or provide guidance on how we can achieve this integration.Thanks.

6233
Richard U
Mahendra J
Mahendra J
asked in Lucid for Developers
Lucidchart Integration using API for Entity-Relationship Diagram

Hello We are building MDM tool to manage dimension metadata. We have all the metadata that Lucidchart need to build Entity Relationship Diagram. Instead of importing metadata manually is there an API which we can use to supply metadata in JSON format to generate Entity Relation Diagram? Thanks Mahendra

835
J
Z
zoran
asked in Lucid for Developers
Retrieving Pricing Plan Details via Lucid APIs

Hi Lucid Community,We are exploring ways to leverage Lucid APIs to retrieve user license details. While we are aware that SCIM APIs are available for enterprise plans, our interest lies in obtaining information about users in Team, Enterprise Shield, and similar pricing plans.Specifically, we would like to use APIs to identify which licenses users have been allocated—such as Team, Enterprise Suite, or Shield add-on licenses. We understand there are currently no direct APIs for this purpose and are curious if there might be any workarounds or alternative methods to achieve this.

1017
Michel L
S
sarvesh.lakhera
asked in Lucid for Developers
Lucid’s API for Flowchart Generation use cases

Hi, I am working on integration and have some questions related to the use cases we are looking for. I want to have clarity about Lucid’s APIs before purchasing any plans. I contacted support@lucidchart.com with below queries, but got no response.Does Lucid offers APIs for creating a flowchart using an AI prompt? If yes, then Can I later edit the flowchart (SVG/PNG) which I get in response using Lucid APIs/platform?  Can API return the explanation or pseudo code for the generated flowchart? Can API generate the flowchart by going through a document which has an explanation of a module or an application? If we go with a plan having API access, then which models we will be working with? Can we give code in prompt and based on it, API will generate the flowchart?Let me know if anyone can help or refer me to documentation which all these details.Thanks

422
Eric Padron
Lucid Legend Level 4
J
jayant.kumar
asked in Lucid for Developers
Need Assistance Accessing Lucidchart API and Developer Portal

I'm currently working on a project that involves integrating Lucid chart's interface into a website. The goal is to provide users with the ability to edit, view, and save charts directly from our interface,I've encountered an issue during the initial setup. I’m unable to access the Lucid chart Developer Portal for further documentation and resources. However, every time I try to access the portal, I am redirected to the documents page with the message:"To unlock the Developer Portal, contact your admin for the developer role assignment. Unsure who your admin is? Check our documentation for guidance."even if I’m not on an enterprise account but on free trial.I've looked through the documentation, but I'm still unsure how to get api keys or the developer portal access. Is there a specific process for getting the developer role assignment without contacting the admin as it is my personal account. Also, in user settings there is no option to turn on developer account or mode.Any insights o

1545
Richard U
N
nirm
asked in Lucid for Developers
Export users list with via api

Hello ,i want to export users list with with api token (powershell script)how can i create api token with permission to export users list  help please :)

363
J
J
johnktejik
asked in Lucid for Developers
Uploading a file using node.js?

I’m trying to upload a .lucid file to lucidchart to create a document, using node.js.  The examples herehttps://github.com/lucidsoftware/sample-lucid-rest-applicationsEither are python, or do not upload files.The tricky bit is setting the ‘content-type’ of the individual file to ‘x-application/vnd.lucid.standardImport’ (A stupid requirement, FYI).  Python has an easy syntax.  Node.js?  Not so much.  I’ve tried adding a blob         const blob = new Blob([myzipfilestream], { type: 'x-application/vnd.lucid.standardImport' }) but I get some cryptic error about ‘source.on is not a function’.Does anyone have an example of *working* Node.js code that uploads a .lucid file to lucidchart via a POST request?Thanks

561
J
Q
quodsimDan
asked in Lucid for Developers
Access the DataProxy within DataConnectorAsynchronousAction?

 My extension editor has defined a data source which contains multiple collections of data items.I have an Data Connector Action defined that gets triggered when a user hits a button in the extension editor.I know in the extension editor project, I have access to a DataProxy, which has access to DataSources and CollectionProxy, etc. Through the DataProxy, I am able to access all the custom data found in the document correct?Assuming that is true, in a Data Connector project, such as in an action: DataConnectorAsynchronousAction, is it similarly possible to access all the custom data found in the document?  If so, how?  I am not seeing how I can access the DataProxy within DataConnectorAsynchronousAction. Thanks,Dan 

545
Q
H
helloworld
asked in Lucid for Developers
Lucidchart Mermaid Syntax Errors

Mermaid chart generates syntax error for valid mermaid code. This is consistently happening with code generated and valid for other mermaid diagram generators. 

403
M
P
PZ973R
asked in Lucid for Developers
Bug in Mermaid chart

There is a bug in how Lucid is handling mermaid. Example: flowchart TDListener -- call --> Dispatcher it will cause a syntax error. The code runs fine in mermaid editor and typora. Seems it doesn’t like the word “call” there.  

371
Richard U
Michel L
Michel L
asked in Lucid for Developers
Github Data Connector Example don't work when publshed

I have tried the https://github.com/lucidsoftware/sample-lucid-extensions/blob/main/data-connector-exampleAnd it works quite well locally with the commands “npx lucid-package test-editor-extension data-connector-example” and “npm start”.for the connector.But when this extension is published in Applications on my portal it does not work i’m getting a 401 response.Any explanation ?Best regards.

232
Michel L
Michel L
Michel L
asked in Lucid for Developers
Doc Error on Rest API for Listing Users

Not so much important but I noticed a mistake in the documentation here:https://developer.lucid.co/reference/listusersThe result is describe like that:[ { "accountId": 100, "email": "john-doe@example.com", "name": "John Doe", "userId": 101, "usernames": "johndoe", "roles": [ "billing-admin", "team-admin" ] }]But the “usernames” field is “username”.so it would be :[ { "accountId": 100, "email": "john-doe@example.com", "name": "John Doe", "userId": 101, "username": "johndoe", "roles": [ "billing-admin", "team-admin" ] }]Regards

261
J
Q
quodsimDan
asked in Lucid for Developers
How to Delete a DataSource or Collection?

If my extension editor has create a DataSource, is there a way for it to delete it as well? Here is the documentation URLs that I looked for a delete method in:https://developer.lucid.co/reference/dataproxy-sdk https://developer.lucid.co/reference/datasourceproxy-sdk https://developer.lucid.co/reference/collectionproxy-sdk https://developer.lucid.co/reference/dataitemproxy-sdkThanks,Dan

432
Michel L
sdelpercio
sdelpercio
asked in Lucid for Developers
Question: Is it possible to create a team via API?

Hello Lucid Dev Community!I have a group of users looking for a way to automate team creation via API.Id love to do this for them but I am not finding a clear solution for this. I was hoping to pair with someone that could shed a little light on my path forward! As always, thank you for your time and support! :)

181
Ian Baenziger
S
sarvesh.lakhera
asked in Lucid for Developers
Lucid Plans & Billing | API Usage

Hi, I am working on a integration and want to know below queries.Under which plan will I have APIs access, so that I can perform integration? If I purchase the plan with API access, then are there any API usage limits? Which plan does have unlimited API usage plans?Let me know if anyone can help or refer me to documentation which all these details.Thanks

481
Richard U
J
johnktejik
asked in Lucid for Developers
Importing ‘ERDEntityBlock3’ shape produces an error saying not a valid shape type. What shapes are supported?

I am trying to find a list of all the valid shape types.  The documentation here is no help.I am trying to import a ‘ERDEntityBlock3’ but I get an error saying it is not a valid type.  So what are the valid ones?  I’m looking for something resembling a table that I can use to diagram DB relationships.

301
A
Lucid Software Inc. Supplemental Community Terms

Get Started

Products

Solutions

Resources

Company

Privacy Legal Cookie privacy choices Cookie policy
©   2024  Lucid Software Inc.