Quickstart

pip install memoryos openai

npm install @memoryos/sdk openai

import os

from memoryos import Memory


def main() -> None:
    client = Memory(api_key=os.environ["MEMORYOS_API_KEY"])

    result = client.add(
        messages=[
            {
                "role": "user",
                "content": "Please remember that I prefer concise technical explanations and Python examples.",
            }
        ],
        external_user_id="customer-123",
        metadata={"source": "quickstart"},
    )

    print(result.status)
    print(result.quota_mode)
    client.close()


if __name__ == "__main__":
    main()

import { MemoryOS } from "@memoryos/sdk";

async function main(): Promise<void> {
  const client = new MemoryOS(process.env.MEMORYOS_API_KEY!);

  const result = await client.add(
    [
      {
        role: "user",
        content: "Please remember that I prefer concise technical explanations and Python examples.",
      },
    ],
    "customer-123",
    undefined,
    { source: "quickstart" },
  );

  console.log(result.status);
  console.log(result.quotaMode);
}

void main();

import os

from memoryos import Memory


def main() -> None:
    client = Memory(api_key=os.environ["MEMORYOS_API_KEY"])

    memories = client.get(
        query="How should I answer this user?",
        external_user_id="customer-123",
        limit=5,
    )

    print(memories.quota_mode)
    print(memories.context_token_count)
    print(memories.system_prompt_addition if memories.has_context else "")
    for item in memories.items:
        print(item.content)

    client.close()


if __name__ == "__main__":
    main()

import { MemoryOS } from "@memoryos/sdk";

async function main(): Promise<void> {
  const client = new MemoryOS(process.env.MEMORYOS_API_KEY!);

  const memories = await client.get(
    "How should I answer this user?",
    "customer-123",
    5,
  );

  console.log(memories.quotaMode);
  console.log(memories.contextTokenCount);
  console.log(memories.hasContext ? memories.systemPromptAddition : "");
  for (const item of memories.items) {
    console.log(item.content);
  }
}

void main();

import os

from memoryos import Memory
from openai import OpenAI


def main() -> None:
    memory = Memory(api_key=os.environ["MEMORYOS_API_KEY"])
    openai_client = OpenAI(api_key=os.environ["OPENAI_API_KEY"])

    external_user_id = "customer-123"
    user_message = "What kind of answer format do I like?"

    memories = memory.get(
        query=user_message,
        external_user_id=external_user_id,
        limit=5,
    )

    system_prompt = "You are a helpful assistant."
    if memories.has_context:
        system_prompt = f"{system_prompt}\n\n{memories.system_prompt_addition}"

    response = openai_client.responses.create(
        model="gpt-4.1-mini",
        input=[
            {"role": "system", "content": system_prompt},
            {"role": "user", "content": user_message},
        ],
    )

    print(response.output_text)
    memory.close()


if __name__ == "__main__":
    main()

import OpenAI from "openai";
import { MemoryOS } from "@memoryos/sdk";

async function main(): Promise<void> {
  const memory = new MemoryOS(process.env.MEMORYOS_API_KEY!);
  const openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY! });

  const externalUserId = "customer-123";
  const userMessage = "What kind of answer format do I like?";

  const memories = await memory.get(userMessage, externalUserId, 5);

  let systemPrompt = "You are a helpful assistant.";
  if (memories.hasContext) {
    systemPrompt = `${systemPrompt}\n\n${memories.systemPromptAddition}`;
  }

  const response = await openai.responses.create({
    model: "gpt-4.1-mini",
    input: [
      { role: "system", content: systemPrompt },
      { role: "user", content: userMessage },
    ],
  });

  console.log(response.output_text);
}

void main();