aboutsummaryrefslogtreecommitdiff
path: root/apps/docs/api-reference
diff options
context:
space:
mode:
authorDhravya Shah <[email protected]>2025-04-06 13:04:27 -0700
committerDhravya Shah <[email protected]>2025-04-06 13:04:27 -0700
commite212f6833dd819bd6c8a0101172e9278a523b222 (patch)
tree4d9904234b33e550f08b51fdee4ee9befe38cc37 /apps/docs/api-reference
parentDocumentation edits made through Mintlify web editor (diff)
downloadsupermemory-e212f6833dd819bd6c8a0101172e9278a523b222.tar.xz
supermemory-e212f6833dd819bd6c8a0101172e9278a523b222.zip
Documentation edits made through Mintlify web editor
Diffstat (limited to 'apps/docs/api-reference')
-rw-r--r--apps/docs/api-reference/endpoints/memory-management/post-add.mdx53
1 files changed, 53 insertions, 0 deletions
diff --git a/apps/docs/api-reference/endpoints/memory-management/post-add.mdx b/apps/docs/api-reference/endpoints/memory-management/post-add.mdx
index 2dd4b40a..95cba75e 100644
--- a/apps/docs/api-reference/endpoints/memory-management/post-add.mdx
+++ b/apps/docs/api-reference/endpoints/memory-management/post-add.mdx
@@ -4,3 +4,56 @@ openapi: post /add
Add a new memory with content and metadata.
+Fields:
+
+`content`: string
+
+`id`: string
+
+`metadata`: Record
+
+The `content` can be of the following types:
+
+- note / Markdown
+
+ - If it is a markdown, all the images inside `![]` image tags will automatically be parsed.
+
+- pdf
+
+- tweet
+
+- google_doc
+
+- notion_doc
+
+- webpage URL
+
+ - Images and other content is also intelligently parsed in case of a webpage.
+
+
+The metadata provided is a JSON object.
+
+for eg.
+
+``` json
+{
+ "classId": "21412",
+ "year": "fifth"
+}
+
+ ```
+
+If you wish to do exact searches, please use strings. But if you want to search in a range (time, numbers, prices), you can use numbers too.
+
+``` json
+{
+ "price": 1250
+}
+
+ ```
+
+More about \[metadata filtering here\]([https://docs.supermemory.ai/essentials/metadata-filtering](https://docs.supermemory.ai/essentials/metadata-filtering))
+
+The `id` is optional. If provided, supermemory will store the same ID as your internal database. This can help for retrieval purposes.
+
+If the `id` already exists, supermemory will update it instead. \ No newline at end of file