---
title: "Canvas Tool"
method: POST
path: "/{runchat_id}/canvas"
tags: ["Canvas"]
---

# Canvas Tool

`POST /{runchat_id}/canvas`

Execute a canvas tool to read, create, connect, update, or run nodes on a Runchat workflow. All canvas operations are dispatched through this single endpoint by specifying a `tool` name and its `args`.

See the [Canvas Tools Reference](/api-reference/canvas-tools) for detailed parameter documentation for each tool.

## Request body

- CanvasRequest — Request body for the canvas tool endpoint.
  - `tool` 'get_canvas' | 'read_nodes' | 'create_prompt_node' | 'create_input_node' | 'create_image_node' | 'create_code_node' | 'create_note' | 'place_tool' | 'create_artifact_node' | 'create_node' | 'update_node' | 'connect_nodes' | 'organize_nodes' | 'delete_nodes' | 'delete_edges' | 'run_nodes' | 'read_files' | 'read_status' | 'edit_file' | 'create_files' | 'delete_files' | 'get_model_params' | 'list_models' | 'view_image' | 'web_search' | 'fetch_page' | 'search_tools' | 'inspect_tool' | 'execute_tool' | 'use_skill' | 'publish_runchat' | 'update_runchat' | 'grasshopper_api' | 'run_rhino_command' | 'take_screenshot', required — The canvas tool to execute. Each node type has its own creation tool (create_prompt_node, create_code_node, …); create_node remains as a legacy alias that also supports batch creation via a `nodes` array. See the Canvas Tools Reference for detailed parameter documentation for each tool.
  - `args` object — Tool-specific arguments. The shape depends on which tool is being called.

## Response `200`

Successful tool execution.

- object
  - `result` object — Tool-specific result payload. Structure varies by tool.

## Other responses

- `400` — Bad Request - The request could not be understood or was missing required parameters.
- `403` — Access denied — user does not have permission to this Runchat.
- `404` — Runchat not found.
- `500` — Internal Server Error - An unexpected error occurred on the server.

---

[API](https://skmtc.dev/runchat/apis/runchat-api.md) · [All operations](https://skmtc.dev/runchat/apis/runchat-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runchat/runchat-api/revisions/ccf82c335a7e/schema)