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.

  • 193 Topics
  • 697 Replies
193 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

1102
Humas1985
Lucid Legend Level 6
1 month 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

2287
Richard U
1 month 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!   

1160
S
6 months 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

8621
Michael B
2 days ago
D
dcazman
asked in Lucid for Developers
Manage users with API key

I keep getting access forbidden error using 'https://api.lucid.co/users'However I can get a single user assuming I know the ID.Also, my key says view only. Assuming I get it to list all users how do I allow the key to delete users ?

163
Michael B
3 days ago
Y
your_friendly_backend_dev
asked in Lucid for Developers
How to Use Shape Library with Import API

Hello! I want to use JSON to generate blocks that are provided through third party shape libraries. I am currently using standard JSON import and the REST API to generate the documents, but I am unsure of how to specifically use shapes from other shape libraries. To be specific, I am trying to use the Azure cloud shape libraries.

62
Y
5 days ago
M
miagutie
asked in Lucid for Developers
YAML, Swagger, or OAS for the Lucidchart API

Hi everyone! Greetings to the community. I've recently started using the Lucidchart API to perform various operations like OAuth authentication, document retrieval, and even running some tests to upload templates via the API.During this process, I've been wondering if there's a place where I can find the OAS (OpenAPI Specification) for Lucidchart's API. While the portal does list all the operations, I’d like to have them consolidated into a single contract. This would help me automate the creation and validation of certain fields, making the process much easier.If anyone knows where I can find the OAS, YAML, Swagger, or however it's referred to haha, please share! I couldn't easily locate it on the support page.Thanks in advance for your help!

192
M
5 days ago
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.

231
Richard U
8 days ago
Z
zoran
asked in Lucid for Developers
SCIM API Response Format

Hi Community,We are testing the Lucidchart SCIM API for "Get All Users," but we are not receiving the urn:ietf:params:scim:schemas:extension:lucid:1.0:User field as mentioned in the API reference documentation: Get User API. The API response format we are seeing differs from what is documented.Additionally, we would like to understand more about the schema referenced in the documentation. Could you provide clarification on what the schema represents and its significance in the response?

251
Richard U
8 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 

9810
Richard U
8 days ago
M
muditpathak
asked in Lucid for Developers
Lucidchart API reference for audit logs

HelloDo we have any APIs related to Audit logs in Lucidchart?Or any other other API which gives user activity related information, like create chart, update chart, any API which gives any event activity done by a user?

1835
Richard U
9 days ago
nagarajr
nagarajr
asked in Lucid for Developers
Creating document with API in Lucidchart

is there a good example of creating shapes and lines using API ? I am trying to create a diagram via code I am able to create a blank document and view the content of already created diagram via  https://api.lucid.co/documents/:id/contents   

9947
A
9 days ago
S
sanath kumar
asked in Lucid for Developers
Embed Viewer and highlight few shapes

Hi team,I am building a application where it takes lucidchart ID as input and in the backend I will fetch the lucidchart in JSON format using document contents endpoint and does some validations like every shape should have some text, whole lucidchart should be connected. If any of the validations are not met, I want to show those on the UI. I am thinking it would be great if we can embed lucidchart and highlight the nodes where the validations are not met. Is there anyway I can do this ?If not, do you suggest any other best alternative ?

393
Michael B
11 days ago
M
mgmiller
asked in Lucid for Developers
Array capacity

I am adding functions to custom data definitions to list the contents of a swimlane.  If there are more than 20 objects in the lane, the array that is returned shows ellipses at the end for each item over 20.  Even if I do something simple like=ARRAY(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23)the result is [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, ...]How can I get the 21,22, 23 etc. to show up?  Is this limit hard coded?

353
Richard U
16 days ago
renekreijveld
renekreijveld
asked in Lucid for Developers
Export a page to PDF through the API

Through the API it is possible to export a page to a png or jpeg image.Is it also possible to export a page to PDF through the API? Or can I generate a PDF of a document or page by opening a specific URL? 

673
Michael B
16 days ago
M
msommer
asked in Lucid for Developers
Using Oauth2 app without publishing

I have created an oauth2 app for the purposes of obtaining clientId and clientSecret to be used when calling Lucid API’s. I am the only collaborator currently and the app is not published. I am trying to understand this documentation on oauth2 limitations. Specifically:  If the app is not published, only specified app collaborators can use the app with your client ID and secret. If you would like to develop an app that all Lucid users can use, refer to this publishing documentation. Does I need to publish an app on the marketplace for others besides me to use the clientId and secret, or that I need to add app collaborators? I am trying to build an application that resolves Lucid urls to embeds where users input a url, and are prompted to login if need by, and then API calls are made to lucid to to resolve the inputted url to an embed view, and I am wondering what the implications of the above limitations are. Is there any, or am I miss-interpreting the limitations?

231
Emma D
16 days ago
G
GKenneally
asked in Lucid for Developers
Request SVG version of document page via API

Hi,I can export png/jpg images using the ‘accept’ header and calling the documents API.  Is there a way to get an SVG version of a page?  The documentation does not mention it as being supported. Also, is there an easy way to access a documents metadata without getting all of the documents contents.  I’d like to get the document meta, and the meta for each of the pages it contains, primarily page title.  I can get this by calling /documents/{id}/contents but the response includes everything in the document and is much more than I really need. Thanks,Gary

171
Michael B
18 days ago
E
Elsie Harrison
asked in Lucid for Developers
Integrate with more than one DevOps instance

We are trying to integrate with another DevOps instance. Can you have more than one DevOps integration? Ideally we would want different Lucid Teams to have a separate DevOps instance.

222
Ian Baenziger
19 days ago
Sylvia X
Sylvia XLucid support team
posted in Lucid for Developers
📢 Exciting Update: New API Documentation is Live! 📚

Discover the Enhanced Lucid API DocumentationOur latest updates make it easier to get started and contribute to the community with suggested edits. Check out these new streamlined features and tools below! 🌟 What’s New?Dark Mode 🌓Switch between light and dark mode to suit your preference, using the sun/moon icon in the top right.   Build Your Request from within the Docs 🔨Pick your language and build your request without leaving the page.    Suggest Edits ✏️Improve the documentation by suggesting edits. Most pages now feature a "Suggest Edits” button in the top-right corner, to provide feedback.   Expanded Guides  📖Guides now offers a clear introduction, helping you navigate and implement API functionality. Making it easier to learn more about essential topics like API keys, External Embeds, and areas where you can import/sync data in Lucid.   Improved searchability and navigation 🔍Topics and endpoints are organized into pages, making it easier to quickly find the information you

300
Sylvia X
25 days ago
J
JoshJefferis
asked in Lucid for Developers
Find index position of a string in an array

Hi,I’m easily able to return the value of a string in an array by it’s index position with the FIND function.e.g. if array = [“hello”,”World”]FIND(array,1) = “hello” However, i’m struggling to understand how to do the inverse - finding the index position of a string in an array by the value of the string:e.g. if array = [“hello”,”World”]‘STRINGFIND’(array,”hello”) = 1I’m sure this is quite simple and I’m just missing the correct function.Thanks!

141
Ian Baenziger
29 days 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?

393
Richard U
1 month 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

293
Emma D
1 month 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

273
A
1 month 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
1 month 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

413
Richard U
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.