Skip to main content
POST
/
v1
/
briefings
/
sse
Generate Briefing
curl --request POST \
  --url https://api.linqalpha.com/v1/briefings/sse \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "query": "<string>",
  "tickers": [
    "<string>"
  ],
  "conversation_id": "<string>",
  "organization_id": "<string>",
  "user_id": "<string>",
  "user_email": "<string>"
}
'
{ "event_name": "conversation", "data": { "conversation_id": "123e4567-e89b-12d3-a456-426614174000" } }

Documentation Index

Fetch the complete documentation index at: https://docs.linqalpha.com/llms.txt

Use this file to discover all available pages before exploring further.

Generate a briefing on-demand via Server-Sent Events streaming. The response format follows the same SSE event structure as the Analytics SSE endpoint.

​
Event Flow

conversation → message → status:start → [think → tool_use → tool_result]* → answer → status:finish
                                         ↑_________________________________↑ (agentic loop, repeats)
Concatenate all answer_piece values from answer events to build the full briefing content.

​
Follow-up Questions

Save the conversation_id from the first conversation event. Pass it as conversation_id in a subsequent request to ask follow-up questions about the generated briefing.

​
Authentication

For platform API keys, you can optionally pass organization_id, user_id, and user_email in the request body to specify which user the briefing is generated for.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
query
string
required

Briefing topic or question

​
tickers
string[]

Optional ticker symbols for context

​
conversation_id
string | null

Continue an existing conversation

​
organization_id
string

Organization ID for platform API keys

​
user_id
string

User ID for platform API keys

​
user_email
string

User email for platform API keys

Response

SSE stream of briefing events. Each event is sent as data: {json}\n\n. Events follow the sequence: conversation → message → status:start → [agentic loop] → answer → status:finish. keepalive events are sent every ~30s.

Conversation event

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

Event-specific data payload