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.

  • 181 Topics
  • 663 Replies
181 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

832
Humas1985
Lucid Legend Level 4
25 days ago
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

1807
Richard U
27 days ago
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!   

1100
S
5 months ago
P
pdNeuro
asked in Lucid for Developers
API token for a Lucidchart Pro account

Dear all,I want to create a program in C# that will take a json file as input and it will convert it into  flow diagram in lucidchart. From what I have read, I will need to obtain an API token for my lucid-chart Pro account. But there is no option for API in my account.  Under my plan it says the following “ Currently on a legacy plan. Modifying your plan will forfeit your legacy pricing“I am completely new to using an API token  , so the first question is how do I get an API token?

223
Richard U
2 days ago
G
Gaston Acuse
asked in Lucid for Developers
How to extract the graphic relationship between shapes with API?

Hi Lucidchart developer community,I would like to know how I can extract with API the relationship between these two shapes, ie: The API call:       curl -k --request GET \            --url https://api.lucid.co/documents/34f5d3b8-560f-4657-a170-214418d1126c/contents \            --header 'Lucid-Api-Version: 1' \            --header 'accept: application/json' \            --header 'authorization: Bearer key-<the_token>' \ The result (does not reflect inclusion relationship):{  "id": "34f5d3b8-560f-4657-a170-214418d1126c",  "title": "simple",  "product": "lucidchart",  "pages": [    {      "id": "0_0",      "title": "Page 1",      "index": 0,      "items": {        "shapes": [          {            "id": "2gtp6vMI4Wka",            "class": "ProcessBlock",            "textAreas": [              {                "label": "Text",                "text": "B"              }            ],            "customData": [],            "linkedData": []          },          {            "id": "Ogt

233
Emma D
10 days ago
Q
quodsimDan
asked in Lucid for Developers
Custom Shape: on drop handler

Hello,I have a created a shape library where each shape in my library has a custom property “q_data” where the value of “q_data” is some json.  What I want to do is dynamically set the value of “q_data” upon drop of the shape on the page.  Is this possible?Thanks,Dan

243
A
12 days ago
Q
quodsimDan
asked in Lucid for Developers
LucidChart responding to completion of long running task

I have created a Lucidchart package that contains custom UI, shapes and data connectors.  I have added a button to the right panel that successfully triggers a long running task in Azure. In my current implementation, the button is pressed and the task is of course triggered async Once the long running task is complete, is there a way for my web server to notify Lucid that the long running task is complete?  What are some approaches you might recommend?Should my extension poll a database table for the state of the task?Alternatively, is there a way for me to register a endpoint that my web server could call and then the extension or data connector could receive that notification that the registered endpoint has been called and then run some code?Thanks, Dan

325
ablackburn
12 days ago
Q
quodsimDan
asked in Lucid for Developers
Download PDF file of Developer Documents

I would like to get a pdf or similar file of the development docs.  Does this exist?  Thanks, Dan

323
Richard U
12 days ago
Richard U
Richard ULucid support team
posted in Lucid for Developers
FIXED: Temporary Issue with Developer Documentation

✅ Edit: This issue has been fixed. ✅ Just a heads up that our API documentation at developer.lucid.co/reference is currently down. You might encounter some broken links or errors when accessing it.What to Do:Use the old docs URL for now: lucid.readme.io/reference/overview Tip: Any dead links should work by replacing developer.lucid.co with lucid.readme.io  We're aiming to have the new documentation back up by the end of today. Thanks for your patience!If you have any questions or need assistance, feel free to comment below and we can assist!Sorry for the inconvenience!

381
Sylvia X
14 days ago
D
diozsa
asked in Lucid for Developers
Mapping data center network to a diagram

Hi there, I have a question  -  as a last resort.I am trying to build a proof of concept for mapping our data center with Lucid diagrams. Our corporation already uses these diagrams, they are done manually and they are always behind. We’d like to have them updated dynamically.I played with Lucidchart API in Postman, just to see how versatile and quick such endeavor would be. I was able to create and get a document but not more than that.I spent multiple hours in the docs today but I was not able to put a single square on an empty diagram, via a post/patch request. I could not find any examples that were helpful to my case.Is there a direct way to handle these requests without working with an SDK / front-end? Would like to stick to Python. The final goal is to have data flowing in a CI/CD pipeline and update our diagrams automatically. First… i need to put a least a box in a document. Please let me know if my approach is futile.Thanks 

818
Richard U
14 days ago
M
msommer
asked in Lucid for Developers
Embed Viewer API Doc returning NOT FOUND

I am following this doc for creating a token based external embed. I have:Successfully created the access token Successfully created an embed session token Failed at calling the Embed Viewer endpoint with the embed session token get a 200 response.I do not want to use the document picker component, so instead I have created a lucidchart document, generated an embedId for the document (confirmed docId is correct) by calling Create Document Embed, then use the embedId in step 2 above when creating the embed session token.  However, I keep getting 404 Not Found when calling Embed Viewer with the embed session token.  My access token has the following scopes: lucidchart.document.content.share.embed%20offline_access%20user.profile%20lucidchart.document.app.picker.share.embed Do I need to modify my document in someway so that it is embeddable? (e.g. activate the embed code via the UI or publish the doc)? Steps to reproduce Create lucidchart and do NOT publsh, activate embed, or anything else

5514
C
14 days ago
K
KGV
asked in Lucid for Developers
About line.getDownstreamConnection() endpoints

Hello,This function line.getDownstreamConnection() doesn’t follow line arrow state when a line arrow direction get changed by “swap line ending” or change line arrow style. As far as I understand it (according to this article and screenshot attached below as well), the first and second endpoints are in context of the arrow direction is that true? otherwise, how to get the arrow direction of a line(that applies to multi-directional lines as well)?  

151
Michael B
16 days ago
Michel L
Michel L
asked in Lucid for Developers
Folder ID inconsistency

When you need Folder ID for setting the Parent ID to set the location of the file when creating or copy a document with https://developer.lucid.co/reference/createorcopyorimportdocument.https://api.lucid.co/documentsThe parent must be an integer as said in the doc.But if you want to use:   “My documents”,   “Team folders”,   “Shared with me”the folder ID are respectively (extracted from the url):   folder_id=home   folder_id=project  folder_id=sharedThis appears to be very strange to me and moreover we cannot use these values as parameters when using this API.Any help will be appreciated.Best regards.

121
Michael B
21 days ago
H
Hysen
asked in Lucid for Developers
How to edit cards template for Lucid cards

Hello Community,  I am trying to use Lucid Cards for one of my use cases. However, the predefined status in the template doesn’t suit my needs. is there a way, I can create my own statuses for the card?

50914
P
22 days ago
J
janejane
asked in Lucid for Developers
Data Linked from Google Sheet: Is there an API to automate the synchronization

I have Google Sheet Data Linked with my Lucid Chart.  I ensured the Data Manage type is set to “automatic” for every 30 sec.  However, the automatic refresh does not work, I have to click the refresh button manually for the synch.  Is there an API from Lucid Chart to automate the synchronization?

485
Richard U
22 days ago
Q
quimHM
asked in Lucid for Developers
Conditional Formatting Based on Tags

I’m interested on learning how to programattically access Lucidspark cards’ tags in order to use them and their content within our Conditional Formatting formulas.

212
Richard U
28 days ago
S
Scott PLucidite
posted in Lucid for Developers
New JSON Standard Import API

Hi Lucid Developers!🌟 We just launched our JSON Import functionality within the Standard Import API, and it's set to revolutionize the way you create and visualize data in diagrams.🔍 Why is JSON Import a Big Deal?Simplicity and Power: Compared to other import methods, JSON import is less complicated yet more powerful, making it possible to auto-create detailed diagrams. Fully Automated Workflow: You can now automate your entire diagram creation process more quickly. No need to open Lucid - just set up your JSON, send a request to our Import Document endpoint, and let Lucidchart handle the rest. Ideal for Various Use Cases: Whether you're visualizing complex networks or leveraging AI for diagram creation, JSON import has opened up many new possibilities.👥 Who Should Be Excited?Network Professionals: Visualize intricate networks and data centers with ease. AI Enthusiasts: Bring AI-generated diagrams to life quickly. Automation Gurus: JSON import is the perfect option for automating wo

135920
Michael B
30 days ago
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

2814
Richard U
1 month ago
R
Rickajr
asked in Lucid for Developers
Bug Using Story Points Quick Shape Banks With Jira or Lucid Cards

Currently when using either a blank spark board or using the new task estimation template, the story point quick shape bank allows the user to drop the point value onto a jira or a lucid card; however, the card is only holding/displaying the points for each user and not the group.In other words, if Rick adds 2 to a card and David adds 3 to a card - it only shows 1 vote instead of 2 and Rick only sees the vote he added for 2 and David only sees the vote he added for 3.There should be a total of 2 votes being displayed in the results summary modal that pops up when selecting the estimation drop zone. UPDATE - this is the same experience with the T-shirt sizes quick shape bank

553
T
1 month ago
psanchez_everhealth
psanchez_everhealth
asked in Lucid for Developers
Mermaid bug with class diagram namespaces and relationships

Hey all,It seems the version of mermaid that is getting used has an old bug in the mermaid renderer that causes attributes in classes to not get rendered if they’re in a namespace and there’s associations. The mermaid GitHub issue and PR here has details on simple ways to reproduce it. I’m guessing this may be due to using an older version of mermaid than when this was fixed? Seems it was fixed as of mermaid version 10.2.4.https://github.com/mermaid-js/mermaid/issues/4519 → namespaced classes lose members if relation statement comes after namespace includes reproducible examples https://github.com/mermaid-js/mermaid/pull/4532 → fix(class): keep members in namespace classes https://github.com/mermaid-js/mermaid/releases/tag/v10.2.4 → release notes with bug fix

511
T
1 month ago
R
Richard Watson
asked in Lucid for Developers
Customize or create new Smart Containers?

Is it possible to create new smart containers or customize the current ones?  I was hoping to create a set of smart containers with custom data values and controls. 

384
T
1 month ago
B
byt_Clint B
asked in Lucid for Developers
How do I define linear-gradient parameters in a .shape or .manifest file?

I have functioning geometry and a shape .manifest file with the following defaults:        "defaults": {            "fillColor": "#ccffee",            "strokeColor": "#000000",            "strokeWidth": 3,            "rounding": 10,            "width": 120,            "height": 120        }No style formatting is applied in the .shape file (yet).  The shape behaves the way I expect with fill & line properties functioning.  I can set the gradient type and properties using the GUI and it works as intended.  I cannot find in the documentation anywhere how to define and set the ‘linear-gradient’ properties so that they are the defaults for the shape.  How is this done?

453
C
1 month ago
B
byt_Clint B
asked in Lucid for Developers
Can variables or properties be defined and referenced in .manifest file?

The below shape entry in my .manifest works as intended with a default width/height of 120px:    {        "shape": "switch_layer2",        "name": "Switch (Layer 2)",        "defaults": {            "fillColor": "#ccffee",            "strokeColor": "#000000",            "strokeWidth": 3,            "rounding": 10,            "width": 120,            "height": 120        }    } I have several shapes with the same basic definition and would like to define variables/constants in the manifest file that are referenced by all shape entries. Alternatively, is it possible to define defaults in the manifest that apply to all shape entries?  That would work just as well.

171
C
1 month ago
william.starling
william.starling
posted in Lucid for Developers
Script to add a new cross-account role

I have an organization setup in AWS with many accounts and we will spin up and down accounts based on certain criteria so we have the requirement to get our AWS models on accounts and I currently have to manually go create/add the new cross-account role in Lucid.  The role is created in our AWS accounts automatically using a CloudFormation StackSet so the role is there I just need an automated way to create the cross-account role in Lucid instead of using the GUI.  We don't have to use the CLI method for this as we want the role to be what we use.  Is there a script/api call or some other method we can use with Lucid to automate this?

286
jkrueger
1 month ago
Michel L
Michel L
asked in Lucid for Developers
How to get the folders under "Home" using Rest API

Using REST API https://api.lucid.co/folders/searchWe can get a list of folders. But only the folder of the user are returned (folder and shared folder). We cannot have Teams Folders. More over, we cannot make the distinction between “Shared with me” folders and the folders of the user.Am I wrong ?I have try to add "Lucid-Request-As" admin" in the header as indicated in the doc but then I got a 403 Error?My scope is nevertheless “folder:readonly folder:admin.readonly”Any help ?It could be great to get the home root folders “Documents” “Shared with me” and to have the sub folders” “Team folders” and “My documents” of “Documents” folder.Best regards.

1136
jkrueger
1 month ago
Lucid Software Inc. Supplemental Community Terms

Get Started

Products

Solutions

Resources

Company

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