Skip to main content

​
Overview

The ListMemoriesOptions interface provides control over the retrieval of multiple memory records, enabling pagination and broad filtering across the memory store.

​
Properties

PropertyTypeDescription
typeMemoryTypeOptional. Restricts the list to specific memory classifications (e.g., episodic).
filterstringOptional. Structured filter criteria. User metadata fields must be prefixed with m. / metadata. (for example m.source = "chat_v3"). Unsupported fields are rejected.
page_numnumberOptional. The specific page index to retrieve (defaults to 1).
page_sizenumberOptional. The number of records to return per page.

​
Usage Example

import { ListMemoriesOptions } from '@memmachine/client';

const options: ListMemoriesOptions = {
  type: 'episodic',
  filter: 'm.source = "chat_v3"',
  page_num: 2,
  page_size: 20
};

const history = await memory.list(options);