Get memory

TypeScript SDK

import { Supermemory } from "supermemory";

const client = new Supermemory(); // reads SUPERMEMORY_API_KEY

const memory = await client.memories.get("user_123", "mem_abc123", {
  include: ["related", "documents"],
});
console.log(memory.memory, memory.isLatest);

from supermemory import Supermemory

client = Supermemory()  # reads SUPERMEMORY_API_KEY

memory = client.memories.get("user_123", "mem_abc123", include=["related", "documents"])
print(memory.memory, memory.is_latest)

{
  "id": "<string>",
  "memory": "<string>",
  "metadata": {},
  "isStatic": true,
  "isInference": true,
  "isLatest": true,
  "isForgotten": true,
  "version": 0,
  "system": {
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "included": {
    "related": {
      "parents": [
        {
          "id": "<string>",
          "relation": "updates",
          "memory": "<string>",
          "metadata": {},
          "system": {
            "updatedAt": "<string>"
          },
          "version": 123,
          "document": {
            "id": "<string>",
            "title": "<string>",
            "type": "<string>",
            "metadata": {},
            "summary": "<string>",
            "system": {
              "createdAt": "<string>",
              "updatedAt": "<string>"
            }
          }
        }
      ],
      "children": [
        {
          "id": "<string>",
          "relation": "updates",
          "memory": "<string>",
          "metadata": {},
          "system": {
            "updatedAt": "<string>"
          },
          "version": 123,
          "document": {
            "id": "<string>",
            "title": "<string>",
            "type": "<string>",
            "metadata": {},
            "summary": "<string>",
            "system": {
              "createdAt": "<string>",
              "updatedAt": "<string>"
            }
          }
        }
      ],
      "siblings": [
        {
          "id": "<string>",
          "relation": "updates",
          "memory": "<string>",
          "metadata": {},
          "system": {
            "updatedAt": "<string>"
          },
          "version": 123,
          "document": {
            "id": "<string>",
            "title": "<string>",
            "type": "<string>",
            "metadata": {},
            "summary": "<string>",
            "system": {
              "createdAt": "<string>",
              "updatedAt": "<string>"
            }
          }
        }
      ]
    },
    "document": {
      "id": "<string>",
      "title": "<string>",
      "type": "<string>",
      "metadata": {},
      "summary": "<string>",
      "system": {
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

{
  "error": "Invalid request parameters",
  "details": "Query must be at least 1 character long"
}

{
  "error": "Invalid request parameters",
  "details": "Query must be at least 1 character long"
}

{
  "error": "Invalid request parameters",
  "details": "Query must be at least 1 character long"
}

{
  "error": "Invalid request parameters",
  "details": "Query must be at least 1 character long"
}

{
  "error": "Invalid request parameters",
  "details": "Query must be at least 1 character long"
}

GET

{namespace}

memories

{id}

TypeScript SDK

import { Supermemory } from "supermemory";

const client = new Supermemory(); // reads SUPERMEMORY_API_KEY

const memory = await client.memories.get("user_123", "mem_abc123", {
  include: ["related", "documents"],
});
console.log(memory.memory, memory.isLatest);

from supermemory import Supermemory

client = Supermemory()  # reads SUPERMEMORY_API_KEY

memory = client.memories.get("user_123", "mem_abc123", include=["related", "documents"])
print(memory.memory, memory.is_latest)

{
  "id": "<string>",
  "memory": "<string>",
  "metadata": {},
  "isStatic": true,
  "isInference": true,
  "isLatest": true,
  "isForgotten": true,
  "version": 0,
  "system": {
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "included": {
    "related": {
      "parents": [
        {
          "id": "<string>",
          "relation": "updates",
          "memory": "<string>",
          "metadata": {},
          "system": {
            "updatedAt": "<string>"
          },
          "version": 123,
          "document": {
            "id": "<string>",
            "title": "<string>",
            "type": "<string>",
            "metadata": {},
            "summary": "<string>",
            "system": {
              "createdAt": "<string>",
              "updatedAt": "<string>"
            }
          }
        }
      ],
      "children": [
        {
          "id": "<string>",
          "relation": "updates",
          "memory": "<string>",
          "metadata": {},
          "system": {
            "updatedAt": "<string>"
          },
          "version": 123,
          "document": {
            "id": "<string>",
            "title": "<string>",
            "type": "<string>",
            "metadata": {},
            "summary": "<string>",
            "system": {
              "createdAt": "<string>",
              "updatedAt": "<string>"
            }
          }
        }
      ],
      "siblings": [
        {
          "id": "<string>",
          "relation": "updates",
          "memory": "<string>",
          "metadata": {},
          "system": {
            "updatedAt": "<string>"
          },
          "version": 123,
          "document": {
            "id": "<string>",
            "title": "<string>",
            "type": "<string>",
            "metadata": {},
            "summary": "<string>",
            "system": {
              "createdAt": "<string>",
              "updatedAt": "<string>"
            }
          }
        }
      ]
    },
    "document": {
      "id": "<string>",
      "title": "<string>",
      "type": "<string>",
      "metadata": {},
      "summary": "<string>",
      "system": {
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}

{
  "error": "Invalid request parameters",
  "details": "Query must be at least 1 character long"
}

{
  "error": "Invalid request parameters",
  "details": "Query must be at least 1 character long"
}

{
  "error": "Invalid request parameters",
  "details": "Query must be at least 1 character long"
}

{
  "error": "Invalid request parameters",
  "details": "Query must be at least 1 character long"
}

{
  "error": "Invalid request parameters",
  "details": "Query must be at least 1 character long"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

namespace

string

required

Namespace containing the memories to forget. This can be an ID for your user, a project ID, or any other identifier you wish to use to scope memories.

Maximum string length: 100

Pattern: ^[a-zA-Z0-9_:-]+$

Example:

"user_alex"

string

required

Memory identifier

Minimum string length: 1

Example:

"mem_abc123"

Query Parameters

include

enum<string>[]

Comma-separated extras. related: the memory's version history and connected memories. documents: the source document, also attached to each related memory when both are requested.

Available options:

related,

documents

Maximum parents, children and siblings to return, applied to each list separately. Parents and children are earlier and later versions up to three steps away, nearest first; siblings are direct extends or derives links.

Required range: 1 <= x <= 100

Response

Memory retrieved

string

required

Stable memory identifier

memory

string

required

Learned fact or context extracted from the document

metadata

object

required

Memory metadata, including temporal context; empty object when none

Show child attributes

isStatic

boolean

required

Whether the memory belongs to the stable profile section

isInference

boolean

required

Whether the memory was inferred rather than explicitly stated

isLatest

boolean

required

Whether this is the newest version in its memory chain

isForgotten

boolean

required

Whether this memory has been excluded from normal recall

version

integer

required

Version number within the memory chain

Required range: -9007199254740991 <= x <= 9007199254740991

system

object

required

Lifecycle timestamps maintained by Supermemory

Show child attributes

included

object

Requested extras

Show child attributes

Ingest

Content Management

Search

Profiles

Namespaces

Connectors

Organization

Feedback

Authorizations

Path Parameters

Query Parameters

Response