curl --request POST \
--url https://runchat.com/api/v1/{runchat_id}/canvas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tool": "get_canvas",
"args": {}
}
'{
"result": {}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Endpoints
Canvas
Read and modify a Runchat canvas programmatically. Discover nodes, create or connect them, organize layout, and execute runs.
POST
/
{runchat_id}
/
canvas
curl --request POST \
--url https://runchat.com/api/v1/{runchat_id}/canvas \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"tool": "get_canvas",
"args": {}
}
'{
"result": {}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Bearer token authentication using Runchat API key. API keys can be created from the account menu
Path Parameters
The unique identifier for the Runchat flow.
Body
application/json
Request body for the canvas tool endpoint.
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.
Available options:
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_api, run_rhino_command, run_blender_command, take_screenshot Tool-specific arguments. The shape depends on which tool is being called.
Response
Successful tool execution.
Tool-specific result payload. Structure varies by tool.