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>"
  ],
  "stock_ids": [
    "<string>"
  ],
  "language": "<string>",
  "timezone": "<string>",
  "previous_summary": "<string>",
  "conversation_id": "<string>",
  "organization_id": "<string>",
  "user_id": "<string>",
  "user_email": "<string>",
  "user_name": "<string>"
}
'

import requests

url = "https://api.linqalpha.com/v1/briefings/sse"

payload = {
    "query": "<string>",
    "tickers": ["<string>"],
    "stock_ids": ["<string>"],
    "language": "<string>",
    "timezone": "<string>",
    "previous_summary": "<string>",
    "conversation_id": "<string>",
    "organization_id": "<string>",
    "user_id": "<string>",
    "user_email": "<string>",
    "user_name": "<string>"
}
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({
    query: '<string>',
    tickers: ['<string>'],
    stock_ids: ['<string>'],
    language: '<string>',
    timezone: '<string>',
    previous_summary: '<string>',
    conversation_id: '<string>',
    organization_id: '<string>',
    user_id: '<string>',
    user_email: '<string>',
    user_name: '<string>'
  })
};

fetch('https://api.linqalpha.com/v1/briefings/sse', 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/briefings/sse",
  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([
    'query' => '<string>',
    'tickers' => [
        '<string>'
    ],
    'stock_ids' => [
        '<string>'
    ],
    'language' => '<string>',
    'timezone' => '<string>',
    'previous_summary' => '<string>',
    'conversation_id' => '<string>',
    'organization_id' => '<string>',
    'user_id' => '<string>',
    'user_email' => '<string>',
    'user_name' => '<string>'
  ]),
  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/briefings/sse"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"language\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"previous_summary\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\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/briefings/sse")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"language\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"previous_summary\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.linqalpha.com/v1/briefings/sse")

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  \"query\": \"<string>\",\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"language\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"previous_summary\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "event_name": "status",
  "data": {
    "status": "start",
    "message": "Searching news"
  }
}

POST

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>"
  ],
  "stock_ids": [
    "<string>"
  ],
  "language": "<string>",
  "timezone": "<string>",
  "previous_summary": "<string>",
  "conversation_id": "<string>",
  "organization_id": "<string>",
  "user_id": "<string>",
  "user_email": "<string>",
  "user_name": "<string>"
}
'

import requests

url = "https://api.linqalpha.com/v1/briefings/sse"

payload = {
    "query": "<string>",
    "tickers": ["<string>"],
    "stock_ids": ["<string>"],
    "language": "<string>",
    "timezone": "<string>",
    "previous_summary": "<string>",
    "conversation_id": "<string>",
    "organization_id": "<string>",
    "user_id": "<string>",
    "user_email": "<string>",
    "user_name": "<string>"
}
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({
    query: '<string>',
    tickers: ['<string>'],
    stock_ids: ['<string>'],
    language: '<string>',
    timezone: '<string>',
    previous_summary: '<string>',
    conversation_id: '<string>',
    organization_id: '<string>',
    user_id: '<string>',
    user_email: '<string>',
    user_name: '<string>'
  })
};

fetch('https://api.linqalpha.com/v1/briefings/sse', 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/briefings/sse",
  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([
    'query' => '<string>',
    'tickers' => [
        '<string>'
    ],
    'stock_ids' => [
        '<string>'
    ],
    'language' => '<string>',
    'timezone' => '<string>',
    'previous_summary' => '<string>',
    'conversation_id' => '<string>',
    'organization_id' => '<string>',
    'user_id' => '<string>',
    'user_email' => '<string>',
    'user_name' => '<string>'
  ]),
  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/briefings/sse"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"language\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"previous_summary\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\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/briefings/sse")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"language\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"previous_summary\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.linqalpha.com/v1/briefings/sse")

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  \"query\": \"<string>\",\n  \"tickers\": [\n    \"<string>\"\n  ],\n  \"stock_ids\": [\n    \"<string>\"\n  ],\n  \"language\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"previous_summary\": \"<string>\",\n  \"conversation_id\": \"<string>\",\n  \"organization_id\": \"<string>\",\n  \"user_id\": \"<string>\",\n  \"user_email\": \"<string>\",\n  \"user_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "event_name": "status",
  "data": {
    "status": "start",
    "message": "Searching news"
  }
}

Generate a briefing on-demand from an ad-hoc prompt via Server-Sent Events streaming. The prompt (query) is run through the briefing engine — the same engine behind your scheduled briefings — so the output matches your scheduled briefing’s depth, formatting, and citations. Send a fresh prompt on each call.

Request

query (required) is your briefing prompt. All other fields are optional:

tickers / stock_ids — securities to scope the briefing to.
frequency — daily (default), weekly, or monthly; sets the data window (last 1 / 7 / 30 days, anchored at “now”).
timezone — IANA timezone (e.g. Asia/Shanghai) used for the window and timestamps. Defaults to UTC.
language — output language; auto-detected from the prompt when omitted.
previous_summary — the prior briefing’s content, to carry formatting/continuity across calls (optional).

Event Flow

status → [status]* → answer → status:finish

Progress status events stream while the briefing runs, followed by a single answer event carrying the full briefing markdown (with linked [N](url) citations), then status:finish. Read the content from the answer event’s answer_piece. The full content arrives once (not token-by-token), because inline citations are resolved only after the briefing completes. On failure, a single status event with status: "error" (carrying a code) is emitted instead of answer. This endpoint is stateless: each call generates a standalone briefing from the prompt you send.

Authentication

For platform API keys, pass organization_id, user_id, and user_email in the request body to select which user the briefing is generated for. Organization-bound keys resolve the user automatically.

Authorizations

X-API-KEY

string

header

required

Body

application/json

query

string

required

The ad-hoc briefing prompt (used as the briefing topic), run through the briefing engine

tickers

string[]

Optional ticker symbols to scope the briefing

stock_ids

string[]

Optional internal stock ids to scope the briefing

frequency

enum<string>

Data window (last 1 / 7 / 30 days, anchored at now). Defaults to daily.

Available options:

daily,

weekly,

monthly

language

string

Output language; auto-detected from the prompt when omitted

timezone

string

IANA timezone (e.g. Asia/Shanghai) for the window and timestamps. Defaults to UTC.

previous_summary

string

Prior briefing content, to carry continuity across calls (optional)

conversation_id

string | null

Deprecated and ignored; this endpoint is stateless

organization_id

string

Organization ID for platform API keys

user_id

string

User ID (customer_id) for platform API keys

user_email

string

User email for platform API keys

user_name

string

User name for platform API keys

Response

SSE stream of briefing events, each sent as data: {json}\n\n. Sequence: status → [status]* → answer → status:finish. A keepalive is sent as a status event roughly every 30s. On failure a single status event with status "error" (carrying a code) is emitted instead of answer. The answer arrives once (full content), not token-by-token, because inline citations are resolved only after the briefing completes.

Option 1
Option 2

Stream status event indicating start, finish, or keep_alive of the analytics stream.

event_name

enum<string>

required

Type of event in the analytics stream

Available options:

status

data

object

required

Event-specific data payload

Show child attributes

⌘I

MCP

Basic

Analytics V2

RMS (On request)

Briefing

Sync Status

Generate Briefing

Request

Event Flow

Authentication

Authorizations

Body

Response

​Request

​Event Flow

​Authentication

Authorizations

Body

Response

Request

Event Flow

Authentication