Active Entry Point
The latest version of the SDK leverages a unified client structure. Instead of managing multiple class instances, you perform all memory operations through theMemMachineClient using Metadata Scoping.
MemMachineClient (Primary)
The active class for all Episodic and Profile memory operations. Recommended for 100% of new integrations.
Quick Start
API Reference
Explore the detailed specifications for the SDK’s classes and data models.Interfaces & Types
These define the shape of your interactions and the data returned by the SDK. They are organized by the lifecycle of a typical implementation.1. Foundation (Context & Config)
1. Foundation (Context & Config)
The essential building blocks for connecting and scoping your requests.
- ClientOptions: Global client settings.
- ProjectContext: Organization and Project scoping.
- MemoryContext: User, Session, and Agent scoping.
2. Operations (Input Parameters)
2. Operations (Input Parameters)
Interfaces used to define the “How” of your SDK method calls.
- CreateProjectOptions: Setup for new projects.
- AddMemoryOptions: Parameters for ingesting data.
- SearchMemoriesOptions: Filtering and threshold logic.
- ListMemoriesOptions: Pagination and retrieval settings.
3. Data Models (Results & Units)
3. Data Models (Results & Units)
The structure of the data you receive back from the server.
- Project: Full project configuration data.
- AddMemoryResult: Confirmation and UIDs for new entries.
- SearchMemoriesResult: Ranked search results wrapper.
- EpisodicMemory: Individual interaction records.
- SemanticMemory: Extracted knowledge facts.
- HealthStatus: Server heartbeat and version info.
4. Vocabulary (Shared Types)
4. Vocabulary (Shared Types)
Contributing & Development
- Install Dependencies:
npm install - Build the Package:
npm run build - Run Unit Tests:
npm run test

