Skip to content

Memory

A Memory is a Worker’s own Collection of what it has learned and kept, read by its Functions.

Properties

Inherited from Collection: 1 property
PropertyTypeRequiredDescription
queryjsonThe saved query that defines a dynamic Collection.
Inherited from Thing: 4 properties
PropertyTypeRequiredDescription
idstringrequiredThe stable identifier, which never changes.
typelist of NounrequiredThe Nouns this Thing is an instance of.
statestringThe current state in its lifecycle.
outsidejsonThe ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.

Object

JSON
{
  "$id": "https://api.sb/shiftnote.app/memories/memory_1",
  "$type": "Memory",
  "id": "Example id",
  "type": [
    "noun_1"
  ],
  "state": "Example state",
  "outside": {},
  "query": {}
}

Relationships

Verbs

  1. createCreates a Memory.
    POST /{namespace}/memoriesdoMemory.created
  2. getReturns one Memory by id.
    GET /{namespace}/memories/{id}readNo Event
  3. listReturns Memories, newest first, one page at a time.
    GET /{namespace}/memoriesreadNo Event
  4. updateChanges the given properties of a Memory.
    PATCH /{namespace}/memories/{id}doMemory.updated
  5. deleteDeletes a Memory; its history is kept.
    DELETE /{namespace}/memories/{id}doMemory.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Memory.createYesYesYesNo
Memory.getYesYesYesYes
Memory.listYesYesYesYes
Memory.updateYesYesYesNo
Memory.deleteYesYesYesNo

Call it

Text
Add a memory to RouteWise with a noun.

Example

The Memory of Sienna, the Success Manager of a meal-planning App, holds that one household skips weekend dinners and dislikes cilantro. Her Functions read both before each suggestion.