API reference

Memory

What Rivier remembers: items, collections, the graph, and context for a question.

Scopes for this area: memory:read, memory:write and memory:admin.

76 operations

item

MethodRouteWhat it doesLevelCommand
GET/memory/itemsMemory items by scope, kind and state.readrivier memory item list
POST/memory/itemsRemember something.writerivier memory item create
GET/memory/items/{id}One memory item.readrivier memory item get
GET/memory/items/{id}/remoteWhether an item came from an agent's life, and what removing it did there: a lesson doubted, an episode that stays, or nothing sent.readrivier memory item remote
GET/memory/searchSearch memory by meaning.readrivier memory item search
GET/memory/reviewProposed items waiting for a person.readrivier memory item review
POST/memory/{id}/activateAccept a proposed item.writerivier memory item activate
POST/memory/{id}/expireExpire an item.writerivier memory item expire
POST/memory/{id}/deleteDelete an item.writerivier memory item delete
POST/memory/items/{id}/supersedeReplace an item with a corrected one.writerivier memory item supersede
POST/memory/reembedRe-embed stale items.writerivier memory item reembed
POST/memory/expireExpire items past their validity.writerivier memory item expire stale
GET/memory/items/{id}/conflictsOther live items that say the same thing or something close and differentreadrivier memory item conflicts

entity

MethodRouteWhat it doesLevelCommand
POST/memory/entitiesAdd or update an entity in the memory graph.writerivier memory entity upsert
GET/memory/entities/{id}/neighborsWhat an entity is connected to.readrivier memory entity neighbors
POST/memory/entities/resolveThe one person entity behind several identitieswriterivier memory entity resolve

edge

MethodRouteWhat it doesLevelCommand
POST/memory/edgesConnect two entities.writerivier memory edge create

memory ingest files derived

MethodRouteWhat it doesLevelCommand
DELETE/memory/ingest/files/{fileId}/derivedRemove memory ingest files derived (by id)writerivier memory memory ingest files derived remove
GET/memory/ingest/files/{fileId}/derivedRead memory ingest files derived (by id)readrivier memory memory ingest files derived get

memory items tags

MethodRouteWhat it doesLevelCommand
DELETE/memory/items/{id}/tags/{tagId}Remove memory items tags (by id)writerivier memory memory items tags remove
GET/memory/items/{id}/tagsRead memory items tags (by id)readrivier memory memory items tags get
POST/memory/items/{id}/tagsRun memory items tags (by id)writerivier memory memory items tags create

series

MethodRouteWhat it doesLevelCommand
DELETE/series/{id}Remove series (by id)writerivier memory series remove
GET/seriesRead seriesreadrivier memory series get
GET/series/{id}Read series (by id)readrivier memory series get2
POST/seriesRun serieswriterivier memory series create
POST/series/{id}/pointsRun series points (by id)writerivier memory series points

tags

MethodRouteWhat it doesLevelCommand
DELETE/tags/{id}Remove tags (by id)writerivier memory tags remove
GET/tagsRead tagsreadrivier memory tags get
GET/tags/{id}Read tags (by id)readrivier memory tags get2
PATCH/tags/{id}Change tags (by id)writerivier memory tags update
POST/tagsRun tagswriterivier memory tags create
POST/tags/{id}/mergeRun tags merge (by id)writerivier memory tags merge
POST/tags/bulkRun tags bulkwriterivier memory tags bulk
POST/tags/suggestRun tags suggestwriterivier memory tags suggest

tags rules

MethodRouteWhat it doesLevelCommand
DELETE/tags/rules/{id}Remove tags rules (by id)writerivier memory tags rules remove
GET/tags/rulesRead tags rulesreadrivier memory tags rules get
PUT/tags/rulesSet tags ruleswriterivier memory tags rules set

memory grants defaults

MethodRouteWhat it doesLevelCommand
GET/memory-grants/defaultsRead memory grants defaultsreadrivier memory memory grants defaults get

memory ingest files

MethodRouteWhat it doesLevelCommand
GET/memory/ingest/filesRead memory ingest filesreadrivier memory memory ingest files get

memory ingest folders

MethodRouteWhat it doesLevelCommand
GET/memory/ingest/folders/{collectionId}Read memory ingest folders (by id)readrivier memory memory ingest folders get
PUT/memory/ingest/folders/{collectionId}Set memory ingest folders (by id)writerivier memory memory ingest folders set

memory ingest runs

MethodRouteWhat it doesLevelCommand
GET/memory/ingest/runsRead memory ingest runsreadrivier memory memory ingest runs get
GET/memory/ingest/runs/{id}Read memory ingest runs (by id)readrivier memory memory ingest runs get2
POST/memory/ingest/runs/{id}/cancelRun memory ingest runs cancel (by id)writerivier memory memory ingest runs cancel
POST/memory/ingest/runs/{id}/decideRun memory ingest runs decide (by id)writerivier memory memory ingest runs decide
POST/memory/ingest/runs/{id}/reclassifyRun memory ingest runs reclassify (by id)writerivier memory memory ingest runs reclassify
POST/memory/ingest/runs/{id}/resumeRun memory ingest runs resume (by id)writerivier memory memory ingest runs resume

memory ingest settings

MethodRouteWhat it doesLevelCommand
GET/memory/ingest/settingsRead memory ingest settingsreadrivier memory memory ingest settings get
PUT/memory/ingest/settingsSet memory ingest settingswriterivier memory memory ingest settings set

series aggregate

MethodRouteWhat it doesLevelCommand
GET/series/{id}/aggregateRead series aggregate (by id)readrivier memory series aggregate get

series anomalies

MethodRouteWhat it doesLevelCommand
GET/series/{id}/anomaliesRead series anomalies (by id)readrivier memory series anomalies get

series compare

MethodRouteWhat it doesLevelCommand
GET/series/{id}/compareRead series compare (by id)readrivier memory series compare get

series latest

MethodRouteWhat it doesLevelCommand
GET/series/{id}/latestRead series latest (by id)readrivier memory series latest get

series points

MethodRouteWhat it doesLevelCommand
GET/series/{id}/pointsRead series points (by id)readrivier memory series points get

series operations

MethodRouteWhat it doesLevelCommand
GET/series/operationsRead series operationsreadrivier memory series operations get

memory ingest

MethodRouteWhat it doesLevelCommand
POST/memory/ingestRun memory ingestwriterivier memory memory ingest create
POST/memory/ingest/bulkRun memory ingest bulkwriterivier memory memory ingest bulk
POST/memory/ingest/statusRun memory ingest statusreadrivier memory memory ingest status

context

MethodRouteWhat it doesLevelCommand
POST/memory/contextContext for a question within a token budget, with citationsreadrivier memory context assemble
GET/memory/contextRecent context packs: what was assembled, for whom, and how muchreadrivier memory context list
GET/memory/context/{id}One context pack with the items as they are nowreadrivier memory context get

organisation context

MethodRouteWhat it doesLevelCommand
POST/memory/context/organisationContext across the organisation's projects the person can read, never an excluded onewriterivier memory organisation context assemble

graph

MethodRouteWhat it doesLevelCommand
POST/memory/graph/syncBring the memory graph up to date with orders, bookings and supplierswriterivier memory graph sync

collection

MethodRouteWhat it doesLevelCommand
GET/workspace/memoryThe memory collections.readrivier memory collection list
POST/workspace/memoryStart a memory collection.writerivier memory collection create
DELETE/workspace/memory/{id}Delete a collection.writerivier memory collection delete
GET/workspace/memory/{id}/sourcesWhat a collection was built from.readrivier memory collection sources
POST/workspace/memory/{id}/uploadAdd a document to a collection.writerivier memory collection upload
POST/workspace/memory/{id}/factWrite a fact into a collection.writerivier memory collection add fact
POST/workspace/memory/connectLet an agent use a collection.writerivier memory collection connect
POST/workspace/memory/disconnectStop an agent using a collection.writerivier memory collection disconnect
GET/workspace/memory/searchSearch the collections by meaning.readrivier memory collection search

source

MethodRouteWhat it doesLevelCommand
DELETE/workspace/memory/sources/{id}Remove a source from a collection.writerivier memory source delete