Skip to main content
GET
/
workflow
/
{task_id}
/
events
Error
A valid request URL is required to generate request examples
"<string>"

Documentation Index

Fetch the complete documentation index at: https://docs.dify.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with Bearer. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

task_id
string<uuid>
required

Workflow run ID returned by the original workflow run request.

Query Parameters

user
string
required

End-user identifier that originally triggered the run. Must match the creator of the workflow run.

include_state_snapshot
boolean
default:false

When true, replay from the persisted state snapshot to include a status summary of already-executed nodes before streaming new events.

continue_on_pause
boolean
default:false

Set to true to keep the stream open across multiple workflow_paused events (useful when the workflow has more than one Human Input node in sequence). Default closes the stream after the first pause.

Response

Server-Sent Events stream. Each event is delivered as data: {JSON}\n\n. Event payloads follow the same schemas as the original streaming response.

SSE stream of workflow events.