Pause RMS Chat Stream
curl --request POST \
--url https://api.eu.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": "john.doe@example.com",
"user_name": "John Doe",
"dialogue_id": "2d382478-077e-4bcb-b6ec-4fdcbc75ab33"
}
'import requests
url = "https://api.eu.linqalpha.com/v1/stop_stream"
payload = {
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"conversation_id": "987e6543-e21b-32d3-c654-426614174999",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_email": "john.doe@example.com",
"user_name": "John Doe",
"dialogue_id": "2d382478-077e-4bcb-b6ec-4fdcbc75ab33"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organization_id: '123e4567-e89b-12d3-a456-426614174000',
conversation_id: '987e6543-e21b-32d3-c654-426614174999',
user_id: '123e4567-e89b-12d3-a456-426614174000',
user_email: 'john.doe@example.com',
user_name: 'John Doe',
dialogue_id: '2d382478-077e-4bcb-b6ec-4fdcbc75ab33'
})
};
fetch('https://api.eu.linqalpha.com/v1/stop_stream', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eu.linqalpha.com/v1/stop_stream",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'organization_id' => '123e4567-e89b-12d3-a456-426614174000',
'conversation_id' => '987e6543-e21b-32d3-c654-426614174999',
'user_id' => '123e4567-e89b-12d3-a456-426614174000',
'user_email' => 'john.doe@example.com',
'user_name' => 'John Doe',
'dialogue_id' => '2d382478-077e-4bcb-b6ec-4fdcbc75ab33'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eu.linqalpha.com/v1/stop_stream"
payload := strings.NewReader("{\n \"organization_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"conversation_id\": \"987e6543-e21b-32d3-c654-426614174999\",\n \"user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"user_email\": \"john.doe@example.com\",\n \"user_name\": \"John Doe\",\n \"dialogue_id\": \"2d382478-077e-4bcb-b6ec-4fdcbc75ab33\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eu.linqalpha.com/v1/stop_stream")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organization_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"conversation_id\": \"987e6543-e21b-32d3-c654-426614174999\",\n \"user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"user_email\": \"john.doe@example.com\",\n \"user_name\": \"John Doe\",\n \"dialogue_id\": \"2d382478-077e-4bcb-b6ec-4fdcbc75ab33\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eu.linqalpha.com/v1/stop_stream")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organization_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"conversation_id\": \"987e6543-e21b-32d3-c654-426614174999\",\n \"user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"user_email\": \"john.doe@example.com\",\n \"user_name\": \"John Doe\",\n \"dialogue_id\": \"2d382478-077e-4bcb-b6ec-4fdcbc75ab33\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Interrupt request received",
"dialogue_id": "2d382478-077e-4bcb-b6ec-4fdcbc75ab33",
"paused": 1676198400
}{
"error": {
"code": "ORGANIZATION_ID_MISSING",
"msg": "organization_id is required",
"message": "organization_id is required"
},
"payload": null
}{
"error": {
"code": "API_KEY_MISSING",
"msg": "header does not contain api key",
"message": "header does not contain api key"
},
"payload": null
}{
"error": {
"code": "FORBIDDEN",
"message": "Access denied: insufficient permissions."
},
"payload": null
}Legacy endpoints
Stop Stream
Legacy in the EU region. This endpoint is kept for backward compatibility and is not recommended for new EU integrations. It pauses the legacy RMS Chat stream only and has no counterpart in the Analytics V2 flow — to stop an Analytics V2 stream, close the SSE connection.
Pause the RMS (Research Management System) chat stream.
POST
/
v1
/
stop_stream
Pause RMS Chat Stream
curl --request POST \
--url https://api.eu.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": "john.doe@example.com",
"user_name": "John Doe",
"dialogue_id": "2d382478-077e-4bcb-b6ec-4fdcbc75ab33"
}
'import requests
url = "https://api.eu.linqalpha.com/v1/stop_stream"
payload = {
"organization_id": "123e4567-e89b-12d3-a456-426614174000",
"conversation_id": "987e6543-e21b-32d3-c654-426614174999",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"user_email": "john.doe@example.com",
"user_name": "John Doe",
"dialogue_id": "2d382478-077e-4bcb-b6ec-4fdcbc75ab33"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organization_id: '123e4567-e89b-12d3-a456-426614174000',
conversation_id: '987e6543-e21b-32d3-c654-426614174999',
user_id: '123e4567-e89b-12d3-a456-426614174000',
user_email: 'john.doe@example.com',
user_name: 'John Doe',
dialogue_id: '2d382478-077e-4bcb-b6ec-4fdcbc75ab33'
})
};
fetch('https://api.eu.linqalpha.com/v1/stop_stream', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eu.linqalpha.com/v1/stop_stream",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'organization_id' => '123e4567-e89b-12d3-a456-426614174000',
'conversation_id' => '987e6543-e21b-32d3-c654-426614174999',
'user_id' => '123e4567-e89b-12d3-a456-426614174000',
'user_email' => 'john.doe@example.com',
'user_name' => 'John Doe',
'dialogue_id' => '2d382478-077e-4bcb-b6ec-4fdcbc75ab33'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.eu.linqalpha.com/v1/stop_stream"
payload := strings.NewReader("{\n \"organization_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"conversation_id\": \"987e6543-e21b-32d3-c654-426614174999\",\n \"user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"user_email\": \"john.doe@example.com\",\n \"user_name\": \"John Doe\",\n \"dialogue_id\": \"2d382478-077e-4bcb-b6ec-4fdcbc75ab33\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.eu.linqalpha.com/v1/stop_stream")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organization_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"conversation_id\": \"987e6543-e21b-32d3-c654-426614174999\",\n \"user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"user_email\": \"john.doe@example.com\",\n \"user_name\": \"John Doe\",\n \"dialogue_id\": \"2d382478-077e-4bcb-b6ec-4fdcbc75ab33\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.eu.linqalpha.com/v1/stop_stream")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organization_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"conversation_id\": \"987e6543-e21b-32d3-c654-426614174999\",\n \"user_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"user_email\": \"john.doe@example.com\",\n \"user_name\": \"John Doe\",\n \"dialogue_id\": \"2d382478-077e-4bcb-b6ec-4fdcbc75ab33\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Interrupt request received",
"dialogue_id": "2d382478-077e-4bcb-b6ec-4fdcbc75ab33",
"paused": 1676198400
}{
"error": {
"code": "ORGANIZATION_ID_MISSING",
"msg": "organization_id is required",
"message": "organization_id is required"
},
"payload": null
}{
"error": {
"code": "API_KEY_MISSING",
"msg": "header does not contain api key",
"message": "header does not contain api key"
},
"payload": null
}{
"error": {
"code": "FORBIDDEN",
"message": "Access denied: insufficient permissions."
},
"payload": null
}Authorizations
Body
application/json