Skip to main content
POST
/
api
/
v2
/
memories
/
list
List Memories
curl --request POST \
  --url http://localhost:8080/api/v2/memories/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "org_id": "universal",
  "project_id": "universal",
  "page_size": 100,
  "page_num": 0,
  "filter": "",
  "set_metadata": {},
  "type": "episodic"
}
'
{
  "content": {
    "episodic_memory": [
      {
        "uid": "<string>",
        "content": "<string>",
        "session_key": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "producer_id": "<string>",
        "producer_role": "<string>",
        "produced_for_id": "<string>",
        "sequence_num": 0,
        "episode_type": "message",
        "content_type": "string",
        "filterable_metadata": {},
        "metadata": {}
      }
    ],
    "semantic_memory": [
      {
        "category": "<string>",
        "tag": "<string>",
        "feature_name": "<string>",
        "value": "<string>",
        "set_id": "<string>",
        "metadata": {
          "citations": [
            "<string>"
          ],
          "id": "<string>",
          "other": {}
        }
      }
    ]
  },
  "status": 0
}

Body

application/json

Specification model for listing memories.

​
org_id
string
default:universal
The unique identifier of the organization.

- Must not contain slashes (`/`).
- Must contain only letters, numbers, underscores, hyphens, colon, and Unicode
  characters (e.g., Chinese/Japanese/Korean). No slashes or other symbols
  are allowed.

This value determines the namespace the project belongs to.
Examples:

"MemVerge"

"AI_Labs"

​
project_id
string
default:universal
The identifier of the project.

- Must be unique within the organization.
- Must not contain slashes (`/`).
- Must contain only letters, numbers, underscores, hyphens, colon, and Unicode
  characters (e.g., Chinese/Japanese/Korean). No slashes or other symbols
  are allowed.

This ID is used in API paths and resource locations.
Examples:

"memmachine"

"research123"

"qa_pipeline"

​
page_size
integer
default:100
The maximum number of memories to return per page. Use this for pagination.
Examples:

50

100

​
page_num
integer
default:0
The zero-based page number to retrieve. Use this for pagination.
Examples:

0

1

5

10

​
filter
string
default:""
An optional string filter applied to the memory metadata. This uses a
simple query language (e.g., 'metadata.user_id=123') for exact matches.
Multiple conditions can be combined using AND operators.  The metadata
fields are prefixed with 'metadata.' to distinguish them from other fields.
Example:

"metadata.user_id=123 AND metadata.session_id=abc"

​
set_metadata
Set Metadata · object
Optional metadata key-value pairs used to filter or identify semantic sets.
​
type
enum<string> | null
The specific memory type to list (e.g., episodic or semantic).
Available options:
semantic,
episodic
Example:

"episodic"

Response

Successful Response

Response model for memory list results.

​
content
ListResultContent · object
required
The dictionary containing the memory search results (e.g., list of memory
objects).
​
status
integer
default:0
The status code of the search operation. 0 typically indicates success.
Example:

0