supermemory/apps/docs/docs.json
Dhravya Shah f882f1104d
docs: restructure documentation site and update integration UI (#1331)
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
2026-07-21 20:19:30 -07:00

958 lines
22 KiB
JSON

{
"$schema": "https://mintlify.com/docs.json",
"api": {
"examples": {
"defaults": "required",
"languages": ["typescript", "python", "bash"],
"prefill": true
},
"openapi": "https://api.supermemory.ai/v4/openapi"
},
"colors": {
"dark": "#1E3A8A",
"light": "#3B82F6",
"primary": "#1E3A8A"
},
"contextual": {
"options": ["copy", "view", "assistant", "chatgpt", "claude"]
},
"favicon": "/favicon.png",
"fonts": {
"body": {
"family": "Space Grotesk",
"format": "woff2"
},
"heading": {
"family": "Space Grotesk",
"format": "woff2"
}
},
"footer": {
"socials": {
"github": "https://github.com/supermemoryai",
"linkedin": "https://linkedin.com/company/supermemoryai",
"x": "https://x.com/supermemory"
}
},
"icons": {
"library": "lucide"
},
"logo": {
"dark": "/logo/dark.svg",
"light": "/logo/light.svg"
},
"name": "supermemory | Memory API for the AI era",
"navbar": {
"links": [
{
"href": "https://supermemory.ai/changelog",
"label": "Changelog"
},
{
"href": "mailto:support@supermemory.com",
"label": "Support"
}
],
"primary": {
"href": "https://console.supermemory.ai",
"label": "Dashboard",
"type": "button"
}
},
"navigation": {
"tabs": [
{
"tab": "Overview",
"pages": ["index"]
},
{
"icon": "code",
"anchors": [
{
"anchor": "Developer Platform (API)",
"pages": [
{
"group": "Getting Started",
"pages": [
"overview/what-is-supermemory",
"overview/comparison",
"quickstart",
"agents-and-mcp"
]
},
{
"group": "Concepts",
"pages": [
"concepts/how-it-works",
"concepts/graph-memory",
"concepts/content-types",
{
"group": "Retrieval",
"icon": "search",
"pages": ["concepts/super-rag", "concepts/memory-vs-rag"]
},
{
"group": "Multi-tenancy and filtering",
"icon": "users",
"pages": [
"concepts/multi-tenancy",
"concepts/multi-tenancy-examples",
"concepts/container-tags",
"concepts/filtering"
]
},
{
"group": "User Profiles",
"icon": "id-card",
"pages": ["concepts/user-profiles", "user-profiles/buckets"]
}
]
},
{
"group": "Using supermemory",
"pages": [
"using-supermemory",
"authentication",
"concepts/customization",
{
"group": "Ingestion",
"icon": "download",
"pages": [
"ingestion/add-memories",
"ingestion/document-operations"
]
},
{
"group": "Connectors",
"icon": "plug",
"pages": [
"connectors/overview",
"connectors/notion",
"connectors/google-drive",
"connectors/gmail",
"connectors/onedrive",
"connectors/s3",
"connectors/granola",
"connectors/github",
"connectors/web-crawler",
"connectors/troubleshooting",
"connectors/managing-resources"
]
},
{
"group": "Recall",
"icon": "upload",
"pages": [
"recall/search",
"recall/user-profiles",
"recall/memory-operations",
"recall/memory-review"
]
},
{
"group": "SMFS",
"icon": "database",
"pages": [
"smfs/overview",
"smfs/install",
"smfs/mount",
"smfs/bash-tool",
"smfs/bash-tool-python",
{
"group": "Providers",
"icon": "cloud",
"pages": [
"smfs/providers/daytona",
"smfs/providers/e2b",
"smfs/providers/vercel",
"smfs/providers/cloudflare"
]
},
"smfs/examples"
]
},
"concepts/rules"
]
},
{
"group": "Deployment",
"pages": [
{
"group": "Supermemory local",
"icon": "server",
"pages": [
"self-hosting/overview",
"self-hosting/quickstart",
"self-hosting/configuration",
"self-hosting/embeddings",
"self-hosting/providers",
"self-hosting/local-vs-enterprise"
]
}
]
},
{
"group": "Other resources",
"pages": [
{
"group": "Benchmarking",
"icon": "flask-conical",
"pages": [
"memorybench/overview",
"memorybench/extend-benchmark",
"memorybench/extend-provider",
"memorybench/memscore"
]
},
"overview/billing",
"overview/security",
"overview/use-cases",
"overview/analytics"
]
},
{
"group": "Migration Guides",
"pages": [
{
"group": "From another provider",
"icon": "truck",
"pages": ["migration/from-mem0", "migration/from-zep"]
}
]
}
]
},
{
"anchor": "API Integrations",
"icon": "plug",
"pages": [
"integrations/supermemory-sdk",
"integrations/ai-sdk",
"integrations/openai",
"integrations/langgraph",
"integrations/openai-agents-sdk",
"integrations/agent-framework",
"integrations/mastra",
"integrations/voltagent",
"integrations/convex",
"integrations/langchain",
"integrations/crewai",
"integrations/agno",
"integrations/memory-graph",
"integrations/claude-memory",
"integrations/pipecat",
"integrations/cartesia",
"integrations/n8n",
"integrations/viasocket",
"integrations/zapier",
{
"group": "Migration Guides",
"icon": "arrow-up-right",
"pages": ["migration/tools-v2-upgrade"]
}
]
},
{
"anchor": "API Reference",
"icon": "unplug",
"openapi": "https://api.supermemory.ai/v4/openapi",
"pages": [
"api-reference/overview",
"authentication",
{
"group": "Ingest",
"icon": "download",
"pages": [
"api-reference/ingest",
"POST /v3/documents",
"POST /v3/documents/file",
"POST /v3/documents/batch",
"POST /v4/conversations",
"GET /v3/documents/{id}"
]
},
{
"group": "Recall",
"icon": "search",
"pages": [
"api-reference/search",
"POST /v4/search",
"POST /v3/search",
"api-reference/profiles",
"POST /v4/profile",
"POST /v4/profile/buckets"
]
},
{
"group": "Documents",
"icon": "file-text",
"pages": [
"api-reference/documents",
"POST /v3/documents/list",
"GET /v3/documents/processing",
"PATCH /v3/documents/{id}",
"DELETE /v3/documents/{id}",
"DELETE /v3/documents/bulk",
"GET /v3/documents/{id}/chunks",
"GET /v3/documents/{id}/file-url"
]
},
{
"group": "Memories",
"icon": "database",
"pages": [
"api-reference/memories",
"POST /v4/memories",
"POST /v4/memories/list",
"PATCH /v4/memories",
"DELETE /v4/memories",
"POST /v4/memories/forget-matching"
]
},
{
"group": "Container tags",
"icon": "tags",
"pages": [
"api-reference/container-tags",
"GET /v3/container-tags/{containerTag}",
"PATCH /v3/container-tags/{containerTag}",
"DELETE /v3/container-tags/{containerTag}",
"POST /v3/container-tags/merge",
"GET /v3/container-tags/merge/{mergeId}"
]
},
{
"group": "Connections",
"icon": "plug",
"pages": [
"api-reference/connections",
"POST /v3/connections/{provider}",
"POST /v3/connections/list",
"GET /v3/connections/{connectionId}",
"POST /v3/connections/{connectionId}/configure",
"GET /v3/connections/{connectionId}/resources",
"POST /v3/connections/{provider}/import",
"POST /v3/connections/{provider}/documents",
"POST /v3/connections/{provider}/connection",
"DELETE /v3/connections/{connectionId}",
"DELETE /v3/connections/{provider}"
]
},
{
"group": "Settings",
"icon": "settings",
"pages": [
"api-reference/settings",
"GET /v3/settings",
"PATCH /v3/settings",
"POST /v3/settings/suggest-buckets",
"POST /v3/settings/reset"
]
}
]
}
],
"tab": "Developer Platform"
},
{
"icon": "puzzle",
"anchors": [
{
"anchor": "Plugins and MCP",
"icon": "puzzle",
"pages": [
{
"group": "Supermemory MCP",
"icon": "terminal",
"pages": [
"supermemory-mcp/mcp",
"supermemory-mcp/setup",
{
"group": "Setups",
"icon": "layers",
"pages": ["supermemory-mcp/claude-desktop"]
}
]
},
{
"group": "Plugins",
"icon": "puzzle",
"pages": [
"integrations/openclaw",
"integrations/claude-code",
"integrations/opencode",
"integrations/codex",
"integrations/hermes"
]
}
]
}
],
"tab": "Plugins and MCP"
},
{
"tab": "Company Brain",
"groups": [
{
"group": "Concepts",
"pages": [
"company-brain/overview",
"company-brain/setup",
"company-brain/permissions",
"company-brain/connectors",
"company-brain/automations",
"company-brain/outside-slack"
]
},
{
"group": "What you can do",
"pages": [
"company-brain/use-cases/overview",
"company-brain/use-cases/support",
"company-brain/use-cases/incidents",
"company-brain/use-cases/support-escalation",
"company-brain/use-cases/meeting-recall",
"company-brain/use-cases/knowledge-recall",
"company-brain/use-cases/acting-in-tools",
"company-brain/use-cases/greeting",
"company-brain/use-cases/sandbox-debugging",
"company-brain/use-cases/long-horizon-research",
"company-brain/use-cases/meeting-scheduling"
]
}
]
}
]
},
"redirects": [
{
"destination": "/agents-and-mcp",
"permanent": true,
"source": "/vibe-coding"
},
{
"destination": "/overview/what-is-supermemory",
"permanent": true,
"source": "/intro"
},
{
"destination": "/",
"permanent": true,
"source": "/changelog/developer-platform"
},
{
"destination": "/",
"permanent": true,
"source": "/changelog/overview"
},
{
"destination": "/",
"permanent": true,
"source": "/changelog/plugins"
},
{
"destination": "/integrations/openclaw",
"permanent": true,
"source": "/integrations/clawdbot"
},
{
"destination": "/",
"permanent": true,
"source": "/introduction"
},
{
"destination": "/concepts/how-it-works",
"permanent": true,
"source": "/how-it-works"
},
{
"destination": "/concepts/memory-vs-rag",
"permanent": true,
"source": "/memory-vs-rag"
},
{
"destination": "/integrations/supermemory-sdk",
"permanent": true,
"source": "/memory-api/sdks/overview"
},
{
"destination": "/integrations/supermemory-sdk",
"permanent": true,
"source": "/memory-api/sdks/native"
},
{
"destination": "/integrations/openai",
"permanent": true,
"source": "/memory-api/sdks/openai-plugins"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/ai-sdk/overview"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/ai-sdk/user-profiles"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/ai-sdk/memory-tools"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/ai-sdk/infinite-chat"
},
{
"destination": "/integrations/memory-graph",
"permanent": true,
"source": "/memory-graph/overview"
},
{
"destination": "/integrations/memory-graph",
"permanent": true,
"source": "/memory-graph/installation"
},
{
"destination": "/integrations/memory-graph",
"permanent": true,
"source": "/memory-graph/quickstart"
},
{
"destination": "/integrations/memory-graph",
"permanent": true,
"source": "/memory-graph/api-reference"
},
{
"destination": "/integrations/memory-graph",
"permanent": true,
"source": "/memory-graph/examples"
},
{
"destination": "/integrations/pipecat",
"permanent": true,
"source": "/voice-realtime/pipecat"
},
{
"destination": "/integrations/n8n",
"permanent": true,
"source": "/n8n"
},
{
"destination": "/integrations/zapier",
"permanent": true,
"source": "/zapier"
},
{
"destination": "/concepts/filtering",
"permanent": true,
"source": "/search/filtering"
},
{
"destination": "/ingestion/add-memories",
"permanent": true,
"source": "/add-memories/overview"
},
{
"destination": "/ingestion/add-memories",
"permanent": true,
"source": "/add-memories/parameters"
},
{
"destination": "/ingestion/add-memories",
"permanent": true,
"source": "/memory-api/ingesting"
},
{
"destination": "/ingestion/add-memories",
"permanent": true,
"source": "/add-memories/examples/basic"
},
{
"destination": "/ingestion/add-memories",
"permanent": true,
"source": "/add-memories/examples/file-upload"
},
{
"destination": "/recall/search",
"permanent": true,
"source": "/search/overview"
},
{
"destination": "/recall/search",
"permanent": true,
"source": "/search/parameters"
},
{
"destination": "/recall/search",
"permanent": true,
"source": "/search/response-schema"
},
{
"destination": "/recall/search",
"permanent": true,
"source": "/search/query-rewriting"
},
{
"destination": "/recall/search",
"permanent": true,
"source": "/search/reranking"
},
{
"destination": "/recall/search",
"permanent": true,
"source": "/search/examples/document-search"
},
{
"destination": "/recall/search",
"permanent": true,
"source": "/search/examples/memory-search"
},
{
"destination": "/concepts/user-profiles",
"permanent": true,
"source": "/user-profiles/overview"
},
{
"destination": "/recall/user-profiles",
"permanent": true,
"source": "/user-profiles/api"
},
{
"destination": "/recall/user-profiles",
"permanent": true,
"source": "/user-profiles/examples"
},
{
"destination": "/concepts/user-profiles",
"permanent": true,
"source": "/user-profiles/use-cases"
},
{
"destination": "/ingestion/add-memories",
"permanent": true,
"source": "/update-delete-memories/overview"
},
{
"destination": "/ingestion/document-operations",
"permanent": true,
"source": "/memory-api/track-progress"
},
{
"destination": "/ingestion/document-operations",
"permanent": true,
"source": "/list-memories/overview"
},
{
"destination": "/ingestion/document-operations",
"permanent": true,
"source": "/list-memories/examples/basic"
},
{
"destination": "/ingestion/document-operations",
"permanent": true,
"source": "/list-memories/examples/filtering"
},
{
"destination": "/ingestion/document-operations",
"permanent": true,
"source": "/list-memories/examples/pagination"
},
{
"destination": "/ingestion/document-operations",
"permanent": true,
"source": "/list-memories/examples/monitoring"
},
{
"destination": "/concepts/customization",
"permanent": true,
"source": "/org-settings"
},
{
"destination": "/ingestion/add-memories",
"permanent": true,
"source": "/memory-api/overview"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/ai-sdk/examples"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/ai-sdk/npm"
},
{
"destination": "/connectors/overview",
"permanent": true,
"source": "/memory-api/connectors/advanced/bring-your-own-key"
},
{
"destination": "/connectors/overview",
"permanent": true,
"source": "/memory-api/connectors/creating-connection"
},
{
"destination": "/connectors/overview",
"permanent": true,
"source": "/memory-api/connectors/overview"
},
{
"destination": "/connectors/google-drive",
"permanent": true,
"source": "/memory-api/connectors/google-drive"
},
{
"destination": "/connectors/managing-resources",
"permanent": true,
"source": "/memory-api/connectors/managing-resources"
},
{
"destination": "/ingestion/add-memories",
"permanent": true,
"source": "/memory-api/creation/adding-memories"
},
{
"destination": "/ingestion/document-operations",
"permanent": true,
"source": "/memory-api/creation/status"
},
{
"destination": "/concepts/content-types",
"permanent": true,
"source": "/memory-api/features/auto-multi-modal"
},
{
"destination": "/concepts/customization",
"permanent": true,
"source": "/memory-api/features/content-cleaner"
},
{
"destination": "/concepts/filtering",
"permanent": true,
"source": "/memory-api/features/filtering"
},
{
"destination": "/recall/search",
"permanent": true,
"source": "/memory-api/features/query-rewriting"
},
{
"destination": "/recall/search",
"permanent": true,
"source": "/memory-api/features/reranking"
},
{
"destination": "/overview/what-is-supermemory",
"permanent": true,
"source": "/memory-api/introduction"
},
{
"destination": "/integrations/claude-memory",
"permanent": true,
"source": "/memory-api/sdks/anthropic-claude-memory"
},
{
"destination": "/integrations/supermemory-sdk",
"permanent": true,
"source": "/memory-api/sdks/python"
},
{
"destination": "/integrations/supermemory-sdk",
"permanent": true,
"source": "/memory-api/sdks/typescript"
},
{
"destination": "/integrations/supermemory-sdk",
"permanent": true,
"source": "/memory-api/sdks/supermemory-npm"
},
{
"destination": "/integrations/supermemory-sdk",
"permanent": true,
"source": "/memory-api/sdks/supermemory-pypi"
},
{
"destination": "/recall/search",
"permanent": true,
"source": "/memory-api/searching/searching-memories"
},
{
"destination": "/integrations/memory-graph",
"permanent": true,
"source": "/memory-graph/npm"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/memory-router/overview"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/memory-router/usage"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/memory-router/with-memory-api"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/model-enhancement/context-extender"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/model-enhancement/getting-started"
},
{
"destination": "/integrations/ai-sdk",
"permanent": true,
"source": "/model-enhancement/identifying-users"
},
{
"destination": "/integrations/openai",
"permanent": true,
"source": "/openai-sdks/usage"
},
{
"destination": "/overview/comparison",
"permanent": true,
"source": "/overview/why-supermemory"
},
{
"destination": "/supermemory-mcp/mcp",
"permanent": true,
"source": "/supermemory-mcp/introduction"
},
{
"destination": "/supermemory-mcp/mcp",
"permanent": true,
"source": "/supermemory-mcp/technology"
},
{
"destination": "/",
"permanent": true,
"source": "/cookbook/overview"
},
{
"destination": "/",
"permanent": true,
"source": "/cookbook/document-qa"
},
{
"destination": "/",
"permanent": true,
"source": "/cookbook/ai-sdk-integration"
},
{
"destination": "/",
"permanent": true,
"source": "/cookbook/customer-support"
},
{
"destination": "/",
"permanent": true,
"source": "/cookbook/personal-assistant"
},
{
"destination": "https://supermemory.ai/blog/building-an-ai-compliance-chatbot-with-supermemory-and-google-drive/",
"permanent": true,
"source": "/cookbook/chat-with-gdrive"
},
{
"destination": "https://supermemory.ai/blog/extending-context-windows-in-llms/",
"permanent": true,
"source": "/cookbook/inf-chat-blog"
},
{
"destination": "https://supermemory.ai/blog/build-your-own-perplexity-in-15-minutes-with-supermemory/",
"permanent": true,
"source": "/cookbook/perplexity-supermemory"
},
{
"destination": "/",
"permanent": true,
"source": "/memorybench/architecture"
},
{
"destination": "/",
"permanent": true,
"source": "/memorybench/cli"
},
{
"destination": "/",
"permanent": true,
"source": "/memorybench/contributing"
},
{
"destination": "/",
"permanent": true,
"source": "/memorybench/github"
},
{
"destination": "/",
"permanent": true,
"source": "/memorybench/installation"
},
{
"destination": "/",
"permanent": true,
"source": "/memorybench/integrations"
},
{
"destination": "/",
"permanent": true,
"source": "/memorybench/quickstart"
},
{
"destination": "/",
"permanent": true,
"source": "/memorybench/supported-models"
},
{
"destination": "/ingestion/add-memories",
"permanent": true,
"source": "/add-memories"
},
{
"destination": "/ingestion/document-operations",
"permanent": true,
"source": "/document-operations"
},
{
"destination": "/recall/search",
"permanent": true,
"source": "/search"
},
{
"destination": "/recall/user-profiles",
"permanent": true,
"source": "/user-profiles"
},
{
"destination": "/recall/memory-operations",
"permanent": true,
"source": "/memory-operations"
},
{
"destination": "/recall/memory-review",
"permanent": true,
"source": "/memory-review"
},
{
"destination": "/overview/analytics",
"permanent": true,
"source": "/analytics"
}
],
"styling": {
"eyebrows": "breadcrumbs"
},
"theme": "aspen"
}