Skip to main content
PATCH
/
v0
/
memories
/
{memory_id}
Update selected fields of a memory.
curl --request PATCH \
  --url https://api.flumes.ai/v0/memories/{memory_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tags": [
    "<string>"
  ],
  "metadata": {},
  "archived": true,
  "valid_to": "2023-11-07T05:31:56Z",
  "status": "active"
}
'
{
  "namespace": "default",
  "type": "fact",
  "text": "<string>",
  "memory_id": "<string>",
  "org_id": "<string>",
  "agent_id": "<string>",
  "entity_id": "<string>",
  "metadata": {},
  "tags": [
    "<string>"
  ],
  "timestamp": "2023-11-07T05:31:56Z",
  "archived": false,
  "sensitivity": "auto",
  "subject": "<string>",
  "predicate": "<string>",
  "object": "<string>",
  "object_type": "literal",
  "unit": "<string>",
  "keys": [
    "<string>"
  ],
  "valid_from": "2023-11-07T05:31:56Z",
  "valid_to": "2023-11-07T05:31:56Z",
  "confidence": 0.5,
  "status": "active",
  "provenance": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-Flumes-Org
string

Deprecated. Org is derived from API key; header is ignored.

Maximum string length: 128

Path Parameters

​
memory_id
string
required

Body

application/json
​
tags
string[]
​
metadata
object
​
archived
boolean
​
valid_to
string<date-time>
​
status
enum<string>
Available options:
active,
superseded,
disputed

Response

Updated memory

Base memory record (open-world). Write requests ignore org fields; org is taken from header.

​
namespace
string
default:default
required
Maximum string length: 64
​
type
enum<string>
required
Available options:
fact,
event,
document,
note,
profile,
chunk
​
text
string
required

Human-readable content; for facts, this is a rendered form of subject/predicate/object.

Maximum string length: 20000
​
memory_id
string
​
org_id
string
​
agent_id
string | null
​
entity_id
string | null
​
metadata
object
​
tags
string[]
Maximum string length: 64
​
timestamp
string<date-time>
​
archived
boolean
default:false
​
sensitivity
enum<string>
default:auto
Available options:
none,
pii,
auto
​
subject
string | null

Entity id like ent:user_42

​
predicate
string | null
Maximum string length: 128
​
object
Maximum string length: 4000
​
object_type
enum<string> | null
Available options:
literal,
string,
number,
date,
json,
entity
​
unit
string | null
Maximum string length: 32
​
keys
string[] | null

Conflict keys for supersession.

Maximum string length: 128
​
valid_from
string<date-time> | null
​
valid_to
string<date-time> | null
​
confidence
number | null
Required range: 0 <= x <= 1
​
status
enum<string>
default:active
Available options:
active,
superseded,
disputed
​
provenance
object

Source info; e.g., { source_turn: memory_id }