Sign in

v1

latestOpenAPI 3.0.3Lucid2026-07-14155181312.3 KB
Document Access

Create Document

Creates a new document for the requesting user, with the specified title. Requires title and product. Optionally, a parent folder, extensionBootstrapData, or Lucid Standard Import content can be provided to customize the new document.

📘

This endpoint can only create a new Lucidchart or Lucidspark document. It cannot modify an existing document's contents.

📘 ##### Document Creation Location

When there is no parent field on the request, the new document will be created in a default location depending on the authorizing token's scopes.

  • If the token authorizing the request uses one of the document.app scopes, then the document will be created in an app-specific folder.
  • If one of the document.content scopes is used, the document will be created in the user's 'My Documents folder'.
  • If both types of scopes are authorized on the token, the document.content behavior will take priority and the document will be created in the user's 'My Documents' folder.

📘 ##### Bootstrap Data for Create Document

Bootstrap data can be attached to the created document to be consumed by a specific Extension Package. See Bootstrap Data for documents created via API for usage.

📘 Standard Import

When content is provided, it must conform to the Lucid Standard Import schema. For more information on how to use the Standard Import, refer to the extensive reference documentation here.

For examples of how to use the Standard Import, refer to the /standard-import folder in Lucid's repository of Sample Lucid REST Applications. This repo also contains some example .zip Standard Import files you can reference or use in your own projects.

Valid Authentication Methods

API Key Grants:

  • DocumentEdit

OAuth 2.0 User Token Scopes:

  • lucidchart.document.content
  • lucidchart.document.app.folder
  • lucidspark.document.content
  • lucidspark.document.app.folder
post/v1/documents

Request body

titlestring required

Title that should be given to the newly created document.

product'lucidchart' | 'lucidspark' required

The Lucid Suite product types that can be created.

parentnumber

Folder ID for the new document.

Example request

{
  "product": "lucidchart",
  "extensionBootstrapData": {
    "packageId": "74672098-cf36-492c-b8e6-2c4233549cd3",
    "extensionName": "sheets-adapter",
    "minimumVersion": "1.4.0",
    "data": {
      "a": 1,
      "b": 2
    }
  },
  "content": {
    "version": 1,
    "pages": [
      {
        "id": "page1",
        "title": "Page 1",
        "shapes": [
          {
            "id": "shape1",
            "type": "rectangle",
            "boundingBox": {
              "w": 100,
              "h": 50
            },
            "text": "Hello World",
            "style": {
              "fill": {
                "color": "#ffffff"
              },
              "stroke": {
                "color": "#000000",
                "width": 2,
                "style": "solid"
              },
              "textColor": "#000000"
            },
            "actions": [
              {
                "url": "https://example.com"
              }
            ]
          }
        ],
        "lines": [
          {
            "id": "line1",
            "lineType": "elbow",
            "stroke": {
              "color": "#000000",
              "width": 2,
              "style": "solid"
            },
            "endpoint1": {
              "style": "arrow",
              "shapeId": "shape1"
            },
            "endpoint2": {
              "style": "arrow",
              "shapeId": "shape1"
            }
          }
        ],
        "groups": [
          {
            "id": "group1"
          }
        ],
        "layers": [
          {
            "id": "layer1",
            "title": "Background"
          }
        ],
        "settings": {
          "fillColor": "#ffffff",
          "size": {
            "type": "letter"
          }
        }
      }
    ],
    "documentSettings": {
      "units": "in"
    }
  }
}

Response

Created with Document resource containing information about the newly created document.

documentIdstring uuid required

Unique ID of the document

titlestring required

Title of the document

editUrlstring uri required

Link to edit the document

viewUrlstring uri required

Link to view the document

versioninteger required

Most recent version

pageCountinteger required

Number of pages within the document

canEditboolean required

If requesting user can edit the document

createdstring date-time required

Date and time of when the document was created

creatorIdinteger required

ID of user who created and owns the document

lastModifiedstring date-time required

Date and time of when the document was last modified

lastModifiedUserIdinteger required

ID of user who most recently modified the document

customTagsstring[] required

List of any custom tags assigned to the document

product'lucidchart' | 'lucidscale' | 'lucidspark' required

The Lucid Suite product that a document was created in.

statusstring nullable

Current assigned status of the document

classificationstring nullable

Current assigned classification of the document

classificationIdstring uuid nullable

Current assigned classification ID of the document.

trashedstring date-time nullable

If defined, the timestamp when the document was moved to the trash

parentinteger nullable

ID of the parent folder

accountIdinteger nullable required

ID of Lucid account that owns the document

Example response

{
  "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,
  "repository": null,
  "owner": {
    "id": 123456,
    "type": "user",
    "name": "John Doe"
  },
  "accountId": 1234
}