RUrunchat
Canvas

Canvas Tool

Changed on

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

  • Base URL
    https://runchat.com/api/v1
  • URL
    https://runchat.com/api/v1/{runchat_id}/canvas
  • Auth
    HTTP bearer

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' | 'search_docs' | 'fetch_page' | 'search_tools' | 'inspect_tool' | 'execute_tool' | 'use_skill' | 'publish_runchat' | 'update_runchat' | 'grasshopper_read_canvas' | 'grasshopper_read_selection' | 'grasshopper_search_components' | 'grasshopper_read_component_values' | 'grasshopper_create_components' | 'grasshopper_create_python_script_components' | 'grasshopper_connect_components' | 'grasshopper_configure_components' | 'grasshopper_group_components' | 'grasshopper_layout_canvas' | 'grasshopper_delete_components' | 'grasshopper_disconnect_components' | 'run_rhino_command' | 'run_blender_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

  • 4fa3fd81ab51Revision changes
    • breaking

      removed the enum value grasshopper_api of the request property

    • info

      added the new grasshopper_configure_components enum value to the request property

    • info

      added the new grasshopper_connect_components enum value to the request property

    • info

      added the new grasshopper_create_components enum value to the request property

    • info

      added the new grasshopper_create_python_script_components enum value to the request property

    • info

      added the new grasshopper_delete_components enum value to the request property

    • info

      added the new grasshopper_disconnect_components enum value to the request property

    • info

      added the new grasshopper_group_components enum value to the request property

    • info

      added the new grasshopper_layout_canvas enum value to the request property

    • info

      added the new grasshopper_read_canvas enum value to the request property

    • info

      added the new grasshopper_read_component_values enum value to the request property

    • info

      added the new grasshopper_read_selection enum value to the request property

    • info

      added the new grasshopper_search_components enum value to the request property

    • info

      added the new run_blender_command enum value to the request property

    • info

      added the new search_docs enum value to the request property