Skip to main content

Installation

Quick Start

TypeScript

Constructor


Core Methods

add(messages, options?)

Add memories from a conversation. Extracts all 3 memory types.

addText(text, options?)

Add memories from plain text.

addFile(file, options?)

Upload a file and extract structured memories. Supports PDF (vision AI), DOCX, TXT, MD. Returns immediately with job_id.
Options: userId, agentId, runId, appId, filename (override filename for Blob inputs). File size limits: Free 10MB, Pro 50MB, Business 100MB.

search(query, options?)

Semantic search with re-ranking.

searchAll(query, options?)

Unified search across all 3 memory types.

getAll(options?) / getAllFull(options?)

get(name, options?) / delete(name, options?)

fixEntityType(name, newType, options?)

stats(options?) / graph(options?)


Cognitive Profile

getProfile(userId?, options?)

Generate a ready-to-use system prompt from memory.

Episodic Memory

episodes(options?)


Procedural Memory

procedures(options?)

procedureFeedback(id, options?)

procedureHistory(id) / procedureEvolution(id)


Timeline

timeline(options?)


Agents

runAgents(options?)

agentHistory(options?) / agentStatus(options?)


Insights & Reflections


Memory Management

feed(options?)


Webhooks


Teams


Smart Triggers


API Keys


Billing


Jobs


Import Data


Multi-User Isolation


Error Handling


Quota Usage

After any API call, check your current quota usage via the .quota property:
The quota is read from response headers (X-Quota-Add-Used, X-Quota-Add-Limit, X-Quota-Search-Used, X-Quota-Search-Limit) and reflects usage at the time of the last API call.