klas/t6_mem0
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixes in API-reference page (#1763)

Browse Source
This commit is contained in:
Dev Khant
2024-08-27 23:01:33 +05:30
committed by GitHub
parent 06d6fe7d76
commit a279ed0694
3 changed files with 1611 additions and 1483 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api-reference/entities/delete-user.mdx
View File

@@ -1,4 +1,4 @@
--- ---
title: 'Delete User' title: 'Delete User'
openapi: delete /entities/{entity_type}/{entity_id}/ openapi: delete /v1/entities/{entity_type}/{entity_id}/
--- ---

2
docs/api-reference/entities/get-users.mdx
View File

@@ -1,4 +1,4 @@
--- ---
title: 'Get Users' title: 'Get Users'
openapi: get /entities/ openapi: get /v1/entities/
--- ---

228
docs/openapi.json
View File

@@ -18,7 +18,9 @@
], ],
"security": [ "security": [
{ {
"Basic":[] "ApiKeyAuth": [
]
} }
], ],
"paths": { "paths": {
@@ -169,6 +171,7 @@
"200": { "200": {
"description": "", "description": "",
"content": { "content": {
} }
} }
} }
@@ -184,6 +187,7 @@
"200": { "200": {
"description": "", "description": "",
"content": { "content": {
} }
} }
} }
@@ -193,16 +197,32 @@
"entities" "entities"
], ],
"operationId": "entities_delete", "operationId": "entities_delete",
"requestBody":{ "parameters": [
"content":{ {
"application/json":{ "name": "entity_type",
"in": "path",
"required": true,
"schema": { "schema": {
"$ref":"#/components/schemas/EntityInput" "type": "string",
} "enum": [
} "user",
"agent",
"app",
"run"
]
}, },
"required":true "description": "The type of the entity (user, agent, app, or run)"
}, },
{
"name": "entity_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The unique identifier of the entity"
}
],
"responses": { "responses": {
"204": { "204": {
"description": "Entity deleted successfully!", "description": "Entity deleted successfully!",
@@ -235,6 +255,7 @@
"200": { "200": {
"description": "", "description": "",
"content": { "content": {
} }
} }
} }
@@ -247,6 +268,50 @@
], ],
"description": "Get all memories", "description": "Get all memories",
"operationId": "memories_list", "operationId": "memories_list",
"parameters": [
{
"name": "user_id",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filter memories by user ID"
},
{
"name": "agent_id",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filter memories by agent ID"
},
{
"name": "app_id",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filter memories by app ID"
},
{
"name": "run_id",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filter memories by run ID"
},
{
"name": "metadata",
"in": "query",
"schema": {
"type": "object"
},
"description": "Filter memories by metadata (JSON string)",
"style": "deepObject",
"explode": true
}
],
"responses": { "responses": {
"200": { "200": {
"description": "", "description": "",
@@ -305,6 +370,22 @@
} }
} }
} }
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "One of the filters: app_id, user_id, agent_id, run_id is required!"
}
}
}
}
}
} }
} }
}, },
@@ -370,16 +451,50 @@
], ],
"description": "Delete memories", "description": "Delete memories",
"operationId": "memories_delete", "operationId": "memories_delete",
"requestBody":{ "parameters": [
"content":{ {
"application/json":{ "name": "user_id",
"in": "query",
"schema": { "schema": {
"$ref":"#/components/schemas/DeleteMemoriesInput" "type": "string"
}
}
}, },
"required":true "description": "Filter memories by user ID"
}, },
{
"name": "agent_id",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filter memories by agent ID"
},
{
"name": "app_id",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filter memories by app ID"
},
{
"name": "run_id",
"in": "query",
"schema": {
"type": "string"
},
"description": "Filter memories by run ID"
},
{
"name": "metadata",
"in": "query",
"schema": {
"type": "object"
},
"description": "Filter memories by metadata (JSON string)",
"style": "deepObject",
"explode": true
}
],
"responses": { "responses": {
"204": { "204": {
"description": "Successful deletion of memories", "description": "Successful deletion of memories",
@@ -410,6 +525,7 @@
"200": { "200": {
"description": "", "description": "",
"content": { "content": {
} }
} }
} }
@@ -647,6 +763,7 @@
"200": { "200": {
"description": "", "description": "",
"content": { "content": {
} }
} }
} }
@@ -677,16 +794,18 @@
], ],
"description": "Get a memory.", "description": "Get a memory.",
"operationId": "memories_read", "operationId": "memories_read",
"requestBody":{ "parameters": [
"content":{ {
"application/json":{ "name": "memory_id",
"in": "path",
"required": true,
"schema": { "schema": {
"$ref":"#/components/schemas/GetMemoryInput" "type": "string",
} "format": "uuid"
}
},
"required":true
}, },
"description": "The unique identifier of the memory to retrieve"
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Successfully retrieved the memory", "description": "Successfully retrieved the memory",
@@ -770,16 +889,18 @@
], ],
"description": "Get or Update or delete a memory.", "description": "Get or Update or delete a memory.",
"operationId": "memories_update", "operationId": "memories_update",
"requestBody":{ "parameters": [
"content":{ {
"application/json":{ "name": "memory_id",
"in": "path",
"required": true,
"schema": { "schema": {
"$ref":"#/components/schemas/UpdateMemoryInput" "type": "string",
} "format": "uuid"
}
},
"required":true
}, },
"description": "The unique identifier of the memory to retrieve"
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Successfully updated memory", "description": "Successfully updated memory",
@@ -849,16 +970,18 @@
], ],
"description": "Get or Update or delete a memory.", "description": "Get or Update or delete a memory.",
"operationId": "memories_delete", "operationId": "memories_delete",
"requestBody":{ "parameters": [
"content":{ {
"application/json":{ "name": "memory_id",
"in": "path",
"required": true,
"schema": { "schema": {
"$ref":"#/components/schemas/GetMemoryInput" "type": "string",
} "format": "uuid"
}
},
"required":true
}, },
"description": "The unique identifier of the memory to retrieve"
}
],
"responses": { "responses": {
"204": { "204": {
"description": "Successful deletion of memory", "description": "Successful deletion of memory",
@@ -886,16 +1009,18 @@
], ],
"description": "Retrieve the history of a memory.", "description": "Retrieve the history of a memory.",
"operationId": "memories_history_list", "operationId": "memories_history_list",
"requestBody":{ "parameters": [
"content":{ {
"application/json":{ "name": "memory_id",
"in": "path",
"required": true,
"schema": { "schema": {
"$ref":"#/components/schemas/GetMemoryInput" "type": "string",
} "format": "uuid"
}
},
"required":true
}, },
"description": "The unique identifier of the memory to retrieve"
}
],
"responses": { "responses": {
"200": { "200": {
"description": "Successfully retrieved the memory history", "description": "Successfully retrieved the memory history",
@@ -1041,6 +1166,7 @@
"200": { "200": {
"description": "", "description": "",
"content": { "content": {
} }
} }
} }
@@ -1472,9 +1598,11 @@
} }
}, },
"securitySchemes": { "securitySchemes": {
"Basic":{ "ApiKeyAuth": {
"type":"http", "type": "apiKey",
"scheme":"basic" "in": "header",
"name": "Authorization",
"description": "API key authentication. Prefix your Mem0 API key with 'Token '. Example: 'Token your_api_key'"
} }
} }
}, },