Skip to content

API Reference ​

Quick Overview ​

typescript
import { createMnemo } from '@mnemoai/core';

const mnemo = await createMnemo(config);

await mnemo.store({ text: '...', category: 'fact' });
const results = await mnemo.recall('query');
await mnemo.delete('memory-id');
const stats = await mnemo.stats();
await mnemo.close();

Methods ​

MethodDescription
createMnemo(config)Create a Mnemo instance
mnemo.store(entry)Store a memory
mnemo.recall(query, options?)Recall memories by semantic search
mnemo.delete(id)Delete a memory
mnemo.stats()Get memory statistics
mnemo.close()Close and release resources

Types ​

TypeDescription
MnemoConfigConfiguration for createMnemo()
MnemoInstanceThe instance returned by createMnemo()
MemoryCategoryUnion type for memory categories
StorageBackendUnion type for storage backends

Advanced Exports ​

For advanced use cases, the package also exports:

typescript
import { MemoryStore } from '@mnemoai/core';           // Low-level store
import { registerAdapter } from '@mnemoai/core';        // Custom backends
import { log, setLogger } from '@mnemoai/core';         // Logger
import type { StorageAdapter } from '@mnemoai/core';    // Adapter interface

Released under the MIT License.