Close a chat

Closes an active chat conversation and marks it as complete.

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

Close an existing chat conversation

cURL

curl --request PUT \
  --url https://api.us-1.platform.polyai.app/{version}/{account_id}/{project_id}/chat/close \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-TOKEN: <x-token>' \
  --data '
{
  "conversation_id": "CONV-1234567890"
}
'

200

{
  "success": true
}

Authorizations

ApiKeyAuthTokenAuth

X-API-KEY · string · header · required

You must request an API Key to use PolyAI APIs.

Headers

X-API-KEY · string · required

Your PolyAI API key.

X-TOKEN · string · required

Agent authentication token (connector).

Path Parameters

version · string · required

API version

account_id · string · required

Account ID

project_id · string · required

Project ID

Body

application/json

conversation_id · string · required

ID of the conversation to close

Example:

"CONV-1234567890"

Response

200

application/json

OK

success · boolean · required

Whether the conversation was successfully closed

Example:

true