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.
30 lines
947 B
Text
30 lines
947 B
Text
---
|
|
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>
|