Prerequisites
Before adding memories, you need to set up the Supermemory client:- Install the SDK for your language
- Get your API key from Supermemory Console
- Initialize the client with your API key
Quick Start
Key Concepts
New to Supermemory? Read How Supermemory Works to understand the knowledge graph architecture and the distinction between documents and memories.
Quick Overview
- Documents: Raw content you upload (PDFs, URLs, text)
- Memories: Searchable chunks created automatically with relationships
- Container Tags: Group related content for better context
- Metadata: Additional information for filtering
Content Sources
Add content through three methods:- Direct Text: Send text content directly via API
- File Upload: Upload PDFs, images, videos for extraction
- URL Processing: Automatic extraction from web pages and platforms
Endpoints
Remember, these endpoints add documents. Memories are inferred by Supermemory.
Add Content
POST /v3/documents
Add text content, URLs, or any supported format.
Upload File
POST /v3/documents/file
Upload files directly for processing.
Update Memory
PATCH /v3/documents/{id}
Update existing document content.
Supported Content Types
Documents
- PDF with OCR support
- Google Docs, Sheets, Slides
- Notion pages
- Microsoft Office files
Media
- Images (JPG, PNG, GIF, WebP) with OCR
Web Content
- Twitter/X posts
- YouTube videos with captions
Text Formats
- Plain text
- Markdown
- CSV files
Refer to the connectors guide to learn how you can connect Google Drive, Notion, and OneDrive and sync files in real-time.
Response Format
id: Unique document identifierstatus: Processing state (queued,processing,done)
Next Steps
- Track Processing Status - Monitor document processing
- Search Memories - Search your content
- List Memories - Browse stored memories
- Update & Delete - Manage memories