Delete Memory API

Introduced 2.12

Use this API to delete a memory based on the memory_id.

When the Security plugin is enabled, all memories exist in a private security mode. Only the user who created a memory can interact with that memory and its messages.

Endpoints

DELETE /_plugins/_ml/memory/{memory_id}

Path parameters

The following table lists the available path parameters.

Example request

DELETE /_plugins/_ml/memory/MzcIJX8BA7mbufL6DOwl

Example response

{
  "success": true
}

Error responses

If you attempt to delete a memory that doesn’t exist, OpenSearch returns a 404 error:

{
  "error": {
    "root_cause": [
      {
        "type": "resource_not_found_exception",
        "reason": "Memory [MzcIJX8BA7mbufL6DOwl] not found"
      }
    ],
    "type": "resource_not_found_exception",
    "reason": "Memory [MzcIJX8BA7mbufL6DOwl] not found"
  },
  "status": 404
}