Skip to main content
POST
/
v1
/
agents
/
{agent_id}
/
gateway
/
conversations
/
{conversation_id}
/
stop
Stop Conversation
curl --request POST \
  --url https://api.xpander.ai/v1/agents/{agent_id}/gateway/conversations/{conversation_id}/stop \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "clear_queue": false
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}
Cancels the in-flight turn (router plus any child sub-execution). The queue is kept unless clear_queue=true. See the Agent Gateway overview for the full conversation model.

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Path Parameters

​
agent_id
string
required
​
conversation_id
string
required

Body

application/json

Body of the chat-backend stop endpoint.

​
clear_queue
boolean
default:false

Response

Successful Response