开始使用
快速开始

快速开始

本指南帮助你在 5 分钟内:注册账号、获取 API Key、写入第一条记忆并完成检索。

Memaster 是云端服务,无需自行部署。注册即用。如果你需要私有化部署,请查看 企业版

注册账号

打开 https://memaster.cn/dashboard (opens in a new tab) ,使用邮箱或手机号注册。Free 套餐无需信用卡

  • 1 个终端用户、1 个项目
  • 每月 100 次记忆写入
  • 每月 1,000 次记忆检索

新账号默认就是 Free 套餐。需要更多额度?随时升级到 Starter / Growth

创建 API Key

登录后进入控制台 → API Keys创建密钥

  1. 输入一个便于识别的名称(如 production-server
  2. 点击「创建」
  3. 复制 msk_xxx 形式的 Key 并保存到密码管理器 —— 此密钥仅展示一次

也可以通过 REST 接口创建(需要先登录拿 access_token):

ACCESS=$(curl -s -X POST https://api.memaster.cn/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"yourpassword"}' \
  | jq -r '.access_token')
 
curl -X POST https://api.memaster.cn/api-keys \
  -H "Authorization: Bearer $ACCESS" \
  -H "Content-Type: application/json" \
  -d '{"label":"production-server"}'

返回示例:

{
  "id": "0e3b...",
  "user_id": "0f2bc0e6-...",
  "label": "production-server",
  "key": "msk_abcdef0123456789...",
  "key_prefix": "msk_abcdef",
  "created_at": "2026-06-14T01:00:00Z"
}

安装 SDK(可选)

pip install memaster
from memaster import MemoryClient
 
client = MemoryClient(api_key="msk_xxx")
# 默认 base_url 已经是 https://api.memaster.cn

写入第一条记忆

client.add(
    user_id="alice",
    messages=[
        {"role": "user", "content": "我偏好中文回复,正在评估 AI 记忆方案"},
        {"role": "assistant", "content": "好的,我会用中文回复你。"},
    ],
)

写入即异步抽取实体、生成 embedding,几秒后即可检索到。

检索相关记忆

results = client.search(query="alice 喜欢什么语言回复?", user_id="alice")
for item in results["results"]:
    print(f"[{item['score']:.3f}]", item["memory"])

返回示例:

{
  "results": [
    {
      "id": "e0ed0cbc-...",
      "memory": "用户 alice 偏好中文回复",
      "score": 0.871,
      "user_id": "alice",
      "created_at": "2026-06-14T01:02:30Z"
    }
  ]
}

在控制台查看

打开 https://memaster.cn/dashboard (opens in a new tab)

  • 我的记忆 — 浏览、编辑、删除已写入的记忆
  • 记忆看板 — 近一年使用统计热力图 + 详细请求日志
  • API Keys — 管理密钥(创建、撤销)
  • 用量 — 当前周期写入/检索次数与配额上限

常见问题

Q:写入后多久能检索到? A:通常 1–3 秒;高峰期最长 10 秒。如果你的 Agent 流程要求"写入即可读",可以使用 add() 返回的 memory_id 直接 get()

Q:API Key 丢了怎么办? A:去控制台 API Keys 页面撤销旧 Key,再创建新的。Memaster 不存储明文密钥,无法找回。

Q:免费套餐写满 100 次后会怎样? A:返回 429 quota_exceeded,下个自然月 1 日重置。需要更多额度请升级。

Q:能否私有化部署? A:可以。企业版 提供专有云、私有 K8s 集群、SSO、审计日志等能力。

下一步