Skip to main content

Prerequisites

Before getting your API key, configure your Memory Space Scenario Mode. It influences how memories are extracted and consolidated. Learn more in the Space Scenario Mode guide.
1

Install the SDK

2

Create a client

Never commit API keys to version control. Use environment variables in production.
3

Add memories

Store conversation messages into your Memory Space. Each message’s sender_id is the user the memory belongs to.
Writes are asynchronous by default. The call returns immediately and extraction runs in the background.
4

Retrieve memories

Fetch a user’s stored memories by type.
5

Search memories

Find relevant memories using vector, keyword, hybrid, or agentic retrieval.

What’s Next?

Core Concepts

Understand the memory lifecycle, memory types, and how EverOS processes your data.

API Reference

Explore the full API with detailed parameter docs, request/response examples, and error codes.

Console

Monitor quota usage, track API calls, and manage keys in the EverOS Console.
Need help? Join our community.