v6

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0182128753.1 KB
Knowledge Pipeline

Run Pipeline

Runs the full knowledge pipeline over one or more datasources. response_mode selects a streaming or blocking response.

post/datasets/{dataset_id}/pipeline/run

Path parameters

dataset_idstring uuid required

Knowledge base ID, from List Knowledge Bases.

Request body

inputsobject required

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

datasource_type'local_file' | 'online_document' | 'website_crawl' | 'online_drive' required

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

start_node_idstring required

ID of the node to start execution from, from List Datasource Plugins.

is_publishedboolean required

Whether to run the published version of the pipeline instead of the current draft. Run the draft to test unpublished changes.

response_mode'streaming' | 'blocking' required

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

Response

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

object required

Complete pipeline execution result. Returned when response_mode is blocking.