API reference / Brain
Add to the brain
Gives the brain text to learn from: a web page, a file's text, a note, or what a teammate did. It becomes searchable at once. Sending the same text again returns the existing source.
/api/v1/brain/sourcesOther ways to call it
troopy brain addtroopy_add_brain_sourceIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsonkind*enum<string>Where the text came from: a web page, an uploaded file, a note, or a teammate's run
webuploadnoterun
title*stringAt least 1 characters · At most 200 characters
text*stringThe text itself, at most 500,000 characters
At least 1 characters · At most 500000 characters
uristringWhere it came from (http or https), for web pages and files
At most 2000 characters · uri
Response
201 · application/jsondata*object16 properties
id*stringA 24-character id
kind*enum<string>Where the text came from: a web page, an uploaded file, a note, a teammate's run, or a canvas (its words, kept current by Troopy)
webuploadnoteruncanvas
title*stringuri*string | nullcreatedAt*stringISO 8601 date and time
by*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringprivate*booleanOne of your own notes: a fact about yourself you told a teammate in a chat you started. Kept out of the shared brain: no teammate reads it, and only you see it
saidBy*object | nullA note a teammate learned: the person who said it
2 properties
id*stringA 24-character id
name*stringconfirmations*integerHow many times the same note was said again
supersededBy*string | nullThe newer note that made this one untrue: it is out of search until restored
wrong*object | nullA person said this note is wrong (from a teammate's answer that relied on it): out of search until restored
3 properties
by*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringat*stringISO 8601 date and time
userId*stringA 24-character id
origin*object | nullA fact that a teammate read in a document: the doc or the source, its kind, and its title when the teammate read it
4 properties
type*enum<string>docsource
id*stringA 24-character id
kind*stringtitle*stringendedAt*string | nullA fact whose paragraph left its document, or whose time ended: out of search
challengedBy*string | nullA document says otherwise: the fact that says it. Still true? asks the person who said this note
derivedFrom*array<string> | nullA fact that the troop inferred: the notes that it follows from. It ends when one of them ends
duplicate*booleanTrue when this text was already in the brain