diff options
Diffstat (limited to 'apps/docs/api-reference')
3 files changed, 60 insertions, 1 deletions
diff --git a/apps/docs/api-reference/endpoints/connect/connect-app.mdx b/apps/docs/api-reference/endpoints/connect/connect-app.mdx new file mode 100644 index 00000000..d423191d --- /dev/null +++ b/apps/docs/api-reference/endpoints/connect/connect-app.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /connect/{app} +---
\ No newline at end of file diff --git a/apps/docs/api-reference/endpoints/connect/connection-information.mdx b/apps/docs/api-reference/endpoints/connect/connection-information.mdx new file mode 100644 index 00000000..4bd17823 --- /dev/null +++ b/apps/docs/api-reference/endpoints/connect/connection-information.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /connections/{connectionId} +---
\ No newline at end of file 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 d3785614..95cba75e 100644 --- a/apps/docs/api-reference/endpoints/memory-management/post-add.mdx +++ b/apps/docs/api-reference/endpoints/memory-management/post-add.mdx @@ -2,5 +2,58 @@ openapi: post /add --- +Add a new memory with content and metadata. -If i write something here, what happens?
\ No newline at end of file +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 |