Summarize API
Summarize condenses either a block of free text or a symbol's current situation into a short list of key points. It is deterministic and model-free, so it answers offline.
What it returns
In text mode, the response returns mode:"text", a points array, and a count. Summarization is a deterministic extractive pass (salience approximated by sentence length), so it is reproducible.
In symbol mode it returns mode:"symbol", the symbol, available, and points that lead with the Market Brain read and add top risks and a study angle. Both modes carry the trust envelope.
When to use it
Pass text to condense a filing paragraph, note, or article into up to eight bullets. Pass symbol instead to get a few-line situational summary of a ticker. max_points defaults to 3 and is clamped to the range 1 to 8.
If you send neither field you get mode:"empty" with a hint to provide text or a symbol.
Notes and honesty
The text summarizer is intentionally deterministic and model-free so the endpoint works with no network or keys; an LLM-backed mode can plug in later behind the same contract. Symbol summaries inherit the sample-vs-live data mode of the underlying read. Educational only.
- mode: text, symbol, or empty
- points: the extracted or derived key points
- count: number of points (text mode)
- max_points: caller-controlled, clamped 1 to 8
- trust: sources, reasoning, data_mode, compliance
- available and provider in symbol mode
curl -s https://api.lyramindos.com/v1/summarize -H 'Content-Type: application/json' -H 'x-api-key: YOUR_KEY' -d '{"text":"Revenue rose on strong demand, though margins compressed on input costs.","max_points":2}'Questions
Does Summarize use an LLM?
No. The text mode is a deterministic extractive summary so it runs offline with no keys. An LLM-backed mode can slot in later behind the same request contract.
Can I summarize a ticker instead of text?
Yes. Send symbol instead of text and you get a few-line situational summary built from the Market Brain read, its top risks, and a study angle.
How many points can I get?
Set max_points from 1 to 8; values outside that range are clamped. The default is 3.