aboutsummaryrefslogtreecommitdiff
path: root/apps/docs
diff options
context:
space:
mode:
authorDhravya Shah <[email protected]>2025-03-23 20:27:24 -0700
committerDhravya Shah <[email protected]>2025-03-23 20:27:24 -0700
commit2016145b8333d7d7e6283efadc8261891751e7a9 (patch)
treeeaf0f4f002bc373b61c1efd88339de4c1002c9bd /apps/docs
parentDocumentation edits made through Mintlify web editor (diff)
downloadsupermemory-2016145b8333d7d7e6283efadc8261891751e7a9.tar.xz
supermemory-2016145b8333d7d7e6283efadc8261891751e7a9.zip
v2 docs
Diffstat (limited to 'apps/docs')
-rw-r--r--apps/docs/essentials/metadata-filtering.mdx2
-rw-r--r--apps/docs/mint.json10
-rw-r--r--apps/docs/openapi.json404
-rw-r--r--apps/docs/quickstart.mdx2
4 files changed, 410 insertions, 8 deletions
diff --git a/apps/docs/essentials/metadata-filtering.mdx b/apps/docs/essentials/metadata-filtering.mdx
index 3ac4e6a7..d2df77ea 100644
--- a/apps/docs/essentials/metadata-filtering.mdx
+++ b/apps/docs/essentials/metadata-filtering.mdx
@@ -12,7 +12,7 @@ You can do all this filtering using Supermemory's api.
Here's a quick example
-```json [expandable]
+```json
{
"AND": [
{
diff --git a/apps/docs/mint.json b/apps/docs/mint.json
index 586c4832..1a611181 100644
--- a/apps/docs/mint.json
+++ b/apps/docs/mint.json
@@ -29,7 +29,7 @@
{
"name": "API Reference",
"url": "api-reference/endpoints",
- "openapi": "/openapi.json"
+ "openapi": "https://v2.api.supermemory.ai/openapi"
},
{
"name": "Changelog",
@@ -43,9 +43,9 @@
"url": "https://git.new/memory"
},
{
- "name": "Community",
- "icon": "discord",
- "url": "https://discord.gg/supermemory"
+ "name": "Ask the founder",
+ "icon": "mail",
+ "url": "mailto:[email protected]"
},
{
"name": "X (Twitter)",
@@ -60,7 +60,7 @@
},
{
"group": "Essentials",
- "pages": ["essentials/distinguishing-users", "essentials/architecture", "essentials/pricing"]
+ "pages": ["essentials/metadata-filtering", "essentials/pricing"]
},
{
"group": "Changelog",
diff --git a/apps/docs/openapi.json b/apps/docs/openapi.json
index 45d4402f..69996b00 100644
--- a/apps/docs/openapi.json
+++ b/apps/docs/openapi.json
@@ -1 +1,403 @@
-{"openapi":"3.1.0","info":{"title":"Supermemory API","description":"best memory api on 🌍","version":"2.0.0"},"servers":[{"url":"http://localhost:3000","description":"Local Server"},{"url":"https://v2.api.supermemory.ai","description":"Production Server"}],"paths":{"/add":{"post":{"responses":{"200":{"description":"Memory added successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}},"required":["id","status"]}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"string"}},"required":["error"]}}}}},"operationId":"postAdd","tags":["Memory Management"],"parameters":[],"description":"Add a new memory with content and metadata","request":{"body":{"description":"Memory content and metadata","content":{"application/json":{"schema":{}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"spaceIds":{"type":"array","items":{"type":"string"}},"id":{"type":"string"}},"required":["content"]}}}}}},"/update/{id}":{"put":{"responses":{"200":{"description":"Memory updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"}},"required":["id","status"]}}}},"404":{"description":"Memory not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"string"}},"required":["error"]}}}}},"operationId":"putUpdateById","tags":["Memory Management"],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"description":"Update an existing memory","request":{"params":{"description":"Memory ID","schema":{}},"body":{"description":"Updated memory content","content":{"application/json":{"schema":{}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"spaceIds":{"type":"array","items":{"type":"string"}}},"required":["content"]}}}}}},"/delete/{id}":{"delete":{"responses":{"200":{"description":"Memory deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}},"404":{"description":"Memory not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"string"}},"required":["error"]}}}}},"operationId":"deleteDeleteById","tags":["Memory Management"],"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true}],"description":"Delete a memory","request":{"params":{"description":"Memory ID","schema":{}}}}},"/search":{"post":{"responses":{"200":{"description":"Search results","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string"},"chunks":{"type":"array","items":{"type":"object","properties":{"content":{"type":"string"},"isRelevant":{"type":"boolean"}},"required":["content","isRelevant"]}},"score":{"type":"number"}},"required":["documentId","chunks","score"]}}},"required":["results"]}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"string"}},"required":["error"]}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"string"}},"required":["error"]}}}}},"operationId":"postSearch","tags":["Search"],"parameters":[],"description":"Search through documents with metadata filtering","request":{"body":{"description":"Search parameters","content":{"application/json":{"schema":{}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"q":{"type":"string","minLength":1},"limit":{"type":"integer","exclusiveMinimum":0,"default":10},"filters":{"anyOf":[{"type":"object","properties":{"OR":{"type":"array","items":{}},"AND":{"type":"array","items":{}}}},{"type":"object","additionalProperties":{}}]},"chunkSize":{"type":"integer","exclusiveMinimum":0,"default":3},"minScore":{"type":"number","minimum":0,"maximum":1,"default":0.5}},"required":["q"]}}}}}},"/fastsearch":{"get":{"responses":{"200":{"description":"Fast search results","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"similarity":{"type":"number"}},"required":["id","content","similarity"]}}},"required":["results"]}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"details":{"type":"string"}},"required":["error"]}}}}},"operationId":"getFastsearch","tags":["Search"],"parameters":[{"in":"query","name":"q","schema":{"type":"string","minLength":1},"required":true},{"in":"query","name":"limit","schema":{"type":"string","pattern":"^\\d+$"},"required":false}],"description":"Fast, lossy search using quantized embeddings","request":{"query":{"description":"Search parameters","schema":{}}}}}},"components":{"schemas":{}}} \ No newline at end of file
+{
+ "openapi": "3.1.0",
+ "info": {
+ "title": "Supermemory API",
+ "description": "best memory api on 🌍",
+ "version": "2.0.0"
+ },
+ "servers": [
+ { "url": "http://localhost:3000", "description": "Local Server" },
+ {
+ "url": "https://v2.api.supermemory.ai",
+ "description": "Production Server"
+ }
+ ],
+ "paths": {
+ "/add": {
+ "post": {
+ "responses": {
+ "200": {
+ "description": "Memory added successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": { "type": "string" },
+ "status": { "type": "string" }
+ },
+ "required": ["id", "status"]
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": { "type": "string" },
+ "details": { "type": "string" }
+ },
+ "required": ["error"]
+ }
+ }
+ }
+ }
+ },
+ "operationId": "postAdd",
+ "tags": ["Memory Management"],
+ "parameters": [],
+ "description": "Add a new memory with content and metadata",
+ "request": {
+ "body": {
+ "description": "Memory content and metadata",
+ "content": { "application/json": { "schema": {} } }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": { "type": "string" },
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "anyOf": [
+ { "type": "string" },
+ { "type": "number" },
+ { "type": "boolean" }
+ ]
+ }
+ },
+ "spaceIds": {
+ "type": "array",
+ "items": { "type": "string" }
+ },
+ "id": { "type": "string" }
+ },
+ "required": ["content"]
+ }
+ }
+ }
+ }
+ }
+ },
+ "/update/{id}": {
+ "put": {
+ "responses": {
+ "200": {
+ "description": "Memory updated successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": { "type": "string" },
+ "status": { "type": "string" }
+ },
+ "required": ["id", "status"]
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Memory not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": { "type": "string" },
+ "details": { "type": "string" }
+ },
+ "required": ["error"]
+ }
+ }
+ }
+ }
+ },
+ "operationId": "putUpdateById",
+ "tags": ["Memory Management"],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "schema": { "type": "string" },
+ "required": true
+ }
+ ],
+ "description": "Update an existing memory",
+ "request": {
+ "params": { "description": "Memory ID", "schema": {} },
+ "body": {
+ "description": "Updated memory content",
+ "content": { "application/json": { "schema": {} } }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "content": { "type": "string" },
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "anyOf": [
+ { "type": "string" },
+ { "type": "number" },
+ { "type": "boolean" }
+ ]
+ }
+ },
+ "spaceIds": { "type": "array", "items": { "type": "string" } }
+ },
+ "required": ["content"]
+ }
+ }
+ }
+ }
+ }
+ },
+ "/delete/{id}": {
+ "delete": {
+ "responses": {
+ "200": {
+ "description": "Memory deleted successfully",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": { "success": { "type": "boolean" } },
+ "required": ["success"]
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Memory not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": { "type": "string" },
+ "details": { "type": "string" }
+ },
+ "required": ["error"]
+ }
+ }
+ }
+ }
+ },
+ "operationId": "deleteDeleteById",
+ "tags": ["Memory Management"],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "schema": { "type": "string" },
+ "required": true
+ }
+ ],
+ "description": "Delete a memory",
+ "request": { "params": { "description": "Memory ID", "schema": {} } }
+ }
+ },
+ "/search": {
+ "post": {
+ "responses": {
+ "200": {
+ "description": "Search results",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "documentId": { "type": "string" },
+ "chunks": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "content": { "type": "string" },
+ "isRelevant": { "type": "boolean" }
+ },
+ "required": ["content", "isRelevant"]
+ }
+ },
+ "score": { "type": "number" }
+ },
+ "required": ["documentId", "chunks", "score"]
+ }
+ }
+ },
+ "required": ["results"]
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid request parameters",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": { "type": "string" },
+ "details": { "type": "string" }
+ },
+ "required": ["error"]
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": { "type": "string" },
+ "details": { "type": "string" }
+ },
+ "required": ["error"]
+ }
+ }
+ }
+ }
+ },
+ "operationId": "postSearch",
+ "tags": ["Search"],
+ "parameters": [],
+ "description": "Search through documents with metadata filtering",
+ "request": {
+ "body": {
+ "description": "Search parameters",
+ "content": { "application/json": { "schema": {} } }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "q": { "type": "string", "minLength": 1 },
+ "limit": {
+ "type": "integer",
+ "exclusiveMinimum": 0,
+ "default": 10
+ },
+ "filters": {
+ "anyOf": [
+ {
+ "type": "object",
+ "properties": {
+ "OR": { "type": "array", "items": {} },
+ "AND": { "type": "array", "items": {} }
+ }
+ },
+ { "type": "object", "additionalProperties": {} }
+ ]
+ },
+ "chunkSize": {
+ "type": "integer",
+ "exclusiveMinimum": 0,
+ "default": 3
+ },
+ "minScore": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "default": 0.5
+ }
+ },
+ "required": ["q"]
+ }
+ }
+ }
+ }
+ }
+ },
+ "/fastsearch": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Fast search results",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": { "type": "string" },
+ "content": { "type": "string" },
+ "similarity": { "type": "number" }
+ },
+ "required": ["id", "content", "similarity"]
+ }
+ }
+ },
+ "required": ["results"]
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Server error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "error": { "type": "string" },
+ "details": { "type": "string" }
+ },
+ "required": ["error"]
+ }
+ }
+ }
+ }
+ },
+ "operationId": "getFastsearch",
+ "tags": ["Search"],
+ "parameters": [
+ {
+ "in": "query",
+ "name": "q",
+ "schema": { "type": "string", "minLength": 1 },
+ "required": true
+ },
+ {
+ "in": "query",
+ "name": "limit",
+ "schema": { "type": "string", "pattern": "^\\d+$" },
+ "required": false
+ }
+ ],
+ "description": "Fast, lossy search using quantized embeddings",
+ "request": {
+ "query": { "description": "Search parameters", "schema": {} }
+ }
+ }
+ }
+ },
+ "components": { "schemas": {} }
+}
diff --git a/apps/docs/quickstart.mdx b/apps/docs/quickstart.mdx
index 87dc84ec..b2b4db75 100644
--- a/apps/docs/quickstart.mdx
+++ b/apps/docs/quickstart.mdx
@@ -14,7 +14,7 @@ To use the Supermemory API, you'll need:
1. Login into https://dev.supermemory.ai and create an organization
2. Create an api key, copy and save it securely.
- ![image.png](/apps/docs/image.png)
+ ![image.png](/image.png)
Keep your API key secure and never share it publicly. You'll need this key for authenticating all API requests.
</Accordion>