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
Body Params
string
required

Title that should be given to the newly created document.

string
enum
required

The Lucid Suite product types that can be created.

Allowed:
number

Folder ID for the new document.

extensionBootstrapData
object

Bootstrap data can be attached to the created document to be consumed by a specific Extension Package.

content
object

Defines the content of a document using the Lucid Standard Import format, including pages, shapes, and lines.
Mutually exclusive with extensionBootstrapData.

Responses

400

Bad Request. * 'content' and 'extensionBootstrapData' cannot both be provided — the content field is mutually exclusive with extensionBootstrapData. * Invalid content JSON — the provided content does not conform to the Lucid Standard Import schema.

403

Forbidden. if the user doesn't have access to or permissions to create within the specified parent folder. if the token authorizing the request has the document.app scope with a specified parent folder that is outside the app folder's folder tree.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json