Merge pull request #179 from crestalnetwork/docs/memory-cleanup

Doc: agent's memory cleanup
crestalnetwork · Feb 6, 2025 · f9e8be4 · Beni67290 · Feb 6, 2025 · f9e8be4
2 parents 15ef5e1 + b458bc0
commit f9e8be4
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/how_to/clean_memory.md b/docs/how_to/clean_memory.md
@@ -0,0 +1,20 @@
+# Agent's Memory Cleanup
+
+Agent memory can be cleared using a request that requires an admin JWT token for authentication. This functionality allows for granular control:
+
+- **Clear all agent memory**: Reset the entire memory state of the agent.
+- **Clear thread memory**: Clear memory specifically associated with a particular thread within the agent.
+
+> The `thread_id` parameter is used to specify the target thread for memory clearing.
+
+```bash
+curl --location '{base_url}/agents/clean-memory' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Bearer {jwt_token}' \
+--data '{
+    "agent_id": "local",
+    "thread_id": "chat1",
+    "clean_agent_memory": true,
+    "clean_skills_memory": true
+}'
+```
diff --git a/docs/how_to/readme.md b/docs/how_to/readme.md
@@ -0,0 +1,5 @@
+# How to
+
+## Contents
+
+- [Clean Agent or Thread memory](./clean_memory.md)