Skip to content
Engram Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Getting started
Overview
Quick start
Installation
Store your first memory
MCP client setup
Architecture
Overview
Memory model
Memory tiers
Deployment profiles
Vector store
Embeddings
Reindex & backfill
Auth & multi-tenancy
Consolidation & decay
How-to guides
Overview
Deploy to production
Back up and restore
Enable observability
Provision agent API keys
Import agent memory
Migrate lite to standard
Configure embeddings
Reindex embeddings
Enable authentication
Add an MCP tool
Write evaluations
Run a load test
Agent memory
Contract
Server
Clients
Sync
Migration
Reference
Overview
MCP Tools
MCP tools
bulk_delete_memories
cancel_reindex_job
compress_context
consolidate_corpus
consolidate_memories
create_memory
delete_memory
export_memories
forget
get_memory
get_memory_audit
get_reindex_status
import_agent_memory
ingest_conversation
list_memories
load_context
ping
promote_memory
prompt_context
queue_reindex_memories
recall
reembed_memory
reflect
reindex_memories
remember
restore_memory
retry_reindex_job
update_memory
Configuration
Configuration guide
Capacity & scaling
Concurrency policy
Observability
Release gates
Security
OWASP checklist
Review 2026-07-02
API
@engram/auth
Classes
FetchOAuthHttpClient
GitHubOAuthProvider
GoogleOAuthProvider
JwtError
JwtRevocationService
JwtService
OAuthExchangeError
OAuthService
RateLimitService
SessionService
Interfaces
AuthIdentity
AuthorizationUrlParams
ConsumeParams
ExchangeCodeParams
JwtClaims
JwtDenylistStore
JwtIssueInput
JwtServiceOptions
OAuthHttpClient
OAuthHttpResponse
OAuthProvider
OAuthProviderCredentials
OAuthStateData
OAuthUserProfile
RateLimitIncrementResult
RateLimitOptions
RateLimitResult
RateLimitRule
RateLimitStore
SessionData
SessionServiceOptions
SessionStore
Type Aliases
AuthMethod
JwtErrorCode
OAuthProviderName
@engram/client
Classes
EngramClient
Interfaces
ConversationTurn
EngramClientOptions
ForgetCandidate
ForgetInput
ForgetResult
IngestConversationInput
IngestConversationResult
LoadContextInput
LoadContextResult
MemoryRecord
PromptContextInput
PromptContextResult
RecallHit
RecallInput
RecallResult
ReflectInput
ReflectResult
RememberInput
RememberResult
Type Aliases
ConversationRole
@engram/config
Enumerations
DeploymentProfile
Interfaces
ProfileCapabilities
Type Aliases
Env
Variables
baseSchema
envSchema
Functions
coerceDeploymentProfile
resolveCapabilities
usesPgVector
validateEnv
@engram/core
Classes
LoggingModule
McpHandler
McpModule
Interfaces
ActingUserDecision
AuthPolicy
McpServerConfig
Tool
ToolCallContext
Type Aliases
McpServer
ServerInfo
ToolAuthMode
ToolInputJsonSchema
Variables
pingTool
REDACT_PATHS
VERSION
Functions
getVersion
registerTools
resolveActingUserId
zodToJsonSchema
@engram/database
Classes
MemoryNotFoundError
MemoryQuotaExceededError
MemoryValidationError
PrismaModule
PrismaService
Interfaces
ApiKey
CreateMemoryInput
Membership
Memory
Organization
PaginatedResult
UpdateMemoryInput
Type Aliases
ApiKeyScopeValues
CreateMemoryData
MembershipRoleValues
MemoryQueryOptions
MemoryTypeValues
SafeApiKey
UpdateMemoryData
Variables
apiKeyIdSchema
ApiKeyScope
apiKeyScopeSchema
createMemorySchema
cursorIdSchema
MembershipRole
memoryContentSchema
memoryIdSchema
memoryMetadataSchema
memoryQueryOptionsSchema
memoryTagsSchema
MemoryType
memoryTypeSchema
ttlSchema
updateMemorySchema
userIdSchema
Functions
validateCreateMemory
validateMemoryId
validateMemoryQueryOptions
validateTtl
validateUpdateMemory
validateUserId
@engram/embeddings
Classes
DisabledEmbeddingProvider
EmbeddingApiError
EmbeddingsModule
EmbeddingsService
EmbeddingValidationError
LocalEmbeddingProvider
OllamaEmbeddingProvider
OpenAIEmbeddingProvider
Interfaces
EmbeddingProvider
EmbeddingResult
EmbeddingRuntime
Type Aliases
EmbeddingModel
EmbeddingProviderName
GenerateEmbeddingInput
Variables
DEFAULT_EMBEDDING_PROVIDER
EMBEDDING_MODELS
EMBEDDING_PROVIDER_TOKEN
EMBEDDING_RUNTIME_TOKEN
MAX_TEXT_LENGTH
MODEL_DIMENSIONS
PROVIDER_DEFAULT_MODELS
Functions
resolveEmbeddingRuntime
@engram/eval
Interfaces
EmbeddingRetrieverOptions
EvalDataset
EvalDocument
EvalQuery
FusionRetrieverOptions
GateResult
GateThresholds
HarnessReport
LatencyBenchmarkOptions
LatencyBenchmarkResult
LatencyFixtureQuery
LatencyFixtureRecord
LatencySummary
LatencyTarget
LatencyThresholds
QueryResult
ReciprocalRankFusionOptions
VectorStoreLatencyTargetOptions
VectorStoreLike
Type Aliases
EmbedFunction
Retriever
Variables
DEFAULT_RRF_K
RECALL_GATE_THRESHOLDS
recallFixtures
Functions
buildRecallGateReport
cosineSimilarity
createEmbeddingRetriever
createFusionRetriever
createKeywordRetriever
createVectorStoreLatencyTarget
dcgAtK
evaluateGate
formatReport
mean
ndcgAtK
percentile
precisionAtK
recallAtK
reciprocalRank
reciprocalRankFusion
runHarness
runLatencyBenchmark
summarize
tokenize
@engram/memory-ltm
Classes
ContradictionDetectionService
CorpusConsolidationService
DuplicateDetectionService
ImportanceScoringService
IngestPipelineService
LtmDatabaseError
LtmMemoryNotFoundError
LtmMemoryQuotaExceededError
LtmPromotionError
MemoryLtmModule
MemoryLtmService
PrivacyFilterStep
TopicDetectorStep
Interfaces
ConsolidationClusterReport
ContradictionCandidate
ContradictionMatch
CorpusConsolidationOptions
CorpusConsolidationResult
CreateLtmMemoryData
DecayPolicyOptions
DecayPolicyResult
DuplicateDetectionMatch
ImportanceScoreResult
ImportanceSignals
IngestContext
LtmConfig
LtmMemory
LtmQueryOptions
PipelineStep
RankingWeights
ReindexOptions
ReindexProgress
ReindexResult
SemanticSearchOptions
SemanticSearchResult
UpdateLtmMemoryData
Type Aliases
ContradictionAction
ContradictionPolicy
CreateLtmMemoryValidated
LtmQueryOptionsValidated
UpdateLtmMemoryValidated
Variables
DEFAULT_CONSOLIDATION_MERGE_THRESHOLD
DEFAULT_CONTRADICTION_POLICY
DEFAULT_LTM_CONFIG
DEFAULT_RANKING_WEIGHTS
LTM_PROVIDER
MAX_CLUSTER_REPORTS
Functions
buildIngestContext
rankResults
validateCreateLtmMemory
validateLtmQueryOptions
validateUpdateLtmMemory
@engram/memory-stm
Classes
MemoryStmModule
PostgresStmAdapter
StmMemoryExpiredError
StmMemoryNotFoundError
StmTtlValidationError
StmVersionConflictError
Interfaces
CreateStmMemoryOptions
ListStmMemoryOptions
PaginatedResult
StmConfig
StmMemory
UpdateStmMemoryOptions
Type Aliases
CreateStmMemoryData
ListStmOptionsData
UpdateStmMemoryData
Variables
createStmMemorySchema
DEFAULT_STM_CONFIG
listStmOptionsSchema
STM_PROVIDER
updateStmMemorySchema
@engram/vector-store
Classes
PgVectorStore
VectorStoreModule
Interfaces
PgVectorClient
PgVectorOptions
VectorPayload
VectorRecord
VectorSearchFilter
VectorSearchResult
VectorStore
Type Aliases
VectorBackend
Variables
PGVECTOR_COLUMN
PGVECTOR_INDEX
PGVECTOR_TABLE
VECTOR_STORE_TOKEN
Functions
assertNonEmptyVector
Contributing
Overview
Development setup
Adding MCP tools
Testing conventions
Commit style
Roadmap
GitHub
Select theme
Dark
Light
Auto
userIdSchema
const
userIdSchema
:
ZodString
Defined in:
packages/database/src/types.ts:142