Link Search Menu Expand Document Documentation Menu
Documentation

Get Agentic Memory API

Introduced 3.3

Use this API to retrieve a specific memory by its type and ID. This unified API supports the four memory types: sessions, working, long-term, and history.

Endpoints

GET /_plugins/_ml/memory_containers/{memory_container_id}/memories/{type}/{id}

Path parameters

The following table lists the available path parameters.

Parameter Data type Required/Optional Description
memory_container_id String Required The ID of the memory container from which to retrieve the memory.
type String Required The memory type. Valid values are sessions, working, long-term, and history.
id String Required The ID of the memory to retrieve.

Example request: Get a working memory

GET /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU/memories/working/XyEuiJkBeh2gPPwzjYWM

Example response: Working memory

{
  "memory_container_id": "HudqiJkB1SltqOcZusVU",
  "payload_type": "conversational",
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "I'm Bob, I really like swimming.",
          "type": "text"
        }
      ]
    },
    {
      "role": "assistant",
      "content": [
        {
          "text": "Cool, nice. Hope you enjoy your life.",
          "type": "text"
        }
      ]
    }
  ],
  "namespace": {
    "user_id": "bob",
    "session_id": "S-dqiJkB1SltqOcZ1cYO"
  },
  "namespace_size": 2,
  "infer": true,
  "metadata": {
    "branch": "{\"root_event_id\":\"228nadfs879mtgk\",\"branch_name\":\"high\"}",
    "status": "checkpoint"
  },
  "tags": {
    "topic": "personal info"
  },
  "created_time": 1758930326804,
  "last_updated_time": 1758930326804
}

Example request: Get a long-term memory

GET /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU/memories/long-term/DcxjTpkBvwXRq366C1Zz

Example response: Long-term memory

{
  "memory": "Kubernetes RBAC permission issues detected with CloudWatch agents experiencing persistent permission denials",
  "strategy_type": "SUMMARY",
  "tags": {
    "agent_type": "chat_agent",
    "conversation": "true"
  },
  "namespace": {
    "agent_id": "chat-agent"
  },
  "namespace_size": 1,
  "created_time": 1760052801773,
  "last_updated_time": 1760052801773,
  "memory_embedding": [0.018510794, 0.056366503, "..."],
  "owner_id": "admin",
  "strategy_id": "summary_96f04d97"
}

Example request: Get a session

GET /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU/memories/sessions/CcxjTpkBvwXRq366A1aE

Example response: Session

{
  "memory_container_id": "HudqiJkB1SltqOcZusVU",
  "summary": "This is a test session",
  "created_time": 1757956735881,
  "last_updated_time": 1757956735881,
  "namespace": {
    "user_id": "bob"
  }
}

Example request: Get a history memory

GET /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU/memories/history/eMxnTpkBvwXRq366hmAU

Example response: History

{
  "owner_id": "admin",
  "memory_container_id": "nrJBy5kByIxXWyhQjmqv",
  "memory_id": "4bJMy5kByIxXWyhQvGr9",
  "action": "ADD",
  "after": {
    "memory": "A comprehensive security investigation was performed across multiple data sources including 55 OpenSearch indices, 50 CloudTrail events, 22 VPC Flow logs, 38 WAF events, 74 CloudWatch log groups, active CloudWatch alarms, and OpenSearch cluster security configuration."
  },
  "namespace": {
    "agent_id": "chat-agent"
  },
  "namespace_size": 1,
  "tags": {
    "agent_type": "chat_agent",
    "conversation": "true"
  },
  "created_time": 1760052428089
}

Response fields

The response fields vary depending on the memory type.

Working memory response fields

The following table lists all working memory response body fields.

Field Data type Description
memory_container_id String The ID of the memory container.
payload_type String The type of payload. Valid values are conversational and data.
messages Array Array of conversation messages (applicable only to the conversational payload type).
structured_data Object The structured data content (applicable only to the data payload type).
structured_data_blob Object The structured data stored without indexing.
binary_data String The Base64-encoded binary data content.
message_id Integer The sequence number of the message in a conversation.
checkpoint_id String The checkpoint identifier stored with the memory.
namespace Object The namespace context for this memory.
namespace_size Integer The number of namespace fields.
owner_id String The ID of the memory owner. Present only when the Security plugin is enabled.
metadata Object Additional metadata associated with the memory.
tags Object Associated tags for categorization.
infer Boolean Whether inference was enabled for this memory.
created_time Long The timestamp of when the memory was created.
last_updated_time Long The timestamp of when the memory was last updated.

Long-term memory response fields

The following table lists all long-term memory response body fields.

Field Data type Description
memory String The extracted long-term memory fact.
strategy_type String The type of memory strategy used (for example, SEMANTIC, SUMMARY, or USER_PREFERENCE).
namespace Object The namespace context for this memory.
namespace_size Integer The number of namespaces.
tags Object Associated tags for categorization.
created_time Long The timestamp when the memory was created.
last_updated_time Long The timestamp when the memory was last updated.
memory_embedding Array The vector embedding of the memory content (truncated in display).
owner_id String The ID of the memory owner.
strategy_id String The unique identifier for the strategy instance.
pinned Boolean Whether the memory is pinned and exempt from the container’s retention policy.

Session response fields

The following table lists all session response body fields.

Field Data type Description
memory_container_id String The ID of the memory container.
summary String The session summary.
metadata Object Additional metadata associated with the session.
agents Object Information about the agents that participate in the session.
additional_info Object Additional information about the session.
namespace Object The namespace context for this session.
owner_id String The ID of the session owner. Present only when the Security plugin is enabled.
pinned Boolean Whether the session is pinned and exempt from the container’s retention policy.
created_time Long The timestamp of when the session was created.
last_updated_time Long The timestamp of when the session was last updated.

History response fields

The following table lists all history response body fields.

Field Data type Description
owner_id String The ID of the memory owner.
memory_container_id String The ID of the memory container.
memory_id String The ID of the affected memory.
action String The type of operation: ADD, UPDATE, or DELETE.
after Object The memory content after the operation.
before Object The memory content before the operation (for UPDATE operations).
namespace Object The namespace context for this memory.
namespace_size Integer The number of namespaces.
tags Object Associated tags for categorization.
error String The error message if the operation failed.
created_time Long The timestamp of when the operation occurred.
350 characters left

Have a question? .

Want to contribute? or .