Skip to main content
POST
/
v1
/
rms_deep_research
RMS Deep Research
curl --request POST \
  --url https://api.linqalpha.com/v1/rms_deep_research \
  --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",
  "query": "What are the latest insights on AAPL performance?",
  "search_types": [
    "rms",
    "external"
  ],
  "external_types": [
    "transcript",
    "filing",
    "news",
    "ir_slide"
  ],
  "rms_types": [
    "emailnotes",
    "generalnotes"
  ],
  "document_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "container_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "stock_ids": [
    "BBG001S5N8V8"
  ],
  "per_event_size": 0,
  "per_event_sleep_time": 0.01,
  "upload_period": {
    "start_time": {
      "year": 2023,
      "month": 1,
      "day": 1
    },
    "end_time": {
      "year": 2024,
      "month": 12,
      "day": 31
    }
  },
  "fiscal_period": {
    "start_time": {
      "year": 2023,
      "quarter": 1
    },
    "end_time": {
      "year": 2024,
      "quarter": 3
    }
  }
}
'
{
  "event_name": "conversation",
  "data": {
    "conversation_id": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
organization_id
string<uuid>
required

Organization ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
user_id
string
required

User ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
user_email
string
required

User email

Example:

"[email protected]"

​
user_name
string
required

User name

Example:

"John Doe"

​
query
string
required

Search query

Example:

"What are the latest insights on AAPL performance?"

​
search_types
enum<string>[]
required

Types of search to perform

Available options:
rms,
external,
all
Example:
["rms", "external"]
​
external_types
enum<string>[]
required

External document types

Available options:
transcript,
filing,
news,
ir_slide,
structured_data
Example:
[
  "transcript",
  "filing",
  "news",
  "ir_slide",
  "structured_data"
]
​
conversation_id
string<uuid>

Conversation ID for multi-turn interactions (optional)

Example:

"987e6543-e21b-32d3-c654-426614174999"

​
source_batch_id
string<uuid>

Source batch ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
container_ids
string[]

Container IDs to search within (optional)

Example:
["container_id1", "container_id2"]
​
document_ids
string[]

Document IDs to search within (optional)

Example:
["document_id1", "document_id2"]
​
client_api_url
string | null

Client API URL

Example:

"https://api.example.com"

​
per_event_size
number
default:0

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

​
per_event_sleep_time
number
default:0.01

Sleep time per event

Example:

0.01

​
rms_types
string[]

RMS document types (customizable)

Example:
[
  "emailnotes",
  "generalnotes",
  "templatednotes",
  "custom-data",
  "structured-data"
]
​
rms_sub_types
object

RMS sub-types mapping (optional)

Example:
{
  "template_note": ["template_note1", "template_note2"]
}
​
stock_ids
string[]

Bloomberg stock IDs (optional)

Example:
["BBG001S5N8V8"]
​
tags
string[]

Search tags (optional)

Example:
["tech", "earnings"]
​
upload_period
object

Upload date filter (optional)

​
fiscal_period
object

Fiscal period filter (optional)

Example:
{
  "start_time": { "year": 2023, "quarter": 1 },
  "end_time": { "year": 2024, "quarter": 12 }
}
​
agentic
boolean

Whether to use agentic search

Example:

true

​
custom_filters
object

Custom filters (optional)

Example:
{ "your_own_field": "value" }

Response

SSE stream of research events. Each event is sent as data: {json}\n\n

Conversation event

​
event_name
enum<string>
required
Available options:
conversation
​
data
object
required

Event-specific data payload