Hit the Try it button to try this API now in our playground. It’s the best way to check the full request and response in one place, customize your parameters, and generate ready-to-use code snippets.
Examples
API Request
TypeScript
Python (Sync)
curl -X 'DELETE' \
'https://api.usecortex.ai/memories/delete-memory?tenant_id=tenant_123&memory_id=memory_123' \
-H 'accept: application/json'
--header 'Authorization: Bearer YOUR_API_KEY'
const result = await client.userMemory.deleteUserMemory({
tenant_id: "tenant_1234",
memory_id: "memory_1234",
sub_tenant_id: "sub_tenant_4567"
});
# Async usage is similar, just use async_client and await
result = client.user_memory.delete_user_memory(
tenant_id="tenant_1234",
memory_id="memory_1234",
sub_tenant_id="sub_tenant_4567"
)
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
Permanent Deletion: Once a memory is deleted, it cannot be recovered. Make sure you have the correct memory ID before proceeding with deletion.
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
Pro Tip: For bulk memory management, you can combine this API with the List API to create a memory management interface that allows users to review and selectively delete their memories.
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.Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Unique identifier of the memory to delete
Response model for deleting a user memory.
Confirms whether the specific memory was successfully deleted
Indicates whether the memory deletion operation was successful