API 与命令速查


文档摘要

API 与命令速查 本节摘要:高频启动命令、关键 HTTP 接口、SDK 核心 API、控制台常用操作的速查表。日常操作时不用翻正文,查这里。所有内容均为概念性,真实参数以本地源码与官方文档为准。 一、启动与停止命令 命令 | 用途 | 出处 | 一键起三件套(核心+知识+控制台+代理) | 第 1 章 | 停止三件套(保留数据) | 第 1 章 | 从示例复制配置 | 第 1 章 二、关键 HTTP 接口 接口 | 方法 | 用途 | 出处 | POST | 用密钥换 userid(auth 步骤) | 第 8 章 | GET/POST | 发现有哪些知识工具 | 第 7 章 | POST | 调用某知识工具取片段 | 第 7 章 召回接口(recall) | POST | 召回相关记忆

API 与命令速查

本节摘要:高频启动命令、关键 HTTP 接口、SDK 核心 API、控制台常用操作的速查表。日常操作时不用翻正文,查这里。所有内容均为概念性,真实参数以本地源码与官方文档为准。

一、启动与停止命令

命令 用途 出处
./start-all.sh 一键起三件套(核心+知识+控制台+代理) 第 1 章
./stop-all.sh 停止三件套(保留数据) 第 1 章
cp .env.example .env 从示例复制配置 第 1 章
端口速查 8096 → 代理层(Agent 的 baseURL 指向这) 8125 → 控制台(浏览器打开) 8420 → 记忆核心服务(内部 Gateway) 8421/8424 → 知识服务(Wiki/CodeGraph)

二、关键 HTTP 接口

接口 方法 用途 出处
/v3/meta/auth/verify POST 用密钥换 user_id(auth 步骤) 第 8 章
/v3/tools/list GET/POST 发现有哪些知识工具 第 7 章
/v3/tools/call POST 调用某知识工具取片段 第 7 章
召回接口(recall) POST 召回相关记忆 第 6/9 章
捕获接口(capture) POST 回写对话(extract) 第 8/9 章

⚠️ 注意:以上接口路径为概念性,真实路径与参数以本地源码与 OpenAPI 文档为准。控制台与 SDK 都封装了这些接口,日常用控制台/SDK 即可,不必直接调 HTTP。

三、SDK 核心 API

# Python SDK 核心 API(概念性,真实签名以本地 SDK 为准) from memory_core import MemoryCoreClient client = MemoryCoreClient(endpoint="http://localhost:8420", key="...") # 召回 memories = await client.recall(query="...", team_id=..., agent_id=..., user_id=...) # 捕获(回写) await client.capture(conversation={...}, team_id=..., agent_id=..., session_id=...) # 工具发现与调用 tools = await client.list_tools(team_id=...) result = await client.call_tool(tool_name="code_impact", params={...})
API 用途 对应四步
recall 召回记忆 第一步 召回
capture 回写对话 第二步 捕获
list_tools 发现有哪些工具 第三步 工具暴露
call_tool 调用工具取片段 第三步 工具暴露

TypeScript SDK 的 API 概念一致,仅语法风格不同(如 await client.recall(...))。

四、控制台常用操作

操作 在哪做 出处
建 Team / 招 Agent 控制台团队页 第 5/11 章
审核 / 分享资产 资产背包 第 5 章
配 Loadout Agent 详情页 第 5/11 章
构建 Wiki / CodeGraph Knowledge 工坊 第 5/7 章
查资产使用次数 资产详情 第 1/5 章

五、环境变量速查

变量 用途 出处
memory 组 LLM 凭证 抽取用(核心服务) 第 1 章
proxy 组 LLM 凭证 转发用(代理层) 第 1 章
ANTHROPIC_BASE_URL Claude Code 指向代理(改这) 第 1/10 章
ANTHROPIC_AUTH_TOKEN 代理签发的 user-key 第 1/10 章

六、可观测后端速查

后端 观测维度 出处
Langfuse 调用链路 + 会话记录 第 12 章
Opik 评估 + 对比实验 第 12 章
ClickHouse 成本统计 + 大规模聚合 第 12 章
OpenTelemetry trace 贯通三路 第 12 章

本节要点回顾

  1. 启动停止:start-all.sh / stop-all.sh,端口 8096/8125/8420/8421。
  2. 关键接口:auth/verify(鉴权)、tools/list+call(知识按需)、recall/capture(召回回写)。
  3. SDK 核心:recall/capture/list_tools/call_tool,Python 与 TS 概念一致。
  4. 控制台操作:建队/审核/配装/构建/查使用,均在控制台对应页面。
  5. 环境变量:memory 组 + proxy 组凭证,Agent 改 baseURL + user-key。

下一节是常见报错排查三列表。


发布者: 作者: 灏天文库 转发
评论区 (0)
U