Skip to main content

Prerequisites

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.
EverOS extracts memories as a conversation goes on, and keeps the latest messages buffered until it can tell where that part of the conversation ends. flush closes the session now. Without it, the next add to the session closes them, or EverOS closes the session itself after 2 hours with no new messages.By default add returns status: "queued" right away and stores the messages in the background. This quickstart passes async_mode=False so the flush that follows sees both messages. A flush sent before a queued add has landed returns "no_extraction", which is not an error.
4

Retrieve memories

Fetch a user’s stored memories by type.
If the count is 0, give extraction a few seconds and run it again.
5

Search memories

Find relevant memories using vector, keyword, hybrid, or agentic retrieval.
The vector index lags extraction by a few seconds. To read back something you just wrote, use client.get(...) — it reads the stored memories directly and sees them as soon as they are extracted.
6

Correct a memory (optional)

When a memory is wrong, fix it, delete it, or record that it was wrong. Use the id that get and search return.

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.

Knowledge Bases

Ingest documents into a searchable topic library and query it alongside memory.

MCP Server

Give Claude Code, Cursor, and other AI tools a memory that lasts, with no code.

Console

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