mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-10-06 02:47:54 +00:00
640eeaa8e8
Co-authored-by: Dhravya Shah <dhravya@supermemory.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
65 lines
4 KiB
Text
65 lines
4 KiB
Text
---
|
|
title: "Using Supermemory"
|
|
sidebarTitle: "Overview"
|
|
description: "The full loop: authenticate, put context in, get it back out, keep it correct."
|
|
icon: "/icons/hugeicons/compass-01.svg"
|
|
---
|
|
|
|
import { Journey, JourneyStep, JourneyItem } from "/snippets/journey.mdx";
|
|
|
|
Everything in this section is one of four steps. Same loop whether you're building personal memory, RAG over docs, or both on the same `containerTag`.
|
|
|
|
<Journey>
|
|
<JourneyStep number="1" title="Get started">
|
|
<JourneyItem icon="/icons/hugeicons/play.svg" title="Quickstart" href="/quickstart" />
|
|
<JourneyItem icon="/icons/hugeicons/key-01.svg" title="Get an API key" href="/authentication" />
|
|
<JourneyItem icon="/icons/hugeicons/book-open-01.svg" title="API Reference" href="/api-reference/overview" />
|
|
</JourneyStep>
|
|
|
|
<JourneyStep number="2" title="Ingest — get content in">
|
|
<JourneyItem icon="/icons/hugeicons/plus-sign.svg" title="Add memories & documents" href="/ingestion/add-memories" />
|
|
<JourneyItem icon="/icons/hugeicons/clock-01.svg" title="Backfill historical data" href="/ingestion/batch-ingest-historical-data" />
|
|
<JourneyItem icon="/icons/hugeicons/files-02.svg" title="Document operations" href="/ingestion/document-operations" />
|
|
<JourneyItem icon="/icons/hugeicons/plug-01.svg" title="Connectors" href="/connectors/overview" />
|
|
<JourneyItem icon="/icons/hugeicons/files-01.svg" title="Content types" href="/concepts/content-types" />
|
|
<JourneyItem icon="/icons/hugeicons/command-line.svg" title="Ingest API reference" href="/api-reference/ingest" />
|
|
</JourneyStep>
|
|
|
|
<JourneyStep number="3" title="Retrieve — get context back out">
|
|
<JourneyItem icon="/icons/hugeicons/search-01.svg" title="Search" href="/recall/search" />
|
|
<JourneyItem icon="/icons/hugeicons/user.svg" title="User profiles" href="/recall/user-profiles" />
|
|
<JourneyItem icon="/icons/hugeicons/database-01.svg" title="SMFS" href="/smfs/overview" />
|
|
<JourneyItem icon="/icons/hugeicons/command-line.svg" title="Recall API reference" href="/api-reference/search" />
|
|
</JourneyStep>
|
|
|
|
<JourneyStep number="4" title="Manage">
|
|
<JourneyItem icon="/icons/hugeicons/eraser-01.svg" title="CRUD & forgetting" href="/recall/memory-operations" />
|
|
<JourneyItem icon="/icons/hugeicons/check-list.svg" title="Review inferred memories" href="/recall/memory-review" />
|
|
<JourneyItem icon="/icons/hugeicons/settings-02.svg" title="Customizing behavior" href="/concepts/customization" />
|
|
<JourneyItem icon="/icons/hugeicons/justice-scale-01.svg" title="Rules of thumb" href="/concepts/rules" />
|
|
<JourneyItem icon="/icons/hugeicons/command-line.svg" title="Memories API reference" href="/api-reference/memories" />
|
|
<JourneyItem icon="/icons/hugeicons/test-tube-01.svg" title="Benchmark it yourself" href="/memorybench/overview" />
|
|
</JourneyStep>
|
|
</Journey>
|
|
|
|
Raw input automatically becomes memories (the knowledge graph) and indexed document chunks (for RAG). You don't choose one or the other; both come from the same write. Retrieval then gives you three ways to read that pool back. If you're unsure which fits, read [Memory vs RAG](/concepts/memory-vs-rag).
|
|
|
|
## Where next
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Quickstart" icon="/icons/hugeicons/play.svg" href="/quickstart">
|
|
Walk the whole loop end to end with one working example.
|
|
</Card>
|
|
<Card title="How it works" icon="/icons/hugeicons/cpu.svg" href="/concepts/how-it-works">
|
|
What happens between `add()` and a memory showing up in search.
|
|
</Card>
|
|
<Card title="Container tags" icon="/icons/hugeicons/folder-01.svg" href="/concepts/container-tags">
|
|
The isolation boundary every ingest and retrieve call is scoped to.
|
|
</Card>
|
|
<Card title="Memory vs RAG" icon="/icons/hugeicons/balance-scale.svg" href="/concepts/memory-vs-rag">
|
|
When to reach for search, profiles, or both.
|
|
</Card>
|
|
<Card title="Benchmarking" icon="/icons/hugeicons/test-tube-01.svg" href="/memorybench/overview">
|
|
Run standardized, reproducible evals against Supermemory and other providers — including your own.
|
|
</Card>
|
|
</CardGroup>
|