aboutsummaryrefslogtreecommitdiff
path: root/apps/docs/api-reference
diff options
context:
space:
mode:
Diffstat (limited to 'apps/docs/api-reference')
-rw-r--r--apps/docs/api-reference/endpoints/connect/connect-app.mdx9
-rw-r--r--apps/docs/api-reference/endpoints/connect/connection-information.mdx4
-rw-r--r--apps/docs/api-reference/endpoints/memory-management/put-update.mdx6
-rw-r--r--apps/docs/api-reference/endpoints/search/get-fastsearch.mdx6
-rw-r--r--apps/docs/api-reference/endpoints/search/post-search.mdx11
5 files changed, 31 insertions, 5 deletions
diff --git a/apps/docs/api-reference/endpoints/connect/connect-app.mdx b/apps/docs/api-reference/endpoints/connect/connect-app.mdx
index d423191d..f77d29df 100644
--- a/apps/docs/api-reference/endpoints/connect/connect-app.mdx
+++ b/apps/docs/api-reference/endpoints/connect/connect-app.mdx
@@ -1,3 +1,10 @@
---
openapi: get /connect/{app}
---- \ No newline at end of file
+---
+
+You may connect supermemory to other apps.
+when you send a GET request to the /connect:APP?id=<> endpoint, you will get a redirectURL. This is a safe URL that your users can click and select the appropriate files with. Once this is done, supermemory will periodically re-fetch and make sure that the data is always fresh.
+
+As of right now, these apps are supported:
+- Notion
+
diff --git a/apps/docs/api-reference/endpoints/connect/connection-information.mdx b/apps/docs/api-reference/endpoints/connect/connection-information.mdx
index 4bd17823..d13af160 100644
--- a/apps/docs/api-reference/endpoints/connect/connection-information.mdx
+++ b/apps/docs/api-reference/endpoints/connect/connection-information.mdx
@@ -1,3 +1,5 @@
---
openapi: get /connections/{connectionId}
---- \ No newline at end of file
+---
+
+Get the connection details using this endpoint. \ No newline at end of file
diff --git a/apps/docs/api-reference/endpoints/memory-management/put-update.mdx b/apps/docs/api-reference/endpoints/memory-management/put-update.mdx
index 312a6e56..8970ffe3 100644
--- a/apps/docs/api-reference/endpoints/memory-management/put-update.mdx
+++ b/apps/docs/api-reference/endpoints/memory-management/put-update.mdx
@@ -1,3 +1,7 @@
---
openapi: put /update/{id}
---- \ No newline at end of file
+---
+
+Update an existing memory.
+Please note that all existing metadata will be replaced with the new ones.
+You can also use the /add endpoint along with the ID specified.
diff --git a/apps/docs/api-reference/endpoints/search/get-fastsearch.mdx b/apps/docs/api-reference/endpoints/search/get-fastsearch.mdx
index 0dafdc47..f1e705ce 100644
--- a/apps/docs/api-reference/endpoints/search/get-fastsearch.mdx
+++ b/apps/docs/api-reference/endpoints/search/get-fastsearch.mdx
@@ -1,3 +1,7 @@
---
openapi: get /fastsearch
---- \ No newline at end of file
+---
+
+Fast, lossy search using quantized embeddings. This can be used in case your app has text completions, or when searching fast is absolutely necessary.
+
+
diff --git a/apps/docs/api-reference/endpoints/search/post-search.mdx b/apps/docs/api-reference/endpoints/search/post-search.mdx
index ea2f8389..8e9867d2 100644
--- a/apps/docs/api-reference/endpoints/search/post-search.mdx
+++ b/apps/docs/api-reference/endpoints/search/post-search.mdx
@@ -1,3 +1,12 @@
---
openapi: post /search
---- \ No newline at end of file
+---
+
+Search through documents with metadata filtering.
+
+Body:
+`q`: Your search query
+
+`limit`: Number of documents you want to get
+
+`filters`: Filters can be applied as `AND, OR, negate, numeric` types. You can read more about it here - [https://docs.supermemory.ai/essentials/metadata-filtering](https://docs.supermemory.ai/essentials/metadata-filtering) \ No newline at end of file