JDSS/mem0
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add events API docs and spec updates (#3752)

Browse Source
This commit is contained in:
Deshraj Yadav
2025-11-14 20:53:31 -08:00
committed by GitHub
parent e29220efda
commit 97cbff77ef
5 changed files with 269 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-reference.mdx
+4
View File
@@ -56,6 +56,10 @@ Explore the full API organized by functionality:
Core and advanced operations: CRUD, search, batch updates, history, and exports
</Card>
<Card title="Events APIs" icon="clock" href="/api-reference/events/get-events">
Track and monitor the status of asynchronous memory operations
</Card>
<Card title="Entities APIs" icon="users" href="/api-reference/entities/get-users">
Manage users, agents, and their associated memory data
</Card>
docs/api-reference/events/get-event.mdx
+6
View File
@@ -0,0 +1,6 @@
---
title: 'Get Event'
openapi: get /v1/event/{event_id}/
---
Retrieve details about a specific event by passing its `event_id`. This endpoint is particularly helpful for tracking the status, payload, and completion details of asynchronous memory operations.
docs/api-reference/events/get-events.mdx
+13
View File
@@ -0,0 +1,13 @@
---
title: 'Get Events'
openapi: get /v1/events/
---
List recent events for your organization and project.
## Use Cases
- **Dashboards**: Summarize adds/searches over time by paging through events.
- **Alerting**: Poll for `FAILED` events and trigger follow-up workflows.
- **Audit**: Store the returned payload/metadata for compliance logs.
docs/docs.json
+47 -13
View File
@@ -12,7 +12,7 @@
"navigation": {
"versions": [
{
"version": "v1.0.0",
"version": "v1.0.1",
"anchors": [
{
"anchor": "Documentation",
@@ -24,7 +24,9 @@
{
"group": "Start Here",
"icon": "home",
"pages": ["introduction"]
"pages": [
"introduction"
]
}
]
},
@@ -105,7 +107,9 @@
{
"group": "Support & Troubleshooting",
"icon": "life-buoy",
"pages": ["platform/faqs"]
"pages": [
"platform/faqs"
]
},
{
"group": "Migration Guide",
@@ -119,7 +123,9 @@
{
"group": "Contribute",
"icon": "clipboard-list",
"pages": ["platform/contribute"]
"pages": [
"platform/contribute"
]
}
]
},
@@ -274,7 +280,10 @@
{
"group": "Community & Support",
"icon": "users",
"pages": ["contributing/development", "contributing/documentation"]
"pages": [
"contributing/development",
"contributing/documentation"
]
}
]
},
@@ -298,7 +307,9 @@
{
"group": "Getting Started",
"icon": "lightbulb",
"pages": ["cookbooks/overview"]
"pages": [
"cookbooks/overview"
]
},
{
"group": "Essentials",
@@ -369,7 +380,9 @@
{
"group": "Overview",
"icon": "plug",
"pages": ["integrations"]
"pages": [
"integrations"
]
},
{
"group": "Agent Frameworks",
@@ -399,7 +412,9 @@
{
"group": "Cloud & Infrastructure",
"icon": "cloud",
"pages": ["integrations/aws-bedrock"]
"pages": [
"integrations/aws-bedrock"
]
},
{
"group": "Developer Tools",
@@ -421,7 +436,10 @@
{
"group": "Getting Started",
"icon": "rocket",
"pages": ["api-reference", "api-reference/organizations-projects"]
"pages": [
"api-reference",
"api-reference/organizations-projects"
]
},
{
"group": "Core Memory Operations",
@@ -448,6 +466,14 @@
"api-reference/memory/delete-memories"
]
},
{
"group": "Events APIs",
"icon": "clock",
"pages": [
"api-reference/events/get-events",
"api-reference/events/get-event"
]
},
{
"group": "Entities APIs",
"icon": "users",
@@ -498,12 +524,16 @@
{
"group": "Changelog",
"icon": "rocket",
"pages": ["changelog"]
"pages": [
"changelog"
]
},
{
"group": "Legacy Docs",
"icon": "archive",
"pages": ["v0x/introduction"]
"pages": [
"v0x/introduction"
]
}
]
}
@@ -524,7 +554,11 @@
{
"group": "Getting Started",
"icon": "rocket",
"pages": ["v0x/introduction", "v0x/quickstart", "v0x/faqs"]
"pages": [
"v0x/introduction",
"v0x/quickstart",
"v0x/faqs"
]
},
{
"group": "Core Concepts",
@@ -1040,4 +1074,4 @@
"destination": "/platform/features/memory-export"
}
]
}
}
docs/openapi.json
+199 -3
View File
@@ -359,13 +359,209 @@
"tags": [
"events"
],
"summary": "Retrieve all events for the currently logged-in user.",
"description": "This endpoint returns a paginated list of events associated with the authenticated user.\nYou can filter the events by event type, start date, and end date.\n\nQuery Parameters:\n- event_type: Filter by event type (ADD or SEARCH)\n- start_date: Filter events after this date (format: YYYY-MM-DD)\n- end_date: Filter events before this date (format: YYYY-MM-DD)\n- page: Page number for pagination\n- page_size: Number of items per page (default: 50, max: 100)",
"summary": "Retrieve all events for current organization and project.",
"operationId": "events_list",
"responses": {
"200": {
"description": "Successfully retrieved events.",
"content": {}
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Total number of events matching the filters."
},
"next": {
"type": "string",
"nullable": true,
"description": "URL for the next page of results."
},
"previous": {
"type": "string",
"nullable": true,
"description": "URL for the previous page of results."
},
"results": {
"type": "array",
"description": "Array of event objects.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the event."
},
"event_type": {
"type": "string",
"description": "The type of event (e.g., ADD, SEARCH)."
},
"status": {
"type": "string",
"enum": [
"PENDING",
"RUNNING",
"FAILED",
"SUCCEEDED"
],
"description": "The current status of the event."
},
"payload": {
"type": "object",
"description": "The original payload associated with the event."
},
"metadata": {
"type": "object",
"nullable": true,
"description": "Additional metadata associated with the event."
},
"results": {
"type": "array",
"description": "Array of results produced by the event."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the event was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the event was last updated."
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when event processing started."
},
"completed_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when event processing completed."
},
"latency": {
"type": "number",
"description": "Processing time in milliseconds."
}
}
}
}
},
"required": [
"count",
"results"
]
}
}
}
}
}
}
},
"/v1/event/{event_id}/": {
"get": {
"tags": [
"events"
],
"summary": "Retrieve details of a specific event by its ID.",
"operationId": "event_read",
"parameters": [
{
"name": "event_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "The unique identifier of the event (UUID)."
}
],
"responses": {
"200": {
"description": "Successfully retrieved event details.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the event."
},
"event_type": {
"type": "string",
"description": "The type of event (e.g., ADD, SEARCH)."
},
"status": {
"type": "string",
"enum": [
"PENDING",
"RUNNING",
"FAILED",
"SUCCEEDED"
],
"description": "The current status of the event."
},
"payload": {
"type": "object",
"description": "The original payload associated with the event."
},
"metadata": {
"type": "object",
"nullable": true,
"description": "Additional metadata associated with the event."
},
"results": {
"type": "array",
"description": "Array of results produced by the event."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the event was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the event was last updated."
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when event processing started."
},
"completed_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when event processing completed."
},
"latency": {
"type": "number",
"description": "Processing time in milliseconds."
}
}
}
}
}
},
"404": {
"description": "Event not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
}
}
}
}
}
}
}
}