Skip to main content
POST
This endpoint runs a workflow that already exists. To build or edit a workflow programmatically, the MCP server or CLI are usually the easiest path — they expose the full canvas toolset (create nodes, connect, run, publish) as native tools and handle auth. The same tools are also available over plain HTTP via the Canvas API.

Authorizations

​
Authorization
string
header
required

Bearer token authentication using Runchat API key. API keys can be created from the account menu

Path Parameters

​
runchat_id
string
required

The unique identifier for the Runchat flow.

Body

application/json

Input data for the Runchat execution. Provide runchat_instance_id to continue an existing execution. The inputs object structure should match the parameters defined in the Runchat API schema, keyed by paramId_nodeId. Alternatively, send raw data for webhook-triggered flows.

Request body for executing a Runchat flow.

​
runchat_instance_id
string

Optional identifier to continue an existing Runchat instance.

​
inputs
object

Object containing input data keyed by 'paramId_nodeId'. Values can be primitive types, arrays, or structured objects for tree/list inputs (e.g., {"0": [...], "0:1": [...]}).

Response

Successful execution of the Runchat flow.

​
metadata
string<json>

Stringified JSON containing execution metadata.

​
runchat_instance_id
string

The unique identifier for the Runchat instance to be used. If omitted a new instance will be created.

​
data
object[]

Array of output data from the executed nodes.