v1

latestOpenAPI 3.0.1Apache 2.02026-07-135212282.4 KB

memories

Add memories (V3)

Extract and store memories from a conversation using the V3 additive pipeline. Entity IDs (user_id / agent_id / run_id) are accepted at the top level. At least one entity ID is required so the memory is scoped to a session.

post/v3/memories/add/

Request body

user_idstring

Scope memories to this user.

agent_idstring

Scope memories to this agent.

run_idstring

Scope memories to this session / run.

metadataobject

User-supplied metadata to attach to each extracted memory.

expiration_datestring date nullable

Optional expiration date in YYYY-MM-DD format. After this date, memories are hidden from search and get-all unless show_expired is true.

custom_instructionsstring

Project-level instructions that guide extraction for this call.

custom_categoriesobject[]

Category catalog for this call. Replaces the project-level list rather than merging with it. Omit to fall back to the project list, then the default catalog.

inferboolean

When false, stores each message verbatim without running the extraction LLM.

Response

Memory addition queued; returns an event identifier clients can poll via GET /v1/event/{event_id}/.

messagestring

status'PENDING' | 'SUCCEEDED' | 'FAILED'

event_idstring uuid