Skip to main content

Stream Pipeline Workspace

POST 
/api/v1/workspaces/:workspace_name/haystack/pipelines/stream

Streams a haystack pipeline execution with Server-Sent Events (SSE) format in workspace scope.

This endpoint executes a Haystack pipeline and streams the results as they become available. The response uses Server-Sent Events (SSE) format with the following event types:

  • delta: Content chunks from streaming-capable components (e.g., LLM generators)
  • tool_call_delta: Tool call events (if include_tool_calls is True)
  • tool_call_result: Tool call results (if include_tool_call_results is True)
  • result: Final pipeline result (if include_result is True)
  • error: Error messages if pipeline execution fails

Request​

Responses​

Streaming response from pipeline execution.