memory
List Memories
List the notes this organization's agents have made, newest first, filtered by
agent, scope, the person (contact_key, read the way a person types it) or the
line that produced them (line_id, which opens a line's notes). Use when
showing what an agent remembers, before correcting or deleting a note.
Changes nothing.
A person's note is listed only to someone who may read the conversation it was learned in; the business notes are listed to whoever reaches memory.
query Parameters
agent_idscopecontact_keyline_idlimitoffsetList Memories › Responses
Successful Response
agent_idcontentcreated_atidlooks_personalorg_idpinnedredactedscopeWhich layer a memory lives in. The retrieval side pulls the relevant layer(s) into context; the write side must respect the PII boundary.
support_countupdated_atList Memory Lines
List what this agent's memory is told to notice: its lines, oldest first, each saying whether it is about every person or about the business and how many notes it has produced, beside the bounds the notebook keeps -- lines, a line's length, the notes reread at the start of a conversation and those that may be remembered always. Use when showing what the agent is told to notice, before adding, rewording or removing a line. Listed whether memory is on or off.
path Parameters
agent_idList Memory Lines › Responses
Successful Response
The notebook's bounds as the interface prints them (rule 27): lines, a line's length, the notes reread from each layer and the business notes that may be marked "remember always". The same numbers recall and the writes enforce.
Create Memory Line
Tell the agent's memory what to notice: a line in your own words, about every person or about the business. Use when the agent should start paying attention to something it does not already notice. It applies to what is noted from now on; conversations already noted are never gone back over. A line never makes the agent ask anything -- asking belongs in its instructions. Refused, naming the bound, when the agent already follows as many lines as it may, and with 403 for the platform's own agents (the Architect, the Analyst), whose memory is not the client's to steer.
path Parameters
agent_idCreate Memory Line › Request Body
aboutWhom a line asks the agent to notice something about (rule 19): the person in each conversation, or the business. It decides where the note is filed under rule 2 -- a line about a person produces notes about that person, one about the business produces business notes.
wordsCreate Memory Line › Responses
Successful Response
aboutWhom a line asks the agent to notice something about (rule 19): the person in each conversation, or the business. It decides where the note is filed under rule 2 -- a line about a person produces notes about that person, one about the business produces business notes.
agent_idcreated_atidnotesupdated_atwordsDelete Memory Line
Remove a line at once. Use when the agent should stop noticing something altogether. None of the notes it produced is deleted -- each keeps the words that produced it. If the Analyst counts the line, its question and answers are deleted with it.
path Parameters
agent_idline_idDelete Memory Line › Responses
Successful Response
Update Memory Line
Reword a line or move it between every person and the business. Use when an existing line's wording or scope is wrong and should change going forward. It applies to what is noted from then on and goes back over nothing. Refused while the Analyst counts the line: a counted line keeps its words and whom it is about.
path Parameters
agent_idline_idUpdate Memory Line › Request Body
Update Memory Line › Responses
Successful Response
aboutWhom a line asks the agent to notice something about (rule 19): the person in each conversation, or the business. It decides where the note is filed under rule 2 -- a line about a person produces notes about that person, one about the business produces business notes.
agent_idcreated_atidnotesupdated_atwordsList Memory People
List everyone this agent has notes about, most recently learned first, each by
the number or address their notes are keyed to, with how many notes and how many
sensitive numbers were replaced in them. Use when showing who an agent remembers,
before opening one person's sheet or forgetting them. Changes nothing. q finds
a person by part of their number or address or by a word their notes hold.
A person is listed only to
someone who may read the conversation one of their notes was learned in, and
counts only the notes that reader may read. A person a record of your Databases is
tied to by their number is shown with that record's label, if you may read records;
memory keeps no name of its own.
path Parameters
agent_idquery Parameters
qPart of a number or address, or a word one of their notes holds.
Part of a number or address, or a word one of their notes holds.
limitoffsetList Memory People › Responses
Successful Response
contact_keylast_learned_atnotesredactedGet Memory Person
Read a person's sheet: every note this agent has about them that you may read, whole, each with the line that produced it and the conversation it was learned in. Use when opening one person's full notes by their contact key. Changes nothing. Not found when none of their notes is one you may read. A person a record of your Databases is tied to by their number is shown with that record's label, if you may read records, as in the list.
path Parameters
agent_idcontact_keyGet Memory Person › Responses
Successful Response
Forget Person
Forget a person: delete every note this agent has about them at once, the ones
you may not read included. Use when one agent's notes about a person should be
wiped, not every agent's — wipe_contact is the broader act. Their conversations
stay, and so do other agents' notes
about them; those go with their record. contact_key is the exact stored key.
Not found unless one of their notes is one you may read. This cannot be undone.
path Parameters
agent_idcontact_keyForget Person › Responses
Successful Response
Get Memory Switch
Whether one agent remembers: its memory switch, on until somebody turns it off. Use when showing the switch's state before offering to flip it. Changes nothing. This is the agent's own switch; memory also needs the organization to be entitled to it, which a person who can reach this route is.
path Parameters
agent_idGet Memory Switch › Responses
Successful Response
agent_idonSet Memory Switch
Turn one agent's memory on or off. Use when memory should start or stop being used by this agent. It takes effect on the agent's next conversation, and turning it off deletes nothing it learned: the facts stay listed and can still be corrected or deleted. What is said while it is off is never learned afterwards. Refused with 403 for the platform's own agents (the Architect, the Analyst), whose memory follows the organization's plan alone.
path Parameters
agent_idSet Memory Switch › Request Body
onSet Memory Switch › Responses
Successful Response
agent_idonWipe Contact
Wipe a caller's per-contact memory (all of the org's agents, or one). Use when a person asks to be forgotten and every note about them should go, not just one agent's sheet.
path Parameters
contact_keyquery Parameters
agent_idWipe Contact › Responses
Successful Response
Get Conversation Memory
Read what the agent's memory knew when a conversation started -- the notes reread into it, as they were then -- and what it noted from it, as they are now. Use when explaining why an agent said or noted what it did in one conversation. Changes nothing. Not found unless you may read the conversation. A person's note appears only when you may read the conversation it was learned in.
path Parameters
interaction_idGet Conversation Memory › Responses
Successful Response
interaction_idkeptnoted_goneRecall Memories
Recall what an agent remembers about a question, from one memory layer. Use when the agent needs to look up a remembered fact before answering, rather than guessing or asking again.
Ask for the layer you want by scope: agent_global for what the agent has
learned in general, per_contact with the contact_key for what it knows
about one person, per_session with the session_key for a conversation's
working notes. Results are ranked by how close they are to query and never
reach outside the organization or the layer asked for.
Recall Memories › Request Body
agent_idscopeWhich layer a memory lives in. The retrieval side pulls the relevant layer(s) into context; the write side must respect the PII boundary.
limitqueryRecall Memories › Responses
Successful Response
agent_idcontentcreated_atidlooks_personalorg_idpinnedredactedscopeWhich layer a memory lives in. The retrieval side pulls the relevant layer(s) into context; the write side must respect the PII boundary.
support_countupdated_atGet Memory
Read one note. Use when opening a specific note by id. Changes nothing. A person's note nobody asking may read is not found.
path Parameters
memory_idGet Memory › Responses
Successful Response
agent_idcontentcreated_atidlooks_personalorg_idpinnedredactedscopeWhich layer a memory lives in. The retrieval side pulls the relevant layer(s) into context; the write side must respect the PII boundary.
support_countupdated_atPatch Memory
Correct the wording of one note, and/or mark a business note to remember always. Use when a stored note is wrong and needs fixing, or a business note should survive forever. A person's note may be corrected, by someone who may read the conversation it was learned in, and is never marked; a per-session note is not edited here. A sixth business note marked is refused, naming the bound.
A correction is what the agent rereads from then on: the note is re-embedded
with the same embedder recall uses, so it ranks by its new meaning at once,
and any sensitive number in it is replaced. A mark alone never calls the
embedder.
path Parameters
memory_idPatch Memory › Request Body
Patch Memory › Responses
Successful Response
agent_idcontentcreated_atidlooks_personalorg_idpinnedredactedscopeWhich layer a memory lives in. The retrieval side pulls the relevant layer(s) into context; the write side must respect the PII boundary.
support_countupdated_at