opensearch-docs-cn/_ml-commons-plugin/api/memory-apis/delete-memory.md

861 B

layout title parent grand_parent nav_order
default Delete memory Memory APIs ML Commons APIs 30

Delete a memory

Introduced 2.12 {: .label .label-purple }

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. {: .important}

Path and HTTP methods

DELETE /_plugins/_ml/memory/<memory_id>

Path parameters

The following table lists the available path parameters.

Parameter Data type Description
memory_id String The ID of the memory to be deleted.

Example request

DELETE /_plugins/_ml/memory/MzcIJX8BA7mbufL6DOwl

{% include copy-curl.html %}

Example response

{
  "success": true
}