Error
User Memories
Delete User Memory
Permanently remove a specific user memory from storage.
This API allows you to delete a user memory by its unique identifier. Once deleted, the memory cannot be recovered, so use this operation carefully.
The memory will be removed from your tenant’s storage and will no longer appear in search results or memory listings.
DELETE
Error
Examples
- API Request
- TypeScript
- Python (Sync)
Overview
The Delete User Memory endpoint allows you to remove specific memories from a user’s memory profile. This is useful for maintaining data quality, removing outdated information, or giving users control over their stored personal data.Functionality
- Targeted Deletion: Removes a specific memory using its unique memory ID
- User Context Validation: Ensures the memory belongs to the authenticated user
- Immediate Removal: Permanently deletes the memory from the vector store
- Confirmation Response: Returns clear success/failure status for the deletion operation
- Tenant Isolation: Operates within the specified tenant/sub-tenant context
Use Cases
- Data Cleanup: Remove outdated or incorrect memories
- Privacy Compliance: Allow users to delete their personal data
- Memory Management: Maintain high-quality memory profiles by removing irrelevant information
- Error Correction: Delete memories that were added incorrectly
- User Control: Give users the ability to manage their own memory data
Important Notes
Memory ID Source: Memory IDs (source_id) can be obtained from the List User Memories endpoint or from the response of Add User Memory and Generate User Memory endpoints.
Best Practices:
- Always verify the memory content before deletion using the List endpoint
- Consider implementing user confirmation for memory deletion
- Log deletion activities for audit purposes
- Provide users with a way to review their memories before deletion
Response Fields
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates whether the operation was successful |
user_memory_deleted | boolean | Confirms whether the specific memory was successfully deleted |
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
tenant_id | string | Yes | Primary organizational identifier |
sub_tenant_id | string | Yes | Secondary organizational identifier |
memory_id | string | Yes | Unique identifier of the memory to delete |
Error Responses
All endpoints return consistent error responses following the standard format. For detailed error information, see our Error Responses documentation.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Tenant ID
Example:
"tenant_1234"
Unique identifier of the memory to delete
Example:
"memory_1234"
Sub-tenant ID
Example:
"sub_tenant_4567"