Skip to main content
Free · Your own key only
Gives back every card and every line on a canvas. To follow the lines from one card (a tree, a chain), pass from_ids: it then returns only the cards on that path, nearest first, with their full text.
The cloud tools only read canvases. They never draw on one.
Call it at POST /platform/v1/me/tools/canvas_read. On MCP, your AI tool calls canvas_read with the same arguments.

Arguments

Send these inside arguments.
string
required
The canvas id, from canvas_list.
string | string[]
default:"null"
Start from these cards. A note card’s id is its note id, so a note you found can be a start.
integer
default:"2"
How many steps to follow, 0-6.
string
default:"\"both\""
down follows the arrows, up goes against them, both goes both ways.

Returns

The tool’s answer comes back under result.
string
The canvas name.
object[]
Each card: id, noteId, type, title, text (up to 1,500 characters) and color.
Each line: from, to, and when set directionality, kind and label.
object
Only with from_ids: the cards on the path, nearest first, with hop and full text.