Stop an in-flight streaming response

POST

/response-service/api/v2/agents/{agent_id}/responses/{run_id}/stop-requests

Stop a response that is currently generating. The text produced so far is kept, and the response ends gracefully. The request returns immediately; the actual stop happens asynchronously.

Safe to call anytime — on a response that's already finished, never existed, or finished since you started the request. Always returns 202.

Request Body

None.

Who can stop

Only you can stop your own responses. Others' stop requests are silently ignored.

Current Version

2.1.0

Changelog

2.1.0: Users can stop responses even after re-authenticating.

Request

Path Params

Query Params

Header Params

Responses

🟢202

application/json

Stop requested

Bodyapplication/json

🟠401

🟠403

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request POST 'https:///response-service/api/v2/agents//responses//stop-requests?agent_version=' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

202 - Example 1

{
    "data": {
        "run_id": "5f0c6a1e-8a2b-4c3d-9e4f-1a2b3c4d5e6f"
    },
    "message": "Stop requested",
    "success": true
}

Create Bulk Agent Response Logs

Resume a Streamed Response (SSE)