SpecifyDocs

canvas_create

tools/call

Create a canvas: a page in a project's Docs when project is given, otherwise a canvas in the workspace, which everyone in the workspace can open (in a personal workspace, only your person). Starts empty or from a template.

Scopes

read:projectswrite:projects

A project canvas also needs its project to be readable, and for writes writable (Edit tasks, not archived) by the key's person. A workspace canvas is readable when its person owns it or it is shared with the workspace, and writable when its person owns it or holds Edit tasks on a shared one.

Inputs

titlestringRequired
projectstring
Project name, key or ID. Omit for a workspace canvas.
template"blank" | "flowchart" | "swimlane" | "org_chart" | "mind_map"
idempotencyKeystringRequired
Unique retry key; a retry with the same key returns the first result.

Returns

The canvas: canvasId, pageId for a project canvas, seq and its address. A call returns content[0].text with the JSON result and structuredContent.result with the same value.

Listed when

The key has read:projects and Canvas is open for the workspace; the tools that write need write:projects too.