Skip to main content

Delete Memory

Deletes specific memory entries for a user. Because core and general memories are stored and managed differently, this operation is split across two distinct endpoints. You must call the appropriate endpoint corresponding to the memory's type.

HTTP Request

Delete General Memories: POST /delete_memory/general

Delete Core Memories: POST /delete_memory/core

Request Body

Both endpoints accept the exact same JSON request body payload. You can delete multiple memories in a single request by providing an array of memory IDs.

ParameterTypeRequiredDescription
userIdstringYesThe unique identifier (userId) of the user who owns the memories.
memoryIdarrayYesA list of strings representing the unique IDs (memory_id) of the memories to be deleted.

Example Request Payload:

{
"userId": "user_123",
"memoryId": [
"79b9c8ec-0339-11f1-a602-00155d2a2ba4",
"8ab9c8ec-0440-11f1-a602-00155d2a2bb5"
]
}

Response

Success Response

  • Status Code: 200 OK
  • Content-Type: application/json

Returns a simple confirmation message upon successful deletion.

Example Response:

{
"message": "Deletion was successful"
}

Error Responses

The API will return standard HTTP status codes along with a brief error message if the operation fails.

Status CodeMessageReason
400 Bad RequestBad requestThe JSON payload was malformed, missing required fields, or could not be processed.
500 Internal Server ErrorDeletion failedThe server encountered a backend error while attempting to remove the records from the datastore.