Skip to content
Registry

canvas

v0.1.13

Create, edit and render diagrams in the console — stored as editable source, drawn live in chat and on a canvas page.

license: Apache-2.0diagramdrawingflowchartmermaidsvgwhiteboard

Install

bash
iii trigger compose::add worker=canvas@0.1.13

Run in your project with the iii engine running. Exact versions are immutable and digest-pinned.

Functions1

canvas::create

Function

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.

Request
  • formatany of

    Diagram format: `mermaid` or `freeform`. Defaults to `mermaid`.

    any of (2)
    Variant 1
    one of (2)
    Variant 1
    valuestringenum mermaid
    Variant 2
    valuestringenum freeform
    Variant 2
    valuenull
  • 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`.

Response
  • 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 1
    one of (2)
    Variant 1
    valuestringenum mermaid
    Variant 2
    valuestringenum 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.

Triggers0

No triggers registered

Search the registry

Find workers, kits and executables, or jump to a page.