canvas::create
Create a new canvas from mermaid text or an excalidraw scene JSON. Returns the stored record, including the minted stable id and, for mermaid, the diagram family derived from the source.
- formatany of
Diagram format: `mermaid` or `freeform`. Defaults to `mermaid`.
any of (2)variant 1one of (2)variant 1valuestringenum: mermaidvariant 2valuestringenum: freeformvariant 2valuenull - namestring
Human-readable canvas name. Omit for a name derived from the detected diagram family (`Untitled flowchart`, `Untitled whiteboard`, …).
- sourcestringrequired
The editable source: mermaid text for `mermaid`, an excalidraw scene JSON string for `freeform`.
- created_atinteger· int64required
Creation time, unix seconds.
- familystring
Mermaid diagram family (`flowchart`, `sequenceDiagram`, …), derived from the source. `null` for a freeform canvas.
- formatall ofrequired
Diagram format: `mermaid` or `freeform`.
all of (1)variant 1one of (2)variant 1valuestringenum: mermaidvariant 2valuestringenum: freeform - idstringrequired
Stable 8-character slug identifying this canvas. Never changes across updates.
- namestringrequired
Human-readable canvas name.
- sourcestringrequired
The editable source of truth: mermaid text for `mermaid`, the excalidraw scene JSON for `freeform`.
- updated_atinteger· int64required
Last update time, unix seconds.