---
title: "SDK: memory"
description: "The memory methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK: memory

{/* Generated by apps/docs/scripts/generate.mjs (SDK pages from the TypeScript types in packages/sdk). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

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](/sdk/)).

## memoryConfirm

Confirm a memory

- Request: `POST` on `/v1/tenants/{tenantId}/memory/{memoryId}/confirm`

```ts
memoryConfirm(args: { tenantId: string; memoryId: string; body: MemoryConfirmRequest }, options?: CallOptions): Promise<MemoryItem>
```

## memoryCreate

Write a memory candidate

- Request: `POST` on `/v1/tenants/{tenantId}/memory`

```ts
memoryCreate(args: { tenantId: string; body: MemoryCandidate }, options?: CallOptions): Promise<MemoryWriteResponse>
```

## memoryDelete

Delete one memory (deletion class)

- Request: `DELETE` on `/v1/tenants/{tenantId}/memory/{memoryId}`

```ts
memoryDelete(args: { tenantId: string; memoryId: string }, options?: CallOptions): Promise<MemoryDeleteResponse>
```

## memoryExport

Export every memory the caller can see

- Request: `GET` on `/v1/tenants/{tenantId}/memory/export`

```ts
memoryExport(args: { tenantId: string; query?: { scope?: string; projectId?: string; userId?: string } }, options?: CallOptions): Promise<MemoryExportRecord>
```

## memoryGet

Read one memory

- Request: `GET` on `/v1/tenants/{tenantId}/memory/{memoryId}`

```ts
memoryGet(args: { tenantId: string; memoryId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## memoryList

List memories

- Request: `GET` on `/v1/tenants/{tenantId}/memory`

```ts
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: `POST` on `/v1/tenants/{tenantId}/memory/{memoryId}/promote`

```ts
memoryPromote(args: { tenantId: string; memoryId: string; body: MemoryPromoteRequest }, options?: CallOptions): Promise<MemoryPromoteResponse>
```

## memoryPurge

Delete memories by subject (export and deletion rights)

- Request: `POST` on `/v1/tenants/{tenantId}/memory/purge`

```ts
memoryPurge(args: { tenantId: string; body: MemoryPurgeRequest }, options?: CallOptions): Promise<MemoryDeleteResponse>
```

## memorySearch

Search memories across scopes, in precedence order

- Request: `GET` on `/v1/memory/search`

```ts
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: `GET` on `/v1/tenants/{tenantId}/memory/settings`

```ts
memorySettingsGet(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## memorySettingsPut

Change the team's memory settings (policy class)

- Request: `PUT` on `/v1/tenants/{tenantId}/memory/settings`
- Needs an approval for agents: class `policy_change`

```ts
memorySettingsPut(args: { tenantId: string; body: MemorySettingsRequest }, options?: CallOptions): Promise<MemorySettings>
```

## memoryStatus

Memory counts and inference mode

- Request: `GET` on `/v1/tenants/{tenantId}/memory/status`

```ts
memoryStatus(args: { tenantId: string }, options?: CallOptions): Promise<MemoryStatusResponse>
```

## memorySymbols

Link memories to code symbols

- Request: `POST` on `/v1/tenants/{tenantId}/memory/symbols`

```ts
memorySymbols(args: { tenantId: string; body: MemorySymbolChangeRequest }, options?: CallOptions): Promise<Record<string, unknown>>
```

## memoryUnlearn

Unlearn a memory

- Request: `POST` on `/v1/tenants/{tenantId}/memory/{memoryId}/unlearn`

```ts
memoryUnlearn(args: { tenantId: string; memoryId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<MemoryUnlearnRecord>
```

Source: https://docs.overlane.app/sdk/memory/index.mdx