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.

  • 206 Topics
  • 739 Replies
206 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

3912
Humas1985
Lucid Legend Level 8
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

5687
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!   

1320
S
R
Ricardo Uribe
asked in Lucid for Developers
Error "An unknown error occurred" call API Lucid GET/documents/{docID}/contents

Hola comunidad, actualmente estoy llamando a la API /documents/{docId}/contents para obtener los Metadatos del documento y utilizarlos en un desarrollo de mi empresa. Muchos de los documentos dan 200, pero hay algunos que me dan un error 500 con el mensaje "An unknown error occurred", lo extraño es que si hago una copia de este documento, sin cambiar su contenido, con el nuevo id del documento, funciona normalmente. Entonces mis preguntas son: ¿Cuáles son las razones por las cuales puede ocurrir este error? y ¿Si puedo mitigarlo de alguna manera?  y ¿Por qué no se detalla este error en la documentación? 

61
R
mwyman
mwyman
asked in Lucid for Developers
Newbie question doing my first API call - 403 response

Hello all - I’m trying to get my development environment set up to build some desktop utilities to modify LucidChart documents. I’m attempting my first API call to the documents endpoint and getting a 403 response. Any help would be greatly appreciated - and sorry for the long post.Here’s what I’ve done so far:Created my document in LucidChart, so I am the owner of it. Grabbed the document ID from the URL (hopefully that’s the right one?) In the Lucid Developer Portal, I created an application, created the OAuth 2.0 client, generated my client ID and Client secret, and registered the Lucid Test redirect URI using my client ID.  I am using VS Code and Python, and have leveraged some of your sample code from the documentation to get the authentication and token refreshing working, storing the access token locally for use until expired. Seems to be working great so far! Since I’m building against just the console right now, I temporarily have the script launch a web browser for the OAuth

2107
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

70
Q
Q
quodsimDan
asked in Lucid for Developers
DocumentId of running Poll and HardRefresh Data Connector Action

Lucid,I have setup both the Poll and HardRefresh actions for my LucidChart extension package.  Is there a way to programmatically get the documentId within a Poll or HardRefresh?Here is the documentation for DataConnectorActionContext:https://lucid.readme.io/reference/dataconnectoractioncontext-sdkThanks,Dan

203
Q
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 

303
Q
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

100
S
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

1434
T
N
nivedhitha
asked in Lucid for Developers
Regarding LucidChart developer portal

Hi team,Can i get trial period for developer’s portal?I need to create api key of lucidchart and use it for my application.Will lucidchart api give flowcharts as output for my app?

131
Richard U
Q
quodsimDan
asked in Lucid for Developers
Question about DataConnectorAction return type for CSV data retrieval

I'm working on an LucidChart extension that needs to fetch CSV data from a web API endpoint and create a TableBlock with that data on a PageProxy. The approach I took was:1. Fetch CSV data using my Api Service2. Return this CSV data through a DataConnectorAction3. Use the returned data to populate a TableBlockHere's my data connector action code:```typescript// actions/getActivityUtilizationAction.tsimport { DataConnectorAsynchronousAction } from 'lucid-extension-sdk';import { createLucidApiService } from '@quodsi/shared';import { getConfig } from '../config';export const getActivityUtilizationAction: (action: DataConnectorAsynchronousAction) => Promise<{ status: number } & { text: string }> = async (    action,) => {    try {        const data = action.data as { documentId: string, userId: string };        const { documentId, userId } = data;        const authToken = action.context.userCredential;        const config = getConfig();        const baseUrl = config.apiBase

152
Richard U
C
Chris.Engstrom
asked in Lucid for Developers
ServiceNow Integration

After following the steps for integrating with ServiceNow: we get the following error: Error occured while creating Business Application Hierarchy in Lucidchart. Please try again.ServiceNow is describing the issue as a Token issue.Is anyone familiar with how to solve this?

28312
Ian Baenziger
D
DavidPinkerton
asked in Lucid for Developers
Download .shape files

I’m just learning how to use the developer portal for the primary purpose of creating my own shapes that connect to data sources.   I’m most interested in creating variations of the Org Chart, Salesforce Cards, and Sales Account Map cards.  Is there any way to download or get ahold of the Jason files for each of the above?   Being able to see the code of how these were constructed would be greatly beneficial.   If this isn’t possible, does someone have an idea from a Jason code standpoint as to how they accomplished them?   Ultimately what I really want is to display images on shapes from database urls.  This would give me a tremendous amount of flexibility.I’d also like to figure out how to apply formatting from database values.  This way I could have formula based columns in Google sheets that automatically gives me the formatting I want, instead of having to create endless conditional formatting rules.

513
Ian Baenziger
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.

564
Richard U
K
kevinTP
asked in Lucid for Developers
Image name as property with name in exported csv

My goal is to create custom shapes for a storyboard that will export to a csv file for further manipulation. I have not found out-of -the-box shapes that will export image data, so I’m trying to create a custom shape that will.I also need the images to be visible in shapes within lucidchart ,and easily input from files not urls.My attempts with the following code have failed to show images in a shape at instantiation and with data input.Is it possible to reach my goal? If so, what can be altered in this to make it work?{  "properties": [    {      "name": "ImageName",      "default": "clockwise-one-arrow.png",      "label": "Image name",      "type": "file"    }  ],  "images": {    "logo": {      "type": "file",      "path": "{{=@ImageName}}"    }  },  "style": {    "fill": {      "type": "image",      "ref": "logo"    }  },  "geometry": [    {      "type": "rect"    }  ]}

263
A
H
Hamxa
asked in Lucid for Developers
SDD

As many details as possible

101
Richard U
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)?  

645
K
G
Lucid Legend Level 1
GaryZLucid Legend Level 1
asked in Lucid for Developers
Not getting expected results from update datasource from csv API Endpoint

import requestsurl = "https://data.lucid.app/adapter/csv?dataSource=https://data.lucid.app/dataSources/123456"payload = {}files=[ ('file',('FILE.csv',open('FILE.csv','rb'),'text/csv'))]headers = { 'accept': 'application/json;v=1', 'Authorization': 'Bearer oauth2-xxxx'}response = requests.request("PUT", url, headers=headers, data=payload, files=files)print(response.text)I am using code like above to attempt to update an existing CSV datasource via APIhttps://lucid.readme.io/reference/updatedatasourcefromcsvThe request gets a successful 200 OK Response but the lastModified value never changes and the data does not update in the LucidChart that has that data linked in.I tried adding the optional collection parameter but saw no difference in response or results.

665
T
D
DavidPinkerton
asked in Lucid for Developers
Data Linked Image Shape

I’m trying to create an ellipse that can be filled with an image url from a data source.   I can’t seem to figure out how to do this for the life of me.  Any help would be appreciated.  Here’s what I’ve got so far:Data Source Image (attempt):{ "defs": [], "properties": [ { "name": "imageUrl", "type": "string", "default": "https://via.placeholder.com/100", "label": "Image URL" } ], "images": { "logo": { "type": "url", "source": "{{=@imageUrl}}" } }, "geometry": [ { "type": "ellipse" } ], "style": { "fill": { "type": "image", "ref": "logo", "mode": "stretch" }, }}Is {{=@imageUrl}} wrong? Switching the type and source out for a local image works just fine:{ "defs": [], "properties": [ { "name": "imageUrl", "type": "string", "default": "https://via.placeholder.com/100", "label": "Image URL" } ], "images": { "logo": { "type": "file", "source": "logo.png" } }, "g

763
D