跳到主要内容

快速开始

Memex 把一本书变成一个 Wiki。上传书 → 等待生成 → 打开预览,三步完成。

  • 服务地址https://memex-server.memect.cn;下文示例统一以 $HOST 指代
  • Web 界面:浏览器直接打开服务地址,上传、看进度、开预览都能在页面上完成
  • API 调用:见下文

第 1 步:获取 API Key

向管理员申请,或(管理员)在 Web 界面「设置 → API Token」中创建。

Key 形如 sk-memex-xxxxxxxx,每次请求放在 Header 里:

Authorization: Bearer sk-memex-xxxxxxxx

后续示例可原样复制,先设好两个环境变量:

export HOST=https://memex-server.memect.cn
export MEMEX_API_KEY=sk-memex-xxxxxxxx # 替换为你的 API Key

第 2 步:上传一本书

支持 epub / pdf / md / txt。上传即自动排队生成,无需其他操作。

curl -X POST $HOST/api/v1/upload \
-H "Authorization: Bearer $MEMEX_API_KEY" \
-F "file=@苏东坡传.epub" \
-F "wiki_name=苏东坡传" \
-F "lang=zh"

返回:

{ "ok": true, "job_id": 42, "wiki_slug": "su-dong-po-zhuan" }

记下 job_idwiki_slug

也可以直接给一个 URL:

curl -X POST $HOST/api/v1/upload-url \
-H "Authorization: Bearer $MEMEX_API_KEY" -H "Content-Type: application/json" \
-d '{"source_url": "https://example.com/book.epub", "wiki_name": "我的书"}'

第 3 步:查看进度

生成需要一段时间(视书的大小,通常 1~4 小时)。随时查询:

curl $HOST/api/v1/jobs/42 \
-H "Authorization: Bearer $MEMEX_API_KEY"

status 字段变为 readycompleted 即生成完毕。

也可以在浏览器打开 $HOST/job/42 看实时日志, 或用 SSE 订阅:

curl -N "$HOST/api/v1/jobs/42/stream?access_token=$MEMEX_API_KEY"

第 4 步:打开 Wiki

curl -X POST $HOST/api/v1/wiki/su-dong-po-zhuan/serve \
-H "Authorization: Bearer $MEMEX_API_KEY"

然后浏览器访问:

$HOST/preview/su-dong-po-zhuan/

完成。

一个完整的例子

HOST=https://memex-server.memect.cn
KEY="sk-memex-xxxxxxxx"

# 上传
JOB=$(curl -s -X POST $HOST/api/v1/upload \
-H "Authorization: Bearer $KEY" \
-F "file=@book.epub" -F "wiki_name=我的书" | python3 -c "import sys,json;print(json.load(sys.stdin)['job_id'])")

# 轮询直到完成
while true; do
S=$(curl -s $HOST/api/v1/jobs/$JOB -H "Authorization: Bearer $KEY" | python3 -c "import sys,json;print(json.load(sys.stdin)['status'])")
echo "status: $S"
[ "$S" = "ready" ] || [ "$S" = "completed" ] && break
[ "$S" = "failed" ] && exit 1
sleep 60
done

# 开预览
SLUG=$(curl -s $HOST/api/v1/jobs/$JOB -H "Authorization: Bearer $KEY" | python3 -c "import sys,json;print(json.load(sys.stdin)['wiki_slug'])")
curl -s -X POST $HOST/api/v1/wiki/$SLUG/serve -H "Authorization: Bearer $KEY"
echo "打开: $HOST/preview/$SLUG/"

下一步

  • HTTP API 参考 — SSE 实时进度、butler 维护、内容读取、发布
  • MCP 接入 — 在 Claude Desktop / Cursor 中直接使用
  • 遇到问题:GET /api/v1/jobs/{id} 返回里的 diagnostics 字段有失败诊断与建议动作
  • 想自己部署一套:生产部署