supermemory/apps/docs/memory-operations.mdx

---
title: "Memory Operations"
sidebarTitle: "Memories"
description: "Advanced memory operations (v4 API)"
icon: "database"
---

<Info>
These v4 endpoints operate on extracted memories (not raw documents). The SDK already covers the v4 read surface — `client.search.memories` and `client.profile` — while the memory create/update/forget endpoints on this page are called with fetch or cURL for now.

For document management (list, get, update, delete), see [Document Operations](/document-operations).
For ingesting raw content (text, files, URLs) through the processing pipeline, see [Add Context](/add-memories).
</Info>

## Create Memories

Create memories directly without going through the document ingestion workflow. Memories are embedded and immediately searchable.

This is useful for storing user preferences, traits, or any structured facts where you already know the exact memory content.

<Tabs>
  <Tab title="fetch">
    ```typescript
    const response = await fetch("https://api.supermemory.ai/v4/memories", {
      method: "POST",
      headers: {
        "Authorization": `Bearer ${API_KEY}`,
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        memories: [
          {
            content: "John prefers dark mode",
            isStatic: false,
            metadata: { source: "user_preference" }
          },
          {
            content: "John is from Seattle",
            isStatic: true
          }
        ],
        containerTag: "user_123"
      })
    });

    const data = await response.json();
    // {
    //   documentId: "abc123",
    //   memories: [
    //     { id: "mem_1", memory: "John prefers dark mode", isStatic: false, createdAt: "2025-..." },
    //     { id: "mem_2", memory: "John is from Seattle", isStatic: true, createdAt: "2025-..." }
    //   ]
    // }
    ```
  </Tab>
  <Tab title="cURL">
    ```bash
    curl -X POST "https://api.supermemory.ai/v4/memories" \
      -H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "memories": [
          {
            "content": "John prefers dark mode",
            "isStatic": false,
            "metadata": { "source": "user_preference" }
          },
          {
            "content": "John is from Seattle",
            "isStatic": true
          }
        ],
        "containerTag": "user_123"
      }'
    ```
  </Tab>
</Tabs>

### Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `memories` | array | yes | Array of memory objects (1–100 items) |
| `memories[].content` | string | yes | The memory text (max 10,000 chars). Should be entity-centric, e.g. "John prefers dark mode" |
| `memories[].isStatic` | boolean | no | `true` for permanent identity traits (name, hometown). Defaults to `false` |
| `memories[].metadata` | object | no | Key-value metadata (strings, numbers, booleans) |
| `containerTag` | string | yes | Space / container tag these memories belong to |

### Response

```json
{
  "documentId": "abc123",
  "memories": [
    {
      "id": "mem_1",
      "memory": "John prefers dark mode",
      "isStatic": false,
      "createdAt": "2025-01-15T10:30:00.000Z"
    }
  ]
}
```

| Field | Type | Description |
|-------|------|-------------|
| `documentId` | string \| null | ID of the lightweight source document created for traceability |
| `memories` | array | The created memory entries |
| `memories[].id` | string | Unique memory ID |
| `memories[].memory` | string | The memory content |
| `memories[].isStatic` | boolean | Whether this is a permanent trait |
| `memories[].createdAt` | string | ISO 8601 timestamp |

<Tip>
**When to use this vs [Add Context](/add-memories)?**

Use **Create Memories** when you already know the exact facts to store (user preferences, traits, structured data). Use **Add Context** when you have raw content (conversations, documents, URLs) that Supermemory should process and extract memories from.
</Tip>

---

## Forget Memory

Soft-delete a single memory — excluded from search results but preserved in the database. Identify it by `id` or by exact `content`, scoped to its `containerTag`.

<Tabs>
  <Tab title="fetch">
    ```typescript
    await fetch("https://api.supermemory.ai/v4/memories", {
      method: "DELETE",
      headers: {
        "Authorization": `Bearer ${API_KEY}`,
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        // Identify by ID or by exact content
        id: "mem_abc123",
        // content: "John prefers dark mode",
        containerTag: "user_123",
        reason: "outdated information"
      })
    });
    ```
  </Tab>
  <Tab title="cURL">
    ```bash
    curl -X DELETE "https://api.supermemory.ai/v4/memories" \
      -H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "id": "mem_abc123",
        "containerTag": "user_123",
        "reason": "outdated information"
      }'
    ```
  </Tab>
</Tabs>

### Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | * | Memory ID to forget |
| `content` | string | * | Exact content match to forget (alternative to ID) |
| `containerTag` | string | yes | Container tag / space the memory belongs to |
| `reason` | string | no | Optional reason recorded as `forgetReason` |

\* Either `id` or `content` must be provided.

The memory will no longer appear in search results but remains in the database (`isForgotten=true`).

---

## Forget Matching

Forget **everything** about a topic in one call. You give a prompt or a query; the service semantically searches the container's memories, an LLM decides which ones are genuinely about your target, and those are soft-deleted. Use this for "forget everything about X" rather than deleting memories one by one.

<Warning>
This is a bulk, destructive operation. Always **`dryRun` first** to review what would be forgotten, then re-run with `dryRun: false`. The match is semantic, so a too-broad query can select more than you intend — `threshold` and `maxForget` bound the blast radius.
</Warning>

<Tabs>
  <Tab title="fetch">
    ```typescript
    // 1) Preview
    const preview = await fetch("https://api.supermemory.ai/v4/memories/forget-matching", {
      method: "POST",
      headers: {
        "Authorization": `Bearer ${API_KEY}`,
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        query: "forget everything about Project Titan",
        containerTag: "user_123",
        dryRun: true
      })
    }).then((r) => r.json());
    // preview.candidates → [{ id, memory, score }, ...]

    // 2) Apply
    const result = await fetch("https://api.supermemory.ai/v4/memories/forget-matching", {
      method: "POST",
      headers: {
        "Authorization": `Bearer ${API_KEY}`,
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        query: "forget everything about Project Titan",
        containerTag: "user_123",
        dryRun: false,
        reason: "project cancelled"
      })
    }).then((r) => r.json());
    // result.forgotten → [{ id, memory, score }, ...]
    // result.forgetBatchId → tagged on every forgotten memory for traceability
    ```
  </Tab>
  <Tab title="cURL">
    ```bash
    # Preview
    curl -X POST "https://api.supermemory.ai/v4/memories/forget-matching" \
      -H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "query": "forget everything about Project Titan",
        "containerTag": "user_123",
        "dryRun": true
      }'

    # Apply
    curl -X POST "https://api.supermemory.ai/v4/memories/forget-matching" \
      -H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "query": "forget everything about Project Titan",
        "containerTag": "user_123",
        "dryRun": false,
        "reason": "project cancelled"
      }'
    ```
  </Tab>
</Tabs>

### Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | yes | What to forget — a natural-language instruction ("forget everything about Project Titan") or a bare topic ("Project Titan") |
| `containerTag` | string | yes | Container tag / space to scope the operation to |
| `dryRun` | boolean | no | When `true`, returns what *would* be forgotten without changing anything. Defaults to `false` |
| `threshold` | number | no | Similarity floor (0–1) for candidate memories. Lower casts a wider net. Defaults to `0.5` |
| `maxForget` | number | no | Safety cap on how many memories may be forgotten in one call (1–500). Defaults to `100` |
| `reason` | string | no | Reason recorded as `forgetReason` on each forgotten memory |

### Response

```json
{
  "dryRun": false,
  "count": 3,
  "forgetBatchId": "VcuQoGRz4hA4ak5Xu6DRUN",
  "summary": "Forgot 3 memories about \"Project Titan\".",
  "forgotten": [
    { "id": "mem_1", "memory": "Project Titan ships in Q3", "score": 0.82 }
  ]
}
```

| Field | Type | Description |
|-------|------|-------------|
| `dryRun` | boolean | Whether this was a preview or a real forget |
| `count` | number | Number of memories selected (dryRun) or forgotten (apply) |
| `forgetBatchId` | string \| null | ID tagged on every memory forgotten in this call; `null` on dryRun |
| `summary` | string | One-line summary of the operation (e.g. `Forgot 3 memories about "Project Titan".`) |
| `candidates` | array | On `dryRun`: the memories that **would** be forgotten (`{ id, memory, score }`) |
| `forgotten` | array | On apply: the memories that **were** forgotten (`{ id, memory, score }`) |

<Note>
Identity is server-owned: the LLM only ever references opaque handles for the memories a search returned, so it can never forget a memory outside the results it reviewed, and every operation is scoped to the `containerTag` you pass.
</Note>

---

## Update Memory (Versioned)

Update a memory by creating a new version. The original is preserved with `isLatest=false`.

<Tabs>
  <Tab title="fetch">
    ```typescript
    await fetch("https://api.supermemory.ai/v4/memories", {
      method: "PATCH",
      headers: {
        "Authorization": `Bearer ${API_KEY}`,
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        // Identify by ID or content
        id: "mem_abc123",
        // content: "Original content to match",

        newContent: "Updated content goes here",
        metadata: {
          tags: ["updated"]
        }
      })
    });
    ```
  </Tab>
  <Tab title="cURL">
    ```bash
    curl -X PATCH "https://api.supermemory.ai/v4/memories" \
      -H "Authorization: Bearer $SUPERMEMORY_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "id": "mem_abc123",
        "newContent": "Updated content goes here",
        "metadata": {"tags": ["updated"]}
      }'
    ```
  </Tab>
</Tabs>

### Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | * | Memory ID to update |
| `content` | string | * | Original content to match (alternative to ID) |
| `newContent` | string | yes | New content for the memory |
| `metadata` | object | no | Updated metadata |

\* Either `id` or `content` must be provided.

---

## Next Steps

- [Review Inferred Memories](/memory-review) — Approve or decline low-confidence memories
- [Document Operations](/document-operations) — Manage documents (SDK supported)
- [Search](/search) — Query your memories
- [Ingesting Content](/add-memories) — Add new content