API reference / Brain
Search the brain
Searches the workspace's brain by keyword and by meaning at once, and returns the best docs (interviews and research reports too) and sources with a snippet each. After them come up to 4 notes and records that the links of the first notes found bring (via). A person's search also finds their own private notes (private: true). Start here before answering anything about the business.
/api/v1/brain/searchOther ways to call it
troopy brain searchtroopy_search_brainQuery parameters
q*stringWhat to look for, in plain words
At least 1 characters · At most 500 characters
limitintegerResults, at most 50
Default 10 · At least 1 · At most 50
Response
200 · application/jsondata*array<object>12 properties
type*enum<string>docsource
id*stringA doc's slug, or a source's id
title*stringkind*stringsnippet*stringuri*string | nullscore*numberat*string | nullWhen it was last true by the brain's account: a doc's last change, a note's last confirmation
private*booleanOne of your own notes, kept out of the shared brain: keep it out of anything others read
originenum<string>A note: said by a person or learned in a conversation, read in a document (from names it), or inferred by the troop from other notes. Check an inferred note before you rely on it
persondocumentinferred
fromstringA note read in a document: the title of the document
viaobjectA hit that the search did not match, brought by a link of the hit with this id. related: close to it in meaning, or adds to it. A doc, a page or a file brings the docs, pages and files near it. premise: that hit was inferred from this one. inferred: this one was inferred from that hit. about: the record that that hit is about
2 properties
id*stringlink*enum<string>relatedpremiseinferredabout