Skills Design & Creative Lucidchart API for Diagram Generation

Lucidchart API for Diagram Generation

v20260423
lucidchart-hello-world
This skill provides a comprehensive guide on programmatically interacting with the Lucidchart API. It demonstrates how to create new documents, add structured shapes and connecting lines using standard import formats, and finally export the finished diagram (e.g., as PNG). It is ideal for automating the visualization of architecture diagrams, system workflows, or business processes within an application.
Get Skill
205 downloads
Overview

Lucidchart Hello World

Overview

Minimal working examples demonstrating core Lucidchart API functionality.

Instructions

Step 1: Create a Document

const doc = await client.documents.create({
  title: 'API Architecture Diagram',
  product: 'lucidchart'  // or 'lucidspark'
});
console.log(`Document: ${doc.documentId}`);
console.log(`Edit URL: ${doc.editUrl}`);

Step 2: Add Shapes via Standard Import

// Lucid Standard Import uses .lucid file format
const importData = {
  pages: [{
    id: 'page1',
    title: 'Main',
    shapes: [
      { id: 's1', type: 'rectangle', boundingBox: { x: 100, y: 100, w: 200, h: 80 },
        text: 'API Gateway', style: { fill: '#4A90D9' } },
      { id: 's2', type: 'rectangle', boundingBox: { x: 100, y: 300, w: 200, h: 80 },
        text: 'Database', style: { fill: '#7B68EE' } }
    ],
    lines: [
      { id: 'l1', endpoint1: { shapeId: 's1' }, endpoint2: { shapeId: 's2' },
        stroke: { color: '#333', width: 2 } }
    ]
  }]
};
await client.documents.import(doc.documentId, importData);

Step 3: Export Document

const png = await client.documents.export(doc.documentId, {
  format: 'png', pageIndex: 0, scale: 2
});
fs.writeFileSync('diagram.png', png);

Error Handling

Error Cause Solution
Auth error Invalid credentials Check LUCID_API_KEY
Not found Invalid endpoint Verify API URL
Rate limit Too many requests Implement backoff

Resources

Next Steps

See lucidchart-local-dev-loop.

Info
Name lucidchart-hello-world
Version v20260423
Size 1.98KB
Updated At 2026-04-26
Language