Skip to main content
POST
/
datasets
/
{dataset_id}
/
pipeline
/
run
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

​
dataset_id
string<uuid>
required

Knowledge base ID.

Body

application/json
​
inputs
object
required

Key-value pairs for pipeline input variables defined in the workflow. Pass {} if the pipeline has no input variables.

​
datasource_type
enum<string>
required

Type of the datasource. Determines which fields are expected in datasource_info_list items.

Available options:
local_file,
online_document,
website_crawl,
online_drive
​
datasource_info_list
(Local File · object | Online Document · object | Website Crawl · object | Online Drive · object)[]
required

List of datasource objects to process. The expected item structure depends on datasource_type.

​
start_node_id
string
required

ID of the node to start pipeline execution from.

​
is_published
boolean
required

Whether to run the published or draft version of the pipeline. true runs the latest published version; false runs the current draft (useful for testing unpublished changes).

​
response_mode
enum<string>
required

Response mode for the pipeline execution. streaming returns a Server-Sent Events stream, blocking waits and returns the complete result.

Available options:
streaming,
blocking

Response

Pipeline execution result. Format depends on response_mode: streaming returns a text/event-stream, blocking returns a JSON object.

Server-Sent Events stream. Returned when response_mode is streaming.

Each line is data: {JSON}\n\n. Key events: workflow_started (execution began), node_started / node_finished (per-node progress with node_id, node_type, status, inputs, outputs), workflow_finished (final result with status, outputs, total_tokens, elapsed_time), ping (keepalive).