Sign in
Canvas

Canvas Tool

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 for detailed parameter documentation for each tool.

post/{runchat_id}/canvas

Request body

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.

argsobject

Tool-specific arguments. The shape depends on which tool is being called.

Response

Successful tool execution.

resultobject

Tool-specific result payload. Structure varies by tool.

Changes

No recorded changes to this endpoint across all 1 revision of this API.