The memory area has 14 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).
memoryConfirm
Confirm a memory
- Request:
POSTon/v1/tenants/{tenantId}/memory/{memoryId}/confirm
memoryConfirm(args: { tenantId: string; memoryId: string; body: MemoryConfirmRequest }, options?: CallOptions): Promise<MemoryItem>memoryCreate
Write a memory candidate
- Request:
POSTon/v1/tenants/{tenantId}/memory
memoryCreate(args: { tenantId: string; body: MemoryCandidate }, options?: CallOptions): Promise<MemoryWriteResponse>memoryDelete
Delete one memory (deletion class)
- Request:
DELETEon/v1/tenants/{tenantId}/memory/{memoryId}
memoryDelete(args: { tenantId: string; memoryId: string }, options?: CallOptions): Promise<MemoryDeleteResponse>memoryExport
Export every memory the caller can see
- Request:
GETon/v1/tenants/{tenantId}/memory/export
memoryExport(args: { tenantId: string; query?: { scope?: string; projectId?: string; userId?: string } }, options?: CallOptions): Promise<MemoryExportRecord>memoryGet
Read one memory
- Request:
GETon/v1/tenants/{tenantId}/memory/{memoryId}
memoryGet(args: { tenantId: string; memoryId: string }, options?: CallOptions): Promise<Record<string, unknown>>memoryList
List memories
- Request:
GETon/v1/tenants/{tenantId}/memory
memoryList(args: { tenantId: string; query?: { scope?: string; status?: string; projectId?: string; limit?: string } }, options?: CallOptions): Promise<MemoryListResponse>memoryPromote
Promote a memory to a wider scope (memory promotion class)
- Request:
POSTon/v1/tenants/{tenantId}/memory/{memoryId}/promote
memoryPromote(args: { tenantId: string; memoryId: string; body: MemoryPromoteRequest }, options?: CallOptions): Promise<MemoryPromoteResponse>memoryPurge
Delete memories by subject (export and deletion rights)
- Request:
POSTon/v1/tenants/{tenantId}/memory/purge
memoryPurge(args: { tenantId: string; body: MemoryPurgeRequest }, options?: CallOptions): Promise<MemoryDeleteResponse>memorySearch
Search memories across scopes, in precedence order
- Request:
GETon/v1/memory/search
memorySearch(args?: { query?: { q?: string; scopes?: string; projectId?: string; status?: string; limit?: string; maxTokens?: string; format?: string } }, options?: CallOptions): Promise<MemorySearchResponse>memorySettingsGet
Read the team’s memory settings
- Request:
GETon/v1/tenants/{tenantId}/memory/settings
memorySettingsGet(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>memorySettingsPut
Change the team’s memory settings (policy class)
- Request:
PUTon/v1/tenants/{tenantId}/memory/settings - Needs an approval for agents: class
policy_change
memorySettingsPut(args: { tenantId: string; body: MemorySettingsRequest }, options?: CallOptions): Promise<MemorySettings>memoryStatus
Memory counts and inference mode
- Request:
GETon/v1/tenants/{tenantId}/memory/status
memoryStatus(args: { tenantId: string }, options?: CallOptions): Promise<MemoryStatusResponse>memorySymbols
Link memories to code symbols
- Request:
POSTon/v1/tenants/{tenantId}/memory/symbols
memorySymbols(args: { tenantId: string; body: MemorySymbolChangeRequest }, options?: CallOptions): Promise<Record<string, unknown>>memoryUnlearn
Unlearn a memory
- Request:
POSTon/v1/tenants/{tenantId}/memory/{memoryId}/unlearn
memoryUnlearn(args: { tenantId: string; memoryId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<MemoryUnlearnRecord>