Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 167 additions & 86 deletions apps/docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -291,98 +291,179 @@
{
"anchor": "API reference",
"icon": "/icons/hugeicons/plug-socket.svg",
"openapi": "https://api.supermemory.ai/v4/openapi",
"pages": [
"api-reference/overview",
"authentication",
{
"group": "Ingest",
"icon": "/icons/hugeicons/download-01.svg",
"pages": [
"api-reference/ingest",
"POST /v3/documents",
"POST /v3/documents/file",
"POST /v3/documents/batch",
"POST /v4/conversations",
"GET /v3/documents/{id}"
]
},
{
"group": "Recall",
"icon": "/icons/hugeicons/search-01.svg",
"pages": [
"api-reference/search",
"POST /v4/search",
"POST /v3/search",
"api-reference/profiles",
"POST /v4/profile",
"POST /v4/profile/buckets"
]
},
{
"group": "Documents",
"icon": "/icons/hugeicons/file-02.svg",
"pages": [
"api-reference/documents",
"POST /v3/documents/list",
"GET /v3/documents/processing",
"PATCH /v3/documents/{id}",
"DELETE /v3/documents/{id}",
"DELETE /v3/documents/bulk",
"GET /v3/documents/{id}/chunks",
"GET /v3/documents/{id}/file-url"
]
},
{
"group": "Memories",
"icon": "/icons/hugeicons/database-01.svg",
"pages": [
"api-reference/memories",
"POST /v4/memories",
"POST /v4/memories/list",
"PATCH /v4/memories",
"DELETE /v4/memories",
"POST /v4/memories/forget-matching"
]
},
{
"group": "Container tags",
"icon": "/icons/hugeicons/tag-01.svg",
"pages": [
"api-reference/container-tags",
"GET /v3/container-tags/{containerTag}",
"PATCH /v3/container-tags/{containerTag}",
"DELETE /v3/container-tags/{containerTag}",
"POST /v3/container-tags/merge",
"GET /v3/container-tags/merge/{mergeId}"
]
},
"versions": [
{
"group": "Connections",
"icon": "/icons/hugeicons/plug-01.svg",
"version": "Legacy (V3, V4)",
"openapi": "https://api.supermemory.ai/v4/openapi",
"pages": [
"api-reference/connections",
"POST /v3/connections/{provider}",
"POST /v3/connections/list",
"GET /v3/connections/{connectionId}",
"POST /v3/connections/{connectionId}/configure",
"GET /v3/connections/{connectionId}/resources",
"POST /v3/connections/{provider}/import",
"POST /v3/connections/{provider}/documents",
"POST /v3/connections/{provider}/connection",
"DELETE /v3/connections/{connectionId}",
"DELETE /v3/connections/{provider}"
"api-reference/overview",
"authentication",
{
"group": "Ingest",
"icon": "/icons/hugeicons/download-01.svg",
"pages": [
"api-reference/ingest",
"POST /v3/documents",
"POST /v3/documents/file",
"POST /v3/documents/batch",
"POST /v4/conversations",
"GET /v3/documents/{id}"
]
},
{
"group": "Recall",
"icon": "/icons/hugeicons/search-01.svg",
"pages": [
"api-reference/search",
"POST /v4/search",
"POST /v3/search",
"api-reference/profiles",
"POST /v4/profile",
"POST /v4/profile/buckets"
]
},
{
"group": "Documents",
"icon": "/icons/hugeicons/file-02.svg",
"pages": [
"api-reference/documents",
"POST /v3/documents/list",
"GET /v3/documents/processing",
"PATCH /v3/documents/{id}",
"DELETE /v3/documents/{id}",
"DELETE /v3/documents/bulk",
"GET /v3/documents/{id}/chunks",
"GET /v3/documents/{id}/file-url"
]
},
{
"group": "Memories",
"icon": "/icons/hugeicons/database-01.svg",
"pages": [
"api-reference/memories",
"POST /v4/memories",
"POST /v4/memories/list",
"PATCH /v4/memories",
"DELETE /v4/memories",
"POST /v4/memories/forget-matching"
]
},
{
"group": "Container tags",
"icon": "/icons/hugeicons/tag-01.svg",
"pages": [
"api-reference/container-tags",
"GET /v3/container-tags/{containerTag}",
"PATCH /v3/container-tags/{containerTag}",
"DELETE /v3/container-tags/{containerTag}",
"POST /v3/container-tags/merge",
"GET /v3/container-tags/merge/{mergeId}"
]
},
{
"group": "Connections",
"icon": "/icons/hugeicons/plug-01.svg",
"pages": [
"api-reference/connections",
"POST /v3/connections/{provider}",
"POST /v3/connections/list",
"GET /v3/connections/{connectionId}",
"POST /v3/connections/{connectionId}/configure",
"GET /v3/connections/{connectionId}/resources",
"POST /v3/connections/{provider}/import",
"POST /v3/connections/{provider}/documents",
"POST /v3/connections/{provider}/connection",
"DELETE /v3/connections/{connectionId}",
"DELETE /v3/connections/{provider}"
]
},
{
"group": "Settings",
"icon": "/icons/hugeicons/settings-01.svg",
"pages": [
"api-reference/settings",
"GET /v3/settings",
"PATCH /v3/settings",
"POST /v3/settings/suggest-buckets",
"POST /v3/settings/reset"
]
}
]
},
{
"group": "Settings",
"icon": "/icons/hugeicons/settings-01.svg",
"version": "Latest (V5)",
"default": true,
"openapi": {
"source": "https://api.supermemory.ai/v5/openapi",
"directory": "v5/api-reference"
},
"pages": [
"api-reference/settings",
"GET /v3/settings",
"PATCH /v3/settings",
"POST /v3/settings/suggest-buckets",
"POST /v3/settings/reset"
"v5/api-reference/overview",
"authentication",
{
"group": "Ingest",
"icon": "download",
"pages": [
"v5/api-reference/ingest",
"POST /ns/{namespace}/document",
"POST /ns/{namespace}/document/batch",
"POST /ns/{namespace}/document/file",
"PATCH /ns/{namespace}/document/{id}",
"POST /ns/{namespace}/document/file/{id}",
"PATCH /ns/{namespace}/document/file/{id}"
]
},
{
"group": "Content Management",
"icon": "file-text",
"pages": [
"v5/api-reference/content-management",
"GET /ns/{namespace}/document/{id}",
"POST /ns/{namespace}/list/{type}",
"DELETE /ns/{namespace}/document",
"DELETE /ns/{namespace}/memories",
"DELETE /ns/{namespace}/memories/semantic"
]
},
{
"group": "Search",
"icon": "search",
"pages": [
"v5/api-reference/search",
"POST /ns/{namespace}/search"
]
},
{
"group": "Profiles",
"icon": "id-card",
"pages": [
"v5/api-reference/profiles",
"POST /ns/{namespace}/profile",
"GET /ns/{namespace}/profile/buckets",
"PUT /ns/{namespace}/profile/buckets",
"DELETE /ns/{namespace}/profile/buckets"
]
},
{
"group": "Namespaces",
"icon": "layers",
"pages": [
"v5/api-reference/namespaces",
"GET /namespaces",
"GET /ns/{namespace}",
"PATCH /ns/{namespace}",
"DELETE /ns/{namespace}"
]
},
{
"group": "Organization",
"icon": "building",
"pages": [
"v5/api-reference/organization",
"GET /organization",
"PATCH /organization"
]
}
]
}
]
Expand Down
18 changes: 18 additions & 0 deletions apps/docs/v5/api-reference/content-management.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "Content management"
sidebarTitle: "Overview"
description: "Retrieve, list, and remove documents, chunks, and memories"
icon: "file-text"
---

Inspect the context stored in a namespace and remove information that should no longer be used. Retrieve a document with its derived context, page through any resource type, or forget documents and memories precisely.

| Operation | Purpose |
| --- | --- |
| `GET /ns/{namespace}/document/{id}` | Retrieve source content with its chunks or memories |
| `POST /ns/{namespace}/list/{type}` | Page through documents, chunks, or memories |
| `DELETE /ns/{namespace}/document` | Remove one or many documents |
| `DELETE /ns/{namespace}/memories` | Forget reviewed memories by exact ID |
| `DELETE /ns/{namespace}/memories/semantic` | Find and forget memories by meaning |

Semantic forgetting supports `dryRun: true`, so you can review matches before deleting them. See [document read migration](/migration/api-v5-document-reads) and [memory migration](/migration/api-v5-recall).
21 changes: 21 additions & 0 deletions apps/docs/v5/api-reference/ingest.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Ingest"
sidebarTitle: "Overview"
description: "Turn source content into searchable memory and keep it current"
icon: "download"
---

Ingestion gives Supermemory the source material it uses to build searchable context and memories. Add new content or update an existing source without creating a disconnected copy.

| Operation | Purpose |
| --- | --- |
| `POST /ns/{namespace}/document` | Add text or a URL; reuse an ID to build on an existing document |
| `POST /ns/{namespace}/document/batch` | Bring in up to 600 documents together |
| `POST /ns/{namespace}/document/file` | Turn an uploaded file into searchable memory |
| `PATCH /ns/{namespace}/document/{id}` | Update metadata or replace canonical content |
| `POST /ns/{namespace}/document/file/{id}` | Completely replace a file-backed document |
| `PATCH /ns/{namespace}/document/file/{id}` | Refresh selected file details or its source |

The `dynamic` processing mode (default) groups related documents together so memories form from coherent, logical units rather than one isolated entry at a time. Use `instant` to process each document on its own right away; it bills one extra operation per document.

Every request is scoped to a namespace, keeping each user, project, or tenant isolated. See [document write migration](/migration/api-v5-document-writes).
17 changes: 17 additions & 0 deletions apps/docs/v5/api-reference/namespaces.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Namespaces"
sidebarTitle: "Overview"
description: "Keep memory isolated, understandable, and easy to reorganize"
icon: "layers"
---

| Operation | Purpose |
| --- | --- |
| `GET /namespaces` | Discover namespaces and see their memory footprint |
| `GET /ns/{namespace}` | See the context guiding one namespace |
| `PATCH /ns/{namespace}` | Give Supermemory better context for future memories |
| `DELETE /ns/{namespace}` | Retire a namespace or preserve its content elsewhere |

`GET /ns` is an alias for `GET /namespaces`. Profile buckets are managed through `/ns/{namespace}/profile/buckets`, not namespace settings.

See [namespace and settings migration](/migration/api-v5-settings).
15 changes: 15 additions & 0 deletions apps/docs/v5/api-reference/organization.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Organization"
sidebarTitle: "Overview"
description: "Give every namespace a shared understanding of your organization"
icon: "building"
---

| Operation | Purpose |
| --- | --- |
| `GET /organization` | See shared context and your namespace footprint |
| `PATCH /organization` | Improve the context guiding memory across the organization |

The public V5 shape intentionally excludes profile buckets, bucket suggestions, reset controls, and internal settings.

See [namespace and settings migration](/migration/api-v5-settings).
30 changes: 30 additions & 0 deletions apps/docs/v5/api-reference/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "API reference"
sidebarTitle: "Overview"
description: "Documents, search, profiles, lists, memories, namespaces, and organization settings in the latest Supermemory API"
icon: "book-open"
---

V5 makes namespace scope explicit in the URL and consolidates overlapping legacy operations.

```text
https://api.supermemory.ai
/ns/{namespace}/document
/ns/{namespace}/search
/ns/{namespace}/profile
/ns/{namespace}/list/{type}
/ns/{namespace}/memories
/namespaces
/organization
```

Use `/v5/reference` for the stable V5 reference. `/reference` always points to the latest public version.

<CardGroup cols={2}>
<Card title="Migrate to V5" icon="arrow-up-right" href="/migration/api-v5">
Translate every V3/V4 request and response deterministically.
</Card>
<Card title="Authentication" icon="key" href="/authentication">
Authenticate with the same bearer API keys used by legacy endpoints.
</Card>
</CardGroup>
17 changes: 17 additions & 0 deletions apps/docs/v5/api-reference/profiles.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Profiles"
sidebarTitle: "Overview"
description: "Turn accumulated memory into a ready-to-use understanding of a user"
icon: "id-card"
---

| Operation | Purpose |
| --- | --- |
| `POST /ns/{namespace}/profile` | Retrieve durable facts, recent context, and custom insights |
| `GET /ns/{namespace}/profile/buckets` | See the profile categories available here |
| `PUT /ns/{namespace}/profile/buckets` | Shape the profile with namespace-specific categories |
| `DELETE /ns/{namespace}/profile/buckets` | Remove namespace-specific categories |

Profiles always contain static and dynamic sections, giving applications both durable knowledge and fresh context without composing them manually. Organization-owned buckets may be inherited but cannot be changed through namespace bucket endpoints.

See [profile migration](/migration/api-v5-recall).
Loading
Loading