Stream Agent Response (SSE)

POST

/response-service/api/v2/agents/{agent_id}/responses/stream

Allows streaming a new response from a specific agent based on user input. This endpoint processes the user's query, utilizes AI models, and optionally retrieves information from predefined sources before returning data incrementally using Server-Sent Events (SSE).

Path Parameters

agent_id: ID of the agent for which the response is to be created.

Request Body

A JSON object with fields to process the chat interaction.

Returns

text/event-stream: A stream of events (start, status, token, error, end) culminating in the final result or an error message.

Current Version

2.0.0

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

text/event-stream

SSE stream of chat chunks

Body

🟠400Bad Request

🟠422Parameter Error

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///response-service/api/v2/agents//responses/stream' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "caching_enabled": false,
    "chat_thread_id": 1,
    "created_by": "[email protected]",
    "history": [
        {
            "bot": "Paris is the capital of France.",
            "user": "What is the capital of France?"
        }
    ],
    "is_file_attached": false,
    "overrides": {
        "corpus_ids": [
            1
        ],
        "log_intermediate_response": true,
        "retrieve_data_points": true
    },
    "query_source": "web",
    "user_query": "and what about the weather?"
}'

Response Example

200 - Success

event: start
data: {"message":"Analyzing...","step":"start"}

event: status
data: {"message":"Processing query...","step":"query_rewrite_start"}

event: status
data: {"message":"Preparing response...","step":"assistant_start"}

event: token
data: {"delta":"Hello","step":"assistant_stream"}

event: token
data: {"delta":"!","step":"assistant_stream"}

event: end
data: {"message":"Finished.","step":"end","output":{"answer":"Hello! ...","thread_id":1,"agent_response_id":1,"references":[],"chat_thread_name":"Greeting Exchange","blocked":false,"cache_hit":false},"success":true}

Generate Agent Response (Non-Streaming)

Get Agent Responses for a Chat Thread