Skip to main content

Memory SDK

Agent memory — episodic, semantic, procedural, entity, trust-weighted, temporal types with hash-chain provenance

Operations

Generated Reference

Overview

Agent memory — episodic, semantic, procedural, entity, trust-weighted, temporal types with hash-chain provenance

Available Operations

lucidAddEpisodicMemory

Store a conversation turn as episodic memory. Requires session_id, role, and content.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.MemoryWriteResponse>

Errors

lucidAddSemanticMemory

Store semantic memory (extracted fact)

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.MemoryWriteResponse>

Errors

lucidAddProceduralMemory

Store procedural memory (learned rule)

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.MemoryWriteResponse>

Errors

lucidAddEntityMemory

Store entity memory (knowledge graph node)

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.MemoryWriteResponse>

Errors

lucidAddTrustWeightedMemory

Store trust-weighted memory (cross-agent trust)

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.MemoryWriteResponse>

Errors

lucidAddTemporalMemory

Store temporal memory (time-bounded fact)

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.MemoryWriteResponse>

Errors

lucidRecallMemory

Two-stage recall: vector similarity search (if embeddings available) followed by metadata-aware reranking. Scoring: 0.55similarity + 0.20recency + 0.15type_bonus + 0.10quality.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<models.MemoryRecallResponse>

Errors

lucidCompactMemory

Tiered compaction: warm (archive old episodics), cold (hard-prune archived past retention). Self-healing: auto-compacts before rejecting writes when limits are exceeded.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidCompactMemoryResponse>

Errors

lucidMemoryHealth

Returns store type, entry/vector counts, embedding pipeline status, and store capabilities.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidMemoryHealthResponse>

Errors

lucidStartMemorySession

Start a new conversation session

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidStartMemorySessionResponse>

Errors

lucidListMemorySessions

List sessions for an agent

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidListMemorySessionsResponse>

Errors

lucidVerifyMemoryChain

Verify memory hash chain integrity

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidVerifyMemoryChainResponse>

Errors

lucidGetMemoryEntry

Retrieve a single memory entry by its unique identifier.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidGetMemoryEntryResponse>

Errors

lucidListMemoryEntries

List memory entries for an agent, optionally filtered by type and namespace. Supports pagination via page and per_page query parameters.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidListMemoryEntriesResponse>

Errors

lucidCloseMemorySession

Close an active memory session, preventing further writes.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidCloseMemorySessionResponse>

Errors

lucidGetMemorySessionContext

Retrieve the full context for a memory session, including recent turns, extracted facts, and relevant procedural rules.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidGetMemorySessionContextResponse>

Errors

lucidGetMemoryProvenanceChain

Return the full hash-chain provenance for a given agent and namespace, ordered from oldest to newest.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidGetMemoryProvenanceChainResponse>

Errors

lucidGetMemoryEntryProvenance

Retrieve the provenance record for a single memory entry.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidGetMemoryEntryProvenanceResponse>

Errors

lucidGetMemoryStats

Return memory statistics and diagnostics for a specific agent, including entry counts by type, storage usage, and hash chain integrity status.

Example Usage

Standalone function

The standalone function version of this method:

Parameters

Response

Promise<operations.LucidGetMemoryStatsResponse>

Errors