Sign in
Agent Sessions

Stop response

Changed on

Stop response ends the open chat. The request has no body. The response names that session and reports status canceling.

post/v1/agent-sessions/{id}/cancel

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /v1/agent-sessions/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

Session id.

Example:session_abc123

Stable session id.

Response

Stop accepted.

sessionIdstring required

Session that is stopping.

statusstring required

Stop acknowledgement.

Example response

{
  "sessionId": "session_abc123",
  "status": "canceling"
}

Changes