supermemory/apps/docs
sohamd22 4347970d16 docs(api): align v5 ingestion and document operations docs with the API (#1810)
Fixes v5 ingestion and document-operation docs.

- **Query params return `400`.** `dreaming`, `fileType` and `mimeType` were documented as query params; they are JSON body or multipart form fields.
- **Errors.** Out-of-balance quota is `402`, not `429`; `429` is only rate limiting. Added the `409` returned during a namespace merge.
- **Statuses.** There is no `processing` status. The real ones are queued, extracting, chunking, embedding, done and failed; treat anything else as in progress.
- **`group` on updates.** `group` is ingestion-side: it picks which existing memories serve as context while content is processed. Changing it only takes effect on re-ingestion, so it's sent with `content`/`file`. The "group-only PATCH" claims are removed from the migration doc.
- **Lists, deletes and forget:**
  - Valid `sort` values per type, a `limit` max of 100, and `include.forgotten`.
  - Deletes skip documents that are still processing.
  - Forget-matching has a 100-match cap and a 2000-character `query` limit.
- **Failed documents stay `failed`.** The docs said they're deleted after 2 minutes. They actually stay `failed`, and resending the same `id` reprocesses them.
- **Smaller fixes:**
  - Metadata allows `string[]`.
  - The batch response field is `count`.
  - `audio` is a valid `fileType`.
  - Chunk overlap is 200 characters.
  - URL extraction no longer claims Markdowner.
  - Search examples no longer index the response object as an array.

Checked against the current API and the published SDKs (TS 5.0.1, Python 5.0.0). Legacy v3/v4 docs are unchanged apart from factual fixes.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
2026-10-15 18:52:40 +00:00
..
.cursor/rules migrate docs to public 2025-09-28 16:42:06 -07:00
api-reference docs: move SDK snippets to the shipped v5 call shape and finish the namespace rename (#1772) 2026-10-06 17:06:38 +00:00
concepts docs(api): align v5 ingestion and document operations docs with the API (#1810) 2026-10-15 18:52:40 +00:00
connectors docs: move SDK snippets to the shipped v5 call shape and finish the namespace rename (#1772) 2026-10-06 17:06:38 +00:00
icons/hugeicons docs: refresh the documentation design (#1715) 2026-09-29 17:26:13 -07:00
images docs: add team invitation guide with console screenshots (#1754) 2026-10-02 16:59:55 -07:00
ingestion docs(api): align v5 ingestion and document operations docs with the API (#1810) 2026-10-15 18:52:40 +00:00
integrations fix(python): community fixes for the openai, cartesia and pipecat wrappers (#1799) 2026-10-14 21:08:38 +00:00
logo docs: refresh the documentation design (#1715) 2026-09-29 17:26:13 -07:00
memorybench docs: refresh the documentation design (#1715) 2026-09-29 17:26:13 -07:00
migration docs: one-line migrate tip on every v5 entry point (#1779) 2026-10-06 21:22:40 +00:00
overview docs: move SDK snippets to the shipped v5 call shape and finish the namespace rename (#1772) 2026-10-06 17:06:38 +00:00
recall docs(api): align v5 ingestion and document operations docs with the API (#1810) 2026-10-15 18:52:40 +00:00
scripts docs(api): add V3/V4 to V5 migration guide (#1691) 2026-10-06 16:48:36 +00:00
self-hosting docs: community fixes for self-hosting, contributing and the sidebar (#1802) 2026-10-13 04:41:23 +00:00
smfs docs: refresh the documentation design (#1715) 2026-09-29 17:26:13 -07:00
snippets docs(api): align v5 ingestion and document operations docs with the API (#1810) 2026-10-15 18:52:40 +00:00
supermemory-mcp fix(mcp): expose forget_memory as a separate tool (#1790) 2026-10-10 20:30:29 -07:00
user-profiles docs(api): keep the default preferences bucket and drop v4 profile labels in v5 docs (#1809) 2026-10-15 18:52:40 +00:00
v5/api-reference docs(api): align v5 ingestion and document operations docs with the API (#1810) 2026-10-15 18:52:40 +00:00
videos add eve docs and refresh integrations (#1671) 2026-09-16 15:24:08 -07:00
.gitignore fix docs icons in dark mode (#1735) 2026-09-30 22:00:27 +00:00
agents-and-mcp.mdx docs: one-line migrate tip on every v5 entry point (#1779) 2026-10-06 21:22:40 +00:00
authentication.mdx docs: move SDK snippets to the shipped v5 call shape and finish the namespace rename (#1772) 2026-10-06 17:06:38 +00:00
docs.json docs: add Docker installation and safe upgrade instructions (#1801) 2026-10-12 16:54:58 -07:00
favicon-dark-mode.png docs: refresh the documentation design (#1715) 2026-09-29 17:26:13 -07:00
favicon-light-mode.png docs: refresh the documentation design (#1715) 2026-09-29 17:26:13 -07:00
favicon.png migrate docs to public 2025-09-28 16:42:06 -07:00
index.mdx docs: move SDK snippets to the shipped v5 call shape and finish the namespace rename (#1772) 2026-10-06 17:06:38 +00:00
install.md docs: align vibe-coding prompt + install guide with canonical API (#976) 2026-05-19 15:27:20 -07:00
invite-team-members.mdx docs: add team invitation guide with console screenshots (#1754) 2026-10-02 16:59:55 -07:00
package.json docs(api): add V3/V4 to V5 migration guide (#1691) 2026-10-06 16:48:36 +00:00
quickstart.mdx docs(api): move v5 search and ingest options into the request body (#1808) 2026-10-15 18:52:40 +00:00
README.md migrate docs to public 2025-09-28 16:42:06 -07:00
style.css docs: community fixes for self-hosting, contributing and the sidebar (#1802) 2026-10-13 04:41:23 +00:00
test.py fix docs icons in dark mode (#1735) 2026-09-30 22:00:27 +00:00
test.ts fix docs icons in dark mode (#1735) 2026-09-30 22:00:27 +00:00
theme-switch.js fix docs icons in dark mode (#1735) 2026-09-30 22:00:27 +00:00
using-supermemory.mdx docs: move SDK snippets to the shipped v5 call shape and finish the namespace rename (#1772) 2026-10-06 17:06:38 +00:00

supermemory Docs