Skip to main content
Michel L
Aug 20, 2024 2:27 PM UTC
Solved

Lucidspark Rest API

Did API exist on LucidSpark for developers ?

jkrueger
jkruegerAnswer
Lucid product team
Sep 24, 2024 6:26 PM UTC

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:

  1. ‘Export to Lucidchart’ in the document list menu

     

  2. 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!

Comments

Humas1985
Lucid Legend Level 10
Lucid Legend Level 10
Aug 20, 2024 2:32 PM UTC

Hi @Michel L 

Yes - LucidSpark provides APIs for developers, enabling them to integrate and interact with the platform.

Specifically, LucidSpark offers two APIs: the REST API and the Extension API, which can be utilized in a similar manner to Lucidchart, allowing for seamless integration and customization.

To learn more please navigate to this help article - Guides (lucid.co)

Hope this helps - Happy to help further!!
Thank you very much and have a great one!
Warm regards

Translate
Huma || Lucid Legend
Michel L
Michel LAuthor
Aug 20, 2024 3:27 PM UTC

Hi @Humas1985 

Thank you for your reply,

So we just need to use lucidspark instead of lucidchart in the product field of the request isn’it?

Regards.

Translate
Humas1985
Lucid Legend Level 10
Lucid Legend Level 10
Aug 20, 2024 4:05 PM UTC

Hi @Michel L  - Yes, that's right.

Translate
Huma || Lucid Legend
Michel L
Michel LAuthor
Sep 24, 2024 5:55 PM UTC

Hi @Humas1985 

In fact i’m sorry to tell you that you’re wrong.

If you want to get the json content of a lucidspark file using this endpoint:

https://api.lucid.co/documents/{id}/contents

There is an error. 

It seems that the scope for this endpoint does not support lucidspark.

Any suggestions.

Regards.

Translate
jkrueger
jkruegerAnswer
Lucid product team
Sep 24, 2024 6:26 PM UTC

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:

  1. ‘Export to Lucidchart’ in the document list menu

     

  2. 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!

Translate
Oct 28, 2025 3:27 AM UTC

Any update on this?  I need to be able to programmatically modify embedded Lucidspark boards. But extensions won’t let me interact with them unless I’ve initiated an action in the extension on the lucid website (not my embedding application). So...I tried switching to APIs instead of extensions, and late in the game just now realized the topic of this thread: no LucidSpark support.  Is there a beta or similar program ?  Please advise how I can get programmatic CRUD on an embedded lucidspark board.

Translate
Michel L
Michel LAuthor
Oct 28, 2025 8:02 AM UTC

Hi ​@lorienpratt the endpoint 

https://api.lucid.co/documents/{0}/contents

Works now for LucidSpark.


...
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"title": "MyLucidSpark file",
"product": "lucidspark",
"pages": [
{
"id": "0_0",
"title": "Page 1",
...

Regards.

Translate
Oct 28, 2025 7:22 PM UTC

​@Michel L great!  Is it documented anywhere?

Translate
Oct 29, 2025 1:48 AM UTC

Also, as far as I can tell, this doesn’t support any lucidspark CRUD, e.g. add a card, right?

Translate
Michel L
Michel LAuthor
Oct 29, 2025 2:03 PM UTC

​@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.


 

Translate