v1

latestOpenAPI 3.1.02026-07-2687120159.0 KB

Close an existing chat conversation

Closes an active chat conversation and marks it as complete.

put/{version}/{account_id}/{project_id}/chat/close

versionstring required

API version

account_idstring required

Account ID

project_idstring required

Project ID

X-API-KEYstring required

Your PolyAI API key.

X-TOKENstring required

Agent authentication token (connector).

conversation_idstring required

ID of the conversation to close

{
  "conversation_id": "CONV-1234567890"
}

successboolean required

Whether the conversation was successfully closed

{
  "success": true
}