Create Mermaid Diagram

Creates a Mermaid diagram in a document from Mermaid markup.

Valid Authentication Methods

API Key Grants:

  • DocumentEdit

OAuth 2.0 User Token Scopes:

  • lucidchart.document.content
  • lucidspark.document.content
  • lucid.document.content
Path Params
uuid
required

ID of the document in which to create the Mermaid diagram.

Body Params
string
required
length ≤ 100000

Mermaid markup used to create the diagram.

boolean
Defaults to false

When true, renders the diagram as SVG. When false or omitted, renders the diagram using native Lucid shapes.

string

ID of the page on which to place the diagram. When omitted, the diagram is placed on the first page.

position
object

Position at which to place the diagram. When omitted, the diagram is placed at the page origin (x: 0, y: 0).

Responses

400

Bad Request if the request body is invalid, the markup exceeds 100,000 characters, or the page ID is unknown.

403

Forbidden if the app making the request does not have write permission to the document, or if the document does not exist.

404

Not Found if a resource required to create the Mermaid diagram does not exist.

409

Conflict if the Mermaid diagram cannot be created because of a conflicting document change.

429

Too Many Requests if the request exceeds 60 requests per minute.

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