SDK

接入文档

标准 OpenAI 兼容接口,无需额外 SDK,任何语言 10 分钟接入。

快速接入

两个接口,一个召回记忆、一个归档记忆。把你现有的 AI 对话代码包一层即可。

准备工作

  1. ①在 子空间管理 创建一个子空间,点"获取 Key"拿到 ws_pk_xxxx
  2. ②把下面代码里的 YOUR_WORKSPACE_KEY 换成你拿到的 Key
from openai import OpenAI

# 用你的 Workspace API Key 初始化客户端
memory = OpenAI(
    base_url="https://sm.memspider.com/v1",
    api_key="YOUR_WORKSPACE_KEY",
)

# ① 每轮对话开始前:召回记忆,拿组装好的上下文
recall = memory.chat.completions.create(
    model="memory-recall",
    messages=[{"role": "user", "content": user_message}],
)
context = recall.choices[0].message.content

# ② 把上下文 + 用户消息,发给你的算力模型
answer = your_llm.chat(context + "\n\n" + user_message)

# ③ 每轮对话结束后:归档这轮记忆(fire-and-forget)
memory.chat.completions.create(
    model="memory-archive",
    messages=[
        {"role": "user",      "content": user_message},
        {"role": "assistant", "content": answer},
    ],
)
# 返回 {"status":"accepted"},无需等待归档完成

支持任何 OpenAI 兼容客户端(Python / Node.js / curl)

召回接口

对话开始前调用,记忆爬虫自动检索历史记忆并组装成上下文,直接可用。

POST/v1/chat/completionsmodel: memory-recall
字段说明示例
model固定值"memory-recall"
messages当前用户消息[{"role":"user","content":"..."}]
Authorization请求头,Workspace API KeyBearer ws_pk_xxxx

返回

{
  "choices": [{
    "message": {
      "role": "assistant",
      "content": "以下是与当前话题相关的历史记忆:\n..."
    }
  }]
}

将 choices[0].message.content 作为上下文拼入你的算力模型请求即可。

归档接口

对话结束后调用,将本轮对话写入记忆库。异步处理,返回 accepted 后可立即继续。

POST/v1/chat/completionsmodel: memory-archive
字段说明
model固定值:"memory-archive"
messages本轮完整对话:user 消息 + assistant 回复,缺一不可

返回

{ "status": "accepted" }

归档在后台完成,无需等待。建议 fire-and-forget(不 await)。

进阶:直接操作记忆数据

以下接口用于批量管理、搜索、清理记忆数据,适合开发者工具场景,普通接入不需要。

POST/memory/ingest写入一条原始对话记忆
POST/memory/recall语义+全文混合召回
POST/memory/search全文搜索记忆
GET/memory/recent拉取最近记忆列表
GET/memory/topics查询话题列表
GET/memory/stats存储用量统计
POST/memory/external/upload上传外联文档(PDF/MD/TXT,≤10MB)
GET/memory/external列出已上传文档
DELETE/memory/external/:id删除外联文档

Base URL: https://api-dev.memspider.com 鉴权: Authorization: Bearer <ms_token>