Synchronous Execution

Execute Chatflow (Synchronous)

post

Executes the latest published version of a specific Chatflow and waits for the complete result. The response is formatted for immediate use in chat applications. This is a blocking call, best used for quick-running chatflows.

Authorizations
X-API-KeystringRequired

Your secret API key.

Path parameters
chatflow_idstringRequired

The unique identifier of the Chatflow to execute.

Body
Responses
chevron-right
200

The execution was successful and the final output is returned in an OpenAI-compatible format.

application/json
post
/execute_chatflow/{chatflow_id}/execute

Execute Chatflow with Streaming (Synchronous)

post

Executes the latest published version of a specific Chatflow and streams structured events in real-time using Server-Sent Events (SSE). Each event is a JSON object sent in the format data: <json_object>\n\n. This provides a detailed, live feed of the execution progress, node by node.

Authorizations
X-API-KeystringRequired

Your secret API key.

Path parameters
chatflow_idstringRequired

The unique identifier of the Chatflow to execute.

Body
Responses
chevron-right
200

A stream of structured JSON events representing the real-time execution progress and output.

text/event-stream
Responseone of
or
or
or
or
or
or
post
/execute_chatflow/{chatflow_id}/stream_execute

Execute Workflow (Synchronous)

post

Executes the latest published version of a specific Workflow and waits for the complete, detailed result. This is a blocking call that returns the final output and optionally the execution details of each node.

Authorizations
X-API-KeystringRequired

Your secret API key.

Path parameters
workflow_idstringRequired

The unique identifier of the Workflow to execute.

Body
Responses
chevron-right
200

The execution was successful and the final output is returned as a detailed JSON object.

application/json
post
/execute_workflow/{workflow_id}/execute

Execute Workflow with Streaming (Synchronous)

post

Executes the latest published version of a specific Workflow and streams structured events in real-time using Server-Sent Events (SSE). Each event is a JSON object sent in the format data: <json_object>\n\n. This provides a detailed, live feed of the workflow's progress, node by node.

Authorizations
X-API-KeystringRequired

Your secret API key.

Path parameters
chatflow_idstringRequired

The unique identifier of the Workflow to execute.

Body
Responses
chevron-right
200

A stream of structured JSON events representing the real-time execution progress and output.

text/event-stream
Responseone of
or
or
or
or
or
or
post
/execute_workflow/{chatflow_id}/stream_execute

Last updated