Skip to main content
POST
/
api
/
chat
/
{chatId}
/
stop
cURL
curl --request POST \
  --url https://api.recoupable.dev/api/chat/{chatId}/stop \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "stopped": true
}

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

Path Parameters

​
chatId
string<uuid>
required

UUID of the chat to stop.

Response

Stop request processed

​
success
boolean
required

Always true when the request was processed.

Example:

true

​
stopped
boolean
required

True when an in-progress response was cancelled; false when nothing was running.

Example:

true