Add API Reference docs (#1742)
This commit is contained in:
4
docs/api-reference/entities/delete-user.mdx
Normal file
4
docs/api-reference/entities/delete-user.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: 'Delete User'
|
||||
openapi: delete /entities/{entity_type}/{entity_id}/
|
||||
---
|
||||
4
docs/api-reference/entities/get-users.mdx
Normal file
4
docs/api-reference/entities/get-users.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: 'Get Users'
|
||||
openapi: get /entities/
|
||||
---
|
||||
4
docs/api-reference/memory/add-memories.mdx
Normal file
4
docs/api-reference/memory/add-memories.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: 'Add Memories'
|
||||
openapi: post /memories/
|
||||
---
|
||||
4
docs/api-reference/memory/delete-memories.mdx
Normal file
4
docs/api-reference/memory/delete-memories.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: 'Delete Memories'
|
||||
openapi: delete /memories/
|
||||
---
|
||||
4
docs/api-reference/memory/delete-memory.mdx
Normal file
4
docs/api-reference/memory/delete-memory.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: 'Delete Memory'
|
||||
openapi: delete /memories/{memory_id}/
|
||||
---
|
||||
4
docs/api-reference/memory/get-memories.mdx
Normal file
4
docs/api-reference/memory/get-memories.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: 'Get Memories'
|
||||
openapi: get /memories/
|
||||
---
|
||||
4
docs/api-reference/memory/get-memory.mdx
Normal file
4
docs/api-reference/memory/get-memory.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: 'Get Memory'
|
||||
openapi: get /memories/{memory_id}/
|
||||
---
|
||||
4
docs/api-reference/memory/history-memory.mdx
Normal file
4
docs/api-reference/memory/history-memory.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: 'Memory History'
|
||||
openapi: get /memories/{memory_id}/history/
|
||||
---
|
||||
4
docs/api-reference/memory/search-memories.mdx
Normal file
4
docs/api-reference/memory/search-memories.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: 'Search Memories'
|
||||
openapi: post /memories/search/
|
||||
---
|
||||
4
docs/api-reference/memory/update-memory.mdx
Normal file
4
docs/api-reference/memory/update-memory.mdx
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: 'Update Memory'
|
||||
openapi: put /memories/{memory_id}/
|
||||
---
|
||||
34
docs/api-reference/overview.mdx
Normal file
34
docs/api-reference/overview.mdx
Normal file
@@ -0,0 +1,34 @@
|
||||
# Mem0 API Overview
|
||||
|
||||
Mem0 provides a powerful set of APIs that allow you to integrate advanced memory management capabilities into your applications. Our APIs are designed to be intuitive, efficient, and scalable, enabling you to create, retrieve, update, and delete memories across various entities such as users, agents, apps, and runs.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Memory Management**: Add, retrieve, update, and delete memories with ease.
|
||||
- **Entity-based Operations**: Perform operations on memories associated with specific users, agents, apps, or runs.
|
||||
- **Advanced Search**: Utilize our search API to find relevant memories based on various criteria.
|
||||
- **History Tracking**: Access the history of memory interactions for comprehensive analysis.
|
||||
- **User Management**: Manage user entities and their associated memories.
|
||||
|
||||
## API Structure
|
||||
|
||||
Our API is organized into several main categories:
|
||||
|
||||
1. **Memory APIs**: Core operations for managing individual memories and collections.
|
||||
2. **Entities APIs**: Manage different entity types (users, agents, etc.) and their associated memories.
|
||||
3. **Search API**: Advanced search functionality to retrieve relevant memories.
|
||||
4. **History API**: Track and retrieve the history of memory interactions.
|
||||
|
||||
## Authentication
|
||||
|
||||
All API requests require authentication using HTTP Basic Auth. Ensure you include your API key in the Authorization header of each request.
|
||||
|
||||
## Getting Started
|
||||
|
||||
To begin using the Mem0 API, you'll need to:
|
||||
|
||||
1. Sign up for a [Mem0 account](https://app.mem0.ai) and obtain your API key.
|
||||
2. Familiarize yourself with the API endpoints and their functionalities.
|
||||
3. Make your first API call to add or retrieve a memory.
|
||||
|
||||
Explore the detailed documentation for each API endpoint to learn more about request/response formats, parameters, and example usage.
|
||||
@@ -26,6 +26,11 @@
|
||||
"icon": "chart-simple",
|
||||
"url": "https://app.mem0.ai"
|
||||
},
|
||||
{
|
||||
"name": "API Reference",
|
||||
"url": "api-reference",
|
||||
"icon": "square-terminal"
|
||||
},
|
||||
{
|
||||
"name": "Discord",
|
||||
"icon": "discord",
|
||||
@@ -125,6 +130,32 @@
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "API Reference",
|
||||
"pages": [
|
||||
"api-reference/overview",
|
||||
{
|
||||
"group": "Memory APIs",
|
||||
"pages": [
|
||||
"api-reference/memory/get-memories",
|
||||
"api-reference/memory/add-memories",
|
||||
"api-reference/memory/delete-memories",
|
||||
"api-reference/memory/get-memory",
|
||||
"api-reference/memory/update-memory",
|
||||
"api-reference/memory/delete-memory",
|
||||
"api-reference/memory/search-memories",
|
||||
"api-reference/memory/history-memory"
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Entities APIs",
|
||||
"pages": [
|
||||
"api-reference/entities/get-users",
|
||||
"api-reference/entities/delete-user"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"group": "Integrations",
|
||||
"pages": [
|
||||
|
||||
1321
docs/openapi.json
Normal file
1321
docs/openapi.json
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user