Solved

Lucidspark Rest API

Forum|Forum|2 years ago
August 20, 2024
16 replies
635 views

Did API exist on LucidSpark for developers ?

Best answer by jkrueger

Hi @Michel L ,

You are correct. At this time, the GET Document Contents endpoint does not support Lucidspark boards.

You can get around this by exporting a Lucidspark board to Lucidchart.

There are two ways to export from Lucidspark to Lucidchart:

‘Export to Lucidchart’ in the document list menu
Use the POST Copy Document endpoint with “product” : “lucidchart” and “template” : “<your Lucidspark document id>”.

After a board is exported to Lucidchart, you could use GET Document Contents with the new Lucidchart document.

Hope this helps!

Show previous replies

Michael B

Lucid product team

To confirm Michel’s response, there is not currently a way to modify the contents of a document via the Rest API. The extension API can be used for document modification, but that still expects a user interaction on the canvas.

We recognize the demand for programmatic modification of a document, but do not support that at this time.

L

lorienpratt

Thanks @Michael B and @Michel L very much appreciated. If we return to my primary query, it was about whether there’s some way to not have to open the board in the same session as my app in order to get the extension started up. Right now, to run any app, I have to do this, which is cumbersome. I want my users to be able to just stay in my website, not to have to click a menu item (to start the extension operating) on a board on lucidspark.com as they currently have to do.

L

lorienpratt

@lorienpratt
https://developer.lucid.co/reference/getdocumentcontent

but you cannot modify the content of the document if it is what you want.

Yo can IFAIK do that only with developing an extension.

So you could :

Create an extension

Open the document using Rest API

Fire the extension.

Regards.

yes, but my understanding is that i can’t fire an extension programmatically, can I? Even if I’ve opened the doc via REST?

Michel LAuthor

@lorienpratt 😊

Michael B

Lucid product team

Unfortunately, extensions can not run while the app is in a iframe and there are not currently plans to try and find a solution.

Zuzia S

Lucid community team

Hi, just jumping in here to let you @Michel L know that I have removed your email from this thread to protect your privacy. If you'd like, you can send a private message to @lorienpratt directly on this platform.

Cheers!

Create an account in the community

Log in to the community