Getting Started

Installation

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

Prerequisites

A MemorySync account (sign up here).
An API key and project ID (open the dashboard).
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

python -m pip install memorysync==1.9.2

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["MEMORYSYNC_PROJECT_ID"],
    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