Skip to main content
POST
/
v1
/
stop_stream
Pause RMS Chat Stream
curl --request POST \
  --url https://api.linqalpha.com/v1/stop_stream \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "conversation_id": "987e6543-e21b-32d3-c654-426614174999",
  "user_id": "123e4567-e89b-12d3-a456-426614174000",
  "user_email": "[email protected]",
  "user_name": "John Doe",
  "dialogue_id": "2d382478-077e-4bcb-b6ec-4fdcbc75ab33"
}
'
{
  "status": "success",
  "message": "Interrupt request received",
  "dialogue_id": "2d382478-077e-4bcb-b6ec-4fdcbc75ab33",
  "paused": 1676198400
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
conversation_id
string<uuid>
required

Conversation ID

​
dialogue_id
string<uuid>
required

Dialogue ID

​
organization_id
string<uuid>

Organization ID

​
user_id
string

User ID

​
user_email
string

User email

​
user_name
string

User name

Response

Stop Stream response

​
status
string

Response status

Example:

"success"

​
message
string

Response message

Example:

"Interrupt request received"

​
dialogue_id
string

Dialogue ID

Example:

"2d382478-077e-4bcb-b6ec-4fdcbc75ab33"

​
paused
integer

Pause timestamp (Unix epoch)

Example:

1676198400