Usage Instructions
Integrate Memory into the workflow. Can add, get a memory, get all memories, and delete memories.
Tools
memory_add
Add a new memory to the database or append to existing memory with the same ID.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
conversationId | string | No | Conversation identifier (e.g., user-123, session-abc). If a memory with this conversationId already exists for this block, the new message will be appended to it. |
id | string | No | Legacy parameter for conversation identifier. Use conversationId instead. Provided for backwards compatibility. |
role | string | Yes | Role for agent memory (user, assistant, or system) |
content | string | Yes | Content for agent memory |
blockId | string | No | Optional block ID. If not provided, uses the current block ID from execution context, or defaults to "default". |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Whether the memory was added successfully |
memories | array | Array of memory objects including the new or updated memory |
error | string | Error message if operation failed |
memory_get
Retrieve memory by conversationId, blockId, blockName, or a combination. Returns all matching memories.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
conversationId | string | No | Conversation identifier (e.g., user-123, session-abc). If provided alone, returns all memories for this conversation across all blocks. |
id | string | No | Legacy parameter for conversation identifier. Use conversationId instead. Provided for backwards compatibility. |
blockId | string | No | Block identifier. If provided alone, returns all memories for this block across all conversations. If provided with conversationId, returns memories for that specific conversation in this block. |
blockName | string | No | Block name. Alternative to blockId. If provided alone, returns all memories for blocks with this name. If provided with conversationId, returns memories for that conversation in blocks with this name. |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Whether the memory was retrieved successfully |
memories | array | Array of memory objects with conversationId, blockId, blockName, and data fields |
message | string | Success or error message |
error | string | Error message if operation failed |
memory_get_all
Retrieve all memories from the database
Input
| Parameter | Type | Required | Description |
|---|
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Whether all memories were retrieved successfully |
memories | array | Array of all memory objects with key, conversationId, blockId, blockName, and data fields |
message | string | Success or error message |
error | string | Error message if operation failed |
memory_delete
Delete memories by conversationId, blockId, blockName, or a combination. Supports bulk deletion.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
conversationId | string | No | Conversation identifier (e.g., user-123, session-abc). If provided alone, deletes all memories for this conversation across all blocks. |
id | string | No | Legacy parameter for conversation identifier. Use conversationId instead. Provided for backwards compatibility. |
blockId | string | No | Block identifier. If provided alone, deletes all memories for this block across all conversations. If provided with conversationId, deletes memories for that specific conversation in this block. |
blockName | string | No | Block name. Alternative to blockId. If provided alone, deletes all memories for blocks with this name. If provided with conversationId, deletes memories for that conversation in blocks with this name. |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Whether the memory was deleted successfully |
message | string | Success or error message |
error | string | Error message if operation failed |
Notes
- Category:
blocks - Type:
memory