API Reference

Projects

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Canvas

Project management endpoints.

Get project canvas

client.projects.canvas.retrieve(stringprojectID, RequestOptionsoptions?): CanvasRetrieveResponse { canvas_url, diagram, project_id, summary }

GET/projects/{projectId}/canvas

Patch project canvas

client.projects.canvas.update(stringprojectID, CanvasUpdateParams { diagram, node_params } body, RequestOptionsoptions?): CanvasUpdateResponse { canvas_url, created_edge_count, created_node_count, 3 more }

PATCH/projects/{projectId}/canvas

ModelsExpand Collapse

CanvasRetrieveResponse { canvas_url, diagram, project_id, summary }

canvas_url: string

Project canvas URL

formaturi

diagram: string

Mermaid flowchart diagram

minLength1

project_id: string

Project identifier

summary: Summary { edge_count, group_count, isolated_node_count, 2 more }

edge_count: number

minimum0

group_count: number

minimum0

isolated_node_count: number

minimum0

node_count: number

minimum0

workflow_count: number

minimum0

CanvasUpdateResponse { canvas_url, created_edge_count, created_node_count, 3 more }

canvas_url: string

Project canvas URL

formaturi

created_edge_count: number

minimum0

created_node_count: number

minimum0

diagram: string

Applied Mermaid flowchart diagram

minLength1

project_id: string

Project identifier

warnings?: Array<string>