mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-09-30 01:51:28 +00:00
f55fe00e32
## Stack context This is the first PR in the V5 documentation stack. The migration guide and local-development wrapper build on it. ## What and why Add Legacy and Latest versions to the API Reference navigation, organize all V5 operations by user workflow, and introduce concise overview pages for each domain. The Latest reference consumes the authoritative `/v5/openapi` document published by the Mono API stack. ```mermaid flowchart LR Legacy[Legacy V3/V4 OpenAPI] --> Selector[Reference version selector] V5[V5 OpenAPI] --> Selector Selector --> Pages[Version-specific endpoint pages] ``` The `GET /ns` compatibility alias remains in the OpenAPI document but is intentionally omitted from navigation in favor of `GET /namespaces`. ## Validation - Parsed `docs.json` successfully with `jq`. - Compared navigation against the generated V5 schema: 22 displayed operations, 23 schema operations, with only `GET /ns` intentionally omitted. - Mintlify build validation passed against the local generated V5 OpenAPI snapshot. ## Deployment dependency The committed source is `https://api.supermemory.ai/v5/openapi`, which returns 404 until Mono PR #3306 and its API stack are deployed. Merge this PR after that endpoint is live.
21 lines
1.3 KiB
Text
21 lines
1.3 KiB
Text
---
|
|
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).
|