Stream Workflow Response (SSE)
POST
/workflow-service/api/v2/workflows/{workflow_id}/run
workflow_id: ID of the workflow for which the response is to be created.text/event-stream: A stream of events (start, status, token, error, end) culminating in the final result or an error message.Request
Path Params
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request POST 'https:///workflow-service/api/v2/workflows/1/run' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
"chat_thread_id": 1,
"history": [
{
"bot": "Paris is the capital of France.",
"user": "What is the capital of France?"
}
],
"query_source": "web",
"user_email": "[email protected]",
"user_query": "and what about the weather?"
}'Response Response Example
200 - Success
event: start
data: {"message":"Analyzing...","step":"start"}
event: status
data: {"message":"Making a plan...","step":"planner_start"}
event: status
data: {"message":"Routing query...","step":"router_start"}
event: status
data: {"message":"Retrieving response from agent...","step":"agent_start"}
event: token
data: {"delta":"Paris","step":"agent_stream"}
event: status
data: {"message":"Consolidating responses...","step":"consolidator_start"}
event: token
data: {"delta":"Paris","step":"consolidator_stream"}
event: end
data: {"message":"Finished.","step":"end","output":{"answer":"Paris is the capital of France.","thread_id":"thread_456","workflow_response_id":123,"thread_name":"Questions about Paris","agents_used":["Knowledge Agent"],"sources":"Wikipedia","references":[],"subqueries":[]},"success":true}