RMS Chat (SSE - Stream)
curl --request POST \
--url https://api.linqalpha.com/v1/rms_chat \
--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",
"query": "What are the latest insights on AAPL performance?",
"search_types": [
"rms",
"external"
],
"external_types": [
"transcript",
"filing",
"news",
"ir_slide"
],
"rms_types": [
"emailnotes",
"generalnotes"
],
"stock_ids": [
"BBG001S5N8V8"
],
"per_event_size": 0,
"per_event_sleep_time": 0.01,
"source_batch_id": "123e4567-e89b-12d3-a456-426614174000",
"fiscal_period": {
"start_time": {
"year": 2023,
"quarter": 1
},
"end_time": {
"year": 2024,
"quarter": 3
}
}
}
'import requests
url = "https://api.linqalpha.com/v1/rms_chat"
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",
"query": "What are the latest insights on AAPL performance?",
"search_types": ["rms", "external"],
"external_types": ["transcript", "filing", "news", "ir_slide"],
"rms_types": ["emailnotes", "generalnotes"],
"stock_ids": ["BBG001S5N8V8"],
"per_event_size": 0,
"per_event_sleep_time": 0.01,
"source_batch_id": "123e4567-e89b-12d3-a456-426614174000",
"fiscal_period": {
"start_time": {
"year": 2023,
"quarter": 1
},
"end_time": {
"year": 2024,
"quarter": 3
}
}
}
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',
query: 'What are the latest insights on AAPL performance?',
search_types: ['rms', 'external'],
external_types: ['transcript', 'filing', 'news', 'ir_slide'],
rms_types: ['emailnotes', 'generalnotes'],
stock_ids: ['BBG001S5N8V8'],
per_event_size: 0,
per_event_sleep_time: 0.01,
source_batch_id: '123e4567-e89b-12d3-a456-426614174000',
fiscal_period: {start_time: {year: 2023, quarter: 1}, end_time: {year: 2024, quarter: 3}}
})
};
fetch('https://api.linqalpha.com/v1/rms_chat', 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.linqalpha.com/v1/rms_chat",
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',
'query' => 'What are the latest insights on AAPL performance?',
'search_types' => [
'rms',
'external'
],
'external_types' => [
'transcript',
'filing',
'news',
'ir_slide'
],
'rms_types' => [
'emailnotes',
'generalnotes'
],
'stock_ids' => [
'BBG001S5N8V8'
],
'per_event_size' => 0,
'per_event_sleep_time' => 0.01,
'source_batch_id' => '123e4567-e89b-12d3-a456-426614174000',
'fiscal_period' => [
'start_time' => [
'year' => 2023,
'quarter' => 1
],
'end_time' => [
'year' => 2024,
'quarter' => 3
]
]
]),
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.linqalpha.com/v1/rms_chat"
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 \"query\": \"What are the latest insights on AAPL performance?\",\n \"search_types\": [\n \"rms\",\n \"external\"\n ],\n \"external_types\": [\n \"transcript\",\n \"filing\",\n \"news\",\n \"ir_slide\"\n ],\n \"rms_types\": [\n \"emailnotes\",\n \"generalnotes\"\n ],\n \"stock_ids\": [\n \"BBG001S5N8V8\"\n ],\n \"per_event_size\": 0,\n \"per_event_sleep_time\": 0.01,\n \"source_batch_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"fiscal_period\": {\n \"start_time\": {\n \"year\": 2023,\n \"quarter\": 1\n },\n \"end_time\": {\n \"year\": 2024,\n \"quarter\": 3\n }\n }\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.linqalpha.com/v1/rms_chat")
.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 \"query\": \"What are the latest insights on AAPL performance?\",\n \"search_types\": [\n \"rms\",\n \"external\"\n ],\n \"external_types\": [\n \"transcript\",\n \"filing\",\n \"news\",\n \"ir_slide\"\n ],\n \"rms_types\": [\n \"emailnotes\",\n \"generalnotes\"\n ],\n \"stock_ids\": [\n \"BBG001S5N8V8\"\n ],\n \"per_event_size\": 0,\n \"per_event_sleep_time\": 0.01,\n \"source_batch_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"fiscal_period\": {\n \"start_time\": {\n \"year\": 2023,\n \"quarter\": 1\n },\n \"end_time\": {\n \"year\": 2024,\n \"quarter\": 3\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.linqalpha.com/v1/rms_chat")
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 \"query\": \"What are the latest insights on AAPL performance?\",\n \"search_types\": [\n \"rms\",\n \"external\"\n ],\n \"external_types\": [\n \"transcript\",\n \"filing\",\n \"news\",\n \"ir_slide\"\n ],\n \"rms_types\": [\n \"emailnotes\",\n \"generalnotes\"\n ],\n \"stock_ids\": [\n \"BBG001S5N8V8\"\n ],\n \"per_event_size\": 0,\n \"per_event_sleep_time\": 0.01,\n \"source_batch_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"fiscal_period\": {\n \"start_time\": {\n \"year\": 2023,\n \"quarter\": 1\n },\n \"end_time\": {\n \"year\": 2024,\n \"quarter\": 3\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"event_name": "conversation",
"data": {
"conversation_id": "123e4567-e89b-12d3-a456-426614174000"
}
}RMS (On request)
RMS Chat
Generate a response using the RMS (Research Management System) with streaming server-sent events. This endpoint provides enhanced search capabilities with organization-specific data and customizable document types.
Note: This feature is available to a limited set of users only. Access requires a separate onboarding process, which will be provided upon request. For more information, please contact us at support@linqalpha.com
POST
/
v1
/
rms_chat
RMS Chat (SSE - Stream)
curl --request POST \
--url https://api.linqalpha.com/v1/rms_chat \
--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",
"query": "What are the latest insights on AAPL performance?",
"search_types": [
"rms",
"external"
],
"external_types": [
"transcript",
"filing",
"news",
"ir_slide"
],
"rms_types": [
"emailnotes",
"generalnotes"
],
"stock_ids": [
"BBG001S5N8V8"
],
"per_event_size": 0,
"per_event_sleep_time": 0.01,
"source_batch_id": "123e4567-e89b-12d3-a456-426614174000",
"fiscal_period": {
"start_time": {
"year": 2023,
"quarter": 1
},
"end_time": {
"year": 2024,
"quarter": 3
}
}
}
'import requests
url = "https://api.linqalpha.com/v1/rms_chat"
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",
"query": "What are the latest insights on AAPL performance?",
"search_types": ["rms", "external"],
"external_types": ["transcript", "filing", "news", "ir_slide"],
"rms_types": ["emailnotes", "generalnotes"],
"stock_ids": ["BBG001S5N8V8"],
"per_event_size": 0,
"per_event_sleep_time": 0.01,
"source_batch_id": "123e4567-e89b-12d3-a456-426614174000",
"fiscal_period": {
"start_time": {
"year": 2023,
"quarter": 1
},
"end_time": {
"year": 2024,
"quarter": 3
}
}
}
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',
query: 'What are the latest insights on AAPL performance?',
search_types: ['rms', 'external'],
external_types: ['transcript', 'filing', 'news', 'ir_slide'],
rms_types: ['emailnotes', 'generalnotes'],
stock_ids: ['BBG001S5N8V8'],
per_event_size: 0,
per_event_sleep_time: 0.01,
source_batch_id: '123e4567-e89b-12d3-a456-426614174000',
fiscal_period: {start_time: {year: 2023, quarter: 1}, end_time: {year: 2024, quarter: 3}}
})
};
fetch('https://api.linqalpha.com/v1/rms_chat', 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.linqalpha.com/v1/rms_chat",
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',
'query' => 'What are the latest insights on AAPL performance?',
'search_types' => [
'rms',
'external'
],
'external_types' => [
'transcript',
'filing',
'news',
'ir_slide'
],
'rms_types' => [
'emailnotes',
'generalnotes'
],
'stock_ids' => [
'BBG001S5N8V8'
],
'per_event_size' => 0,
'per_event_sleep_time' => 0.01,
'source_batch_id' => '123e4567-e89b-12d3-a456-426614174000',
'fiscal_period' => [
'start_time' => [
'year' => 2023,
'quarter' => 1
],
'end_time' => [
'year' => 2024,
'quarter' => 3
]
]
]),
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.linqalpha.com/v1/rms_chat"
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 \"query\": \"What are the latest insights on AAPL performance?\",\n \"search_types\": [\n \"rms\",\n \"external\"\n ],\n \"external_types\": [\n \"transcript\",\n \"filing\",\n \"news\",\n \"ir_slide\"\n ],\n \"rms_types\": [\n \"emailnotes\",\n \"generalnotes\"\n ],\n \"stock_ids\": [\n \"BBG001S5N8V8\"\n ],\n \"per_event_size\": 0,\n \"per_event_sleep_time\": 0.01,\n \"source_batch_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"fiscal_period\": {\n \"start_time\": {\n \"year\": 2023,\n \"quarter\": 1\n },\n \"end_time\": {\n \"year\": 2024,\n \"quarter\": 3\n }\n }\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.linqalpha.com/v1/rms_chat")
.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 \"query\": \"What are the latest insights on AAPL performance?\",\n \"search_types\": [\n \"rms\",\n \"external\"\n ],\n \"external_types\": [\n \"transcript\",\n \"filing\",\n \"news\",\n \"ir_slide\"\n ],\n \"rms_types\": [\n \"emailnotes\",\n \"generalnotes\"\n ],\n \"stock_ids\": [\n \"BBG001S5N8V8\"\n ],\n \"per_event_size\": 0,\n \"per_event_sleep_time\": 0.01,\n \"source_batch_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"fiscal_period\": {\n \"start_time\": {\n \"year\": 2023,\n \"quarter\": 1\n },\n \"end_time\": {\n \"year\": 2024,\n \"quarter\": 3\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.linqalpha.com/v1/rms_chat")
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 \"query\": \"What are the latest insights on AAPL performance?\",\n \"search_types\": [\n \"rms\",\n \"external\"\n ],\n \"external_types\": [\n \"transcript\",\n \"filing\",\n \"news\",\n \"ir_slide\"\n ],\n \"rms_types\": [\n \"emailnotes\",\n \"generalnotes\"\n ],\n \"stock_ids\": [\n \"BBG001S5N8V8\"\n ],\n \"per_event_size\": 0,\n \"per_event_sleep_time\": 0.01,\n \"source_batch_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"fiscal_period\": {\n \"start_time\": {\n \"year\": 2023,\n \"quarter\": 1\n },\n \"end_time\": {\n \"year\": 2024,\n \"quarter\": 3\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"event_name": "conversation",
"data": {
"conversation_id": "123e4567-e89b-12d3-a456-426614174000"
}
}Authorizations
Body
application/json
Organization ID
Example:
"123e4567-e89b-12d3-a456-426614174000"
User ID
Example:
"123e4567-e89b-12d3-a456-426614174000"
User email
Example:
"john.doe@example.com"
User name
Example:
"John Doe"
Search query
Example:
"What are the latest insights on AAPL performance?"
Types of search to perform
Available options:
rms, external, all Example:
["rms", "external"]
Conversation ID for multi-turn interactions (optional)
Example:
"987e6543-e21b-32d3-c654-426614174999"
Source batch ID
Example:
"123e4567-e89b-12d3-a456-426614174000"
Optional array of specific source IDs to search within. If provided, only these sources will be searched. If omitted, all sources belonging to the source_batch_id will be searched. Requires source_batch_id to be specified, and all IDs must exist within that batch.
Example:
[
"123e4567-e89b-12d3-a456-426614174000",
"223e4567-e89b-12d3-a456-426614174001"
]
Container IDs to search within (optional)
Example:
["container_id1", "container_id2"]
Document IDs to search within (optional)
Example:
["document_id1", "document_id2"]
Client API URL
Example:
"https://api.example.com"
Number of kb size to return per event. When set to 0, search_results will not be returned via stream, only chat_message_id will be returned. You can retrieve search_results using the chat_message_id through the references API. Setting to 0 is recommended for stream stability.
Example:
0
Sleep time per event
Example:
0.01
RMS document types (customizable)
Example:
[
"emailnotes",
"generalnotes",
"templatednotes",
"custom-data",
"structured-data"
]
RMS sub-types mapping (optional)
Example:
{
"template_note": ["template_note1", "template_note2"]
}
External document types (optional, defaults to ["transcript", "filing", "news", "ir_slide"])
Available options:
transcript, filing, news, ir_slide, structured_data Example:
["transcript", "filing", "news", "ir_slide"]
Bloomberg stock IDs (optional)
Example:
["BBG001S5N8V8"]
Search tags (optional)
Example:
["tech", "earnings"]
Filter documents by upload date range. At least one of start_time or end_time must be provided.
Show child attributes
Show child attributes
Fiscal period filter (optional)
Show child attributes
Show child attributes
Example:
{
"start_time": { "year": 2023, "quarter": 1 },
"end_time": { "year": 2024, "quarter": 3 }
}
Whether to use agentic search
Example:
true
Prerelease filters (optional)
Example:
{ "stream_t2s_table": true }
Custom filters (optional)
Example:
{ "your_own_field": "value" }
Was this page helpful?