Skip to Content
MosaicMosaicDocs
Tool Reference

EditCanvas

Edit a Mosaic canvas live using natural-language instructions.

Starter documentation. Features and account details may differ from this deployment.

EditCanvas

Edit a Mosaic canvas live using natural-language instructions. Can create shapes, text and bound connectors; insert real person mentions using supplied userId/email; move, resize, style, relabel, group, reparent, reorder and delete ordinary items. Preserves unrelated concurrent edits through the live CRDT. Existing assets/references can move or be styled but cannot be created or deleted by this tool. Labels are whole-string last-write-wins. For precise known edits prefer ApplyCanvasEdits, which avoids a nested model. Use this tool for genuine design work; it reviews a rendered image of its own result, so do not RenderCanvas before or after it. ReadCanvas first for IDs and context. Returns acknowledged operation count and outcome; cancellation or network failure may leave partial edits, so reread before retrying. Never send the same edit blindly twice. If ReadCanvas returned artifactGuide, those operations are available here too.

Parameters

ParameterTypeRequiredDescription
document_idstringYesCanvas document ID from an attachment or search.
instructionsstringYesSpecific desired changes. Include stable item IDs when referring to existing items.

On this page