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.

  • 279 Topics
  • 999 Replies
279 Topics
Michel L
Michel L
asked in Lucid for Developers
Search account document problem

I’m trying to create a data connector for getting the documents associated to an account using this endpoint:https://api.lucid.co/accounts/me/documents/searchBut I get a 403 error, so the performDataAction is not fired. Please, what could be wrong?Extension registered action code: client.registerAction("getAccountDocumentlist", async () => { const triggerOauth = await client.oauthXhr("lucid", { url: "https://api.lucid.co/accounts/me/documents/search", headers: { "Lucid-Api-Version": "1", "Content-Type": "application/json", }, data: "{}", method: "POST", }); console.log("triggerOauth", triggerOauth); const result = await client.performDataAction({ dataConnectorName: "dataconnector", actionName: "GetAccountDocumentList", actionData: { message: "GetAccountDocuments" }, asynchronous: true, }); console.log(result); }); -manifest.json  content:... "oauthProviders": [ { "name": "lucid", "title": "Luci

301
A
Michel L
Michel L
asked in Lucid for Developers
Usage of Key for updating a datasource in a connector

I am surprised about how you need to set the patch items of an update for making the update runs without error.I write a dataconnector for retrieving document list and  Initially I used this code for the key to the patch without success:itemsPatch.set( apiDocument.documentId, convertToDocument(apiDocument as ApiDocument), )Full code:export const getDocumentListAction = async (action: DataConnectorAsynchronousAction) => { const apiDocuments = await searchDocuments(action.context.userCredential); const itemsPatch = new Map<string, SerializedFields>(); var i = 0; apiDocuments?.forEach((apiDocument) => { itemsPatch.set( apiDocument.documentId, convertToDocument(apiDocument as ApiDocument), ); }); if (apiDocuments) { action.client .update({ dataSourceName: "Lucid", collections: { "Lucid Documents": { patch: { items: itemsPatch, }, schema: documentSchema, }, },

312
Michel L
Richard Udell
Richard UdellLucid support team
posted in Lucid for Developers
FIXED: API Documentation Temporarily Down

✅ Edit: This issue has been fixed. ✅Hey Lucid Developers,Our API documentation at developer.lucid.co is currently unavailable due to a ReadMe outage. Since our documentation is hosted on ReadMe, we’re unable to resolve this directly but are monitoring the situation.You can track updates on ReadMe’s status page here: https://www.readmestatus.com/We're expecting the documentation to be back up by the end of the day. Thanks for your patience, and we’re here to help—drop any questions below!Apologies for the inconvenience.

211
Sylvia X
J
johnktejik
asked in Lucid for Developers
invalidImportType error

I’m trying to create a new document in lucidchart by importing a .lucid file.  I am using the demo.lucid file.  I have also tried creating my own .lucid file.  I cannot figure out what I am doing wrong.  Everything seems to match the instructions at https://lucid.readme.io/reference/createorcopyorimportdocument The error :    "code": "invalidImportType",    "message": "Importing the provided file type is not supported"Here is my Curl:curl --location 'https://api.lucid.co/documents' \--header 'authorization: Bearer oauth2-...8sKF' \--header 'lucid-api-version: 1' \--form 'product="lucidchart"' \--form 'title="helloform"' \--form '=@"/C:/Users/USER/Downloads/demo (1).lucid"'Here is a screenshot Any advice is appreciated

313
J
J
johnktejik
asked in Lucid for Developers
api creates document but no shapes

First time user here.  I’m just trying to get a basic api call to create a shape for me.  A ‘hello world’, so to speak.What I have done:1. Created document.json2. Zipped it into a file.3. Referenced file in Postman API requestDocument is created in lucidchart, but there is nothing in it.here is my document.json: {   "version":1,          "title": "Hello World",          "product": "lucidchart",          "pages": [            {              "id": "page1",              "title": "Main page",              "shapes": [                {                  "id":"shape1",                 "type":"rectangle",                 "text":"hello",                 "boundingBox":{                    "x": 50,                    "y": 30,                    "w": 100,                    "h": 150                  }                }                          ]              }          ]        }Here is my postman request:{  "title": "stupid helloworld",  "product": "lucidchart",  "file":"C:/Users/KTE2922/Downloads/

524
Michael B
Michel L
Michel L
asked in Lucid for Developers
Rest API inconsistency with documentation

According to the documentation, “https://api.lucid.co/documents/search” endpoint gives the result:  "documentId": "110808fd-4553-4316-bccf-4f25ff59a532",  "title": "document title",  "editUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/edit",  "viewUrl": "https://lucid.app/lucidchart/110808fd-4553-4316-bccf-4f25ff59a532/view",  "version": 101,  "pageCount": 5,  "canEdit": false,  "created": "2019-04-22T13:47:23Z",  "creatorId": 12345,  "lastModified": "2020-06-26T16:29:37Z",  "lastModifiedUserId": 54321,  "customAttributes": [],  "customTags": [    "in progress"  ],  "product": "lucidchart",  "status": "Complete",  "classification": "Private",  "trashed": null,  "parent": null,  "owner": {    "id": 123456,    "type": "user",    "name": "John Doe"  }especially tells that there is a response field “owner” which is good.But unfortunately in the real world the result is :documentId: 'efde95db-0d4e-4173-a6a4-c49fac4cc046',    title: 'Sample Diagram 19',    editUrl:

252
Michel L
Michel L
Michel L
asked in Lucid for Developers
Creating a dataconnector - how to define an array

Creating a dataconnector for retrieving document list, the only way I found is to define an array is to use a declaration field as any:... { name: "customAttributes", type: ScalarFieldTypeEnum.ANY, }, { name: "customTags", type: ScalarFieldTypeEnum.ANY, },which  IMHO is not good I would like to use things like  { name: "customAttributes", type: []ScalarFieldTypeEnum.STRING, }, { name: "customTags", type: []ScalarFieldTypeEnum.STRING, },Any suggestions?Best regards. 

242
Michel L
Michel L
Michel L
asked in Lucid for Developers
Retrieve Size of Document using Rest API

Hello Guys,Is there a way to retrieve the size of a document using Rest API.The size is currently available manually from the “Details” panel windows displayed using “Show Detail” context menu command on a document.Best regards.

535
A
J
johnktejik
asked in Lucid for Developers
My first API call - all keys are 'view only' - 403 response

I have followed the instructions herehttps://lucid.readme.io/reference/obtaining-an-access-tokenand herehttps://lucid.readme.io/docs/api-keys but it is not working.  I keep geting a 403 unauthorized error.  There is also something on the apikey page saying ‘view only’.  This ‘view only’ is not mentioned in any instructions.  I have tried searching for this ‘view only’ issue but have not found any matches.  Ps. I can read using the API, but cannot write/create.Anyone have any ideas?  

618
J
D
Dominik Badger
asked in Lucid for Developers
Minimize Logins and keep Lucidchart sessions alive longer

Any chance to keep Lucidchart sessions alive longer?Whenever I open a new window I need to log on again. Would be great to skip that process and save time.

203
Shira M
Lucid Legend Level 4
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? 

362
A
D
dude95
asked in Lucid for Developers
Struggling with import API - Document Created but no shapes

Really struggling with the import API.  I’m getting the oAuth2 tokens successfully, able to create documents just fine, but they don’t have anything in them even though i’m sending off json for creation.  Trying to mimic the jira to Lucid as closely as possible, but it’s not working out.  Logs indicate success, but that’s because the documents are getting created.My log:Create Document Response: {  documentId: '369afc52-f1f2-41ee-be08-fd63581fe00f',  title: 'Updated Test Document with Shapes',  editUrl: 'https://lucid.app/lucidchart/xxxxx/edit',  viewUrl: 'https://lucid.app/lucidchart/xxxxx/view',  version: 110,  pageCount: 1,  canEdit: true,  creatorId: 136597754,  lastModified: '2024-09-23T14:50:45Z',  lastModifiedUserId: 136597754,  trashed: null,  status: 'Draft',  classification: null,  customAttributes: [],  customTags: [],  parent: 383364222,  product: 'lucidchart',  created: '2024-09-23T14:50:45Z'}  // Define the shapes using the structure from the example const documentD

1015
D
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

344
Connor B
K
kjb
asked in Lucid for Developers
Failed to load example shapes

I am exploring the example shapes in the sample library https://github.com/lucidsoftware/sample-lucid-extensions/tree/main/example-shape-library. I have the developer tools in lucid enabled and ran the test-shape-libraries command to run the local server. However I am seeing a lot of network errors in the console causing the example not to load. I don’t have any browser plugins enabled or add blockers. Not sure what is causing this. I’ve used Safari, Chrome and Brave and get the same result.

231
Ria S
Lucid Legend Level 8
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

2457
J
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

2274
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?

231
Richard Udell
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

212
Richard Udell
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.

1313
Ian Baenziger
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"    }  ]}

333
A
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)?  

835
K
G
Lucid Legend Level 2
GaryZLucid Legend Level 2
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.

825
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

913
D
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? 

1345
Michael B
G
Lucid Legend Level 2
GaryZLucid Legend Level 2
asked in Lucid for Developers
Lucid Service Test Redirect URI for OAuth2 not working

I have completed the steps in:OAuth 2.0 client creationandClient Creationbut when I attempt to use:https://lucid.app/oauth2/clients/{my_client_id}/redirectafter registering it with my own client id, I get “page not found” Previous dev forum post here: References this docs page which is no longer working.https://developer.lucid.co/api/v1/#app-registrationIs there additional app configuration required before I can use the Lucid provided service OAuth2 redirect URI in order to begin developing my app?Please do not refer me to the API Key method as a solution, my goal is simply to use this endpoint:Update Data Source from CSV

332
Emma D
Lucid Software Inc. Supplemental Community Terms

Get Started

Products

Solutions

Resources

Company

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