Workflow Runs

Run Workflow

Changed on

Available for: Workflow apps.

Run the app's published workflow and return its outputs, either in a single blocking response or as a streaming Server-Sent Events feed. Requires a published workflow.

post/workflows/run

Request

  • Base URL
    https://api.dify.ai/v1
  • URL
    https://api.dify.ai/v1/workflows/run
  • Auth
    HTTP bearer

Request body

WorkflowExecutionRequest required(unresolved $ref)

Response

Successful response. The content type and structure depend on the response_mode parameter in the request.

  • If response_mode is blocking, returns application/json with a WorkflowBlockingResponse object.
  • If response_mode is streaming, returns text/event-stream with a stream of ChunkWorkflowEvent objects.
task_idstring uuid

Task ID for the in-progress execution. Use this with Stop Workflow Task to cancel a running workflow. Only valid during execution.

workflow_run_idstring uuid

Persistent identifier for this workflow run record. Use this with Get Workflow Run Detail to retrieve results after execution.

Changes