Skip to content

armgit / mem0

Public Imported from GitHub
0

The Memory Layer for AI Agents - Drop-in memory infrastructure for AI agents and apps. Context that persists. Built for production.

Doc: show output_format as param in API reference (#2053)

Dev Khantba9c2e68f928
diff --git a/docs/openapi.json b/docs/openapi.json
index 7ee09279c..818737c8c 100644
--- a/docs/openapi.json
+++ b/docs/openapi.json
@@ -3676,6 +3676,12 @@
"type": "boolean",
"default": true
},
+ "output_format": {
+ "description": "It two output formats: `v1.0` (default) and `v1.1`. To enable the latest format, which provides enhanced detail for each memory operation, set the output_format parameter to `v1.1`. Note that `v1.0` will be deprecated in version 0.1.35.",
+ "title": "Output format",
+ "type": "string",
+ "nullable": true
+ },
"custom_categories": {
"description": "A list of categories with category name and it's description.",
"title": "Custom categories",
@@ -3764,6 +3770,12 @@
"default": false,
"description": "Whether to rerank the memories."
},
+ "output_format": {
+ "title": "Output format",
+ "type": "string",
+ "nullable": true,
+ "description": "The search method supports two output formats: `v1.0` (default) and `v1.1`."
+ },
"org_name": {
"title": "Organization Name",
"type": "string",
diff --git a/docs/platform/quickstart.mdx b/docs/platform/quickstart.mdx
index 76cbc0570..881c73d6d 100644
--- a/docs/platform/quickstart.mdx
+++ b/docs/platform/quickstart.mdx
@@ -108,7 +108,29 @@ curl -X POST "https://api.mem0.ai/v1/memories/" \
```
```json Output (v1.0)
-{'message': 'ok'}
+[
+ {
+ "id": "a1b2c3d4-e5f6-4g7h-8i9j-k0l1m2n3o4p5",
+ "data": {
+ "memory": "Name is Alex"
+ },
+ "event": "ADD"
+ },
+ {
+ "id": "b2c3d4e5-f6g7-8h9i-j0k1-l2m3n4o5p6q7",
+ "data": {
+ "memory": "Is a vegetarian"
+ },
+ "event": "ADD"
+ },
+ {
+ "id": "c3d4e5f6-g7h8-9i0j-k1l2-m3n4o5p6q7r8",
+ "data": {
+ "memory": "Is allergic to nuts"
+ },
+ "event": "ADD"
+ }
+]
```
```json Output (v1.1)
{
@@ -186,7 +208,22 @@ curl -X POST "https://api.mem0.ai/v1/memories/" \
```
```json Output (v1.0)
-{'message': 'ok'}
+[
+ {
+ "id": "f2968654-5cd8-4d58-9f40-57ee339846b6",
+ "data": {
+ "memory": "Interested in vegetarian restaurants in Tokyo"
+ },
+ "event": "ADD"
+ },
+ {
+ "id": "f2968654-5cd8-4d58-9f40-57ee339846b6",
+ "data": {
+ "memory": "Planning a trip to Japan next month"
+ },
+ "event": "ADD"
+ }
+]
```
```json Output (v1.1)
@@ -249,7 +286,29 @@ curl -X POST "https://api.mem0.ai/v1/memories/" \
```
```json Output (v1.0)
-{'message': 'ok'}
+[
+ {
+ "id": "a1b2c3d4-e5f6-4g7h-8i9j-k0l1m2n3o4p5",
+ "data": {
+ "memory": "Name is Alex"
+ },
+ "event": "ADD"
+ },
+ {
+ "id": "b2c3d4e5-f6g7-8h9i-j0k1-l2m3n4o5p6q7",
+ "data": {
+ "memory": "Is a vegetarian"
+ },
+ "event": "ADD"
+ },
+ {
+ "id": "c3d4e5f6-g7h8-9i0j-k1l2-m3n4o5p6q7r8",
+ "data": {
+ "memory": "Is allergic to nuts"
+ },
+ "event": "ADD"
+ }
+]
```
```json Output (v1.1)