Getting Started

Installation

Install MemorySync, add your project credentials, and confirm the connection.

Prerequisites

A MemorySync account (sign up here).
An API key from the dashboard. A key created while a project is selected is locked to that project. For an organization-wide key, copy the project ID from the project menu in the header (proj_ plus 16 hexadecimal characters).
Python 3.9+, Node.js 18+, or cURL.
A backend or other trusted environment where the API key is not exposed to end users.

Installation

Install MemorySync

pip install memorysync

Set your API key

import os
from memorysync import MemorySyncClient

client = MemorySyncClient(
    api_key=os.environ["MEMORYSYNC_API_KEY"],
    base_url="https://api.memorysync.io",
    project_id=os.environ.get("MEMORYSYNC_PROJECT_ID") or None,
    end_user_id="user-123",
)

Check the connection

import urllib.request

with urllib.request.urlopen("https://api.memorysync.io/health") as response:
    print(response.status)

A successful status confirms that your server can reach MemorySync.

What’s next?

Quickstart

Add and search your first memory.

Authentication Setup

Review request scope and key-handling rules.

Python & Node.js

See every operation available in the language libraries.

Was this page helpful?

← Previous

Architecture at a Glance