HTTP API
网关(`npm run serve`)暴露的所有路由
HTTP 网关(npm run serve)通过 REST/SSE API 暴露同一个 Agent。所有路由都带有版本前缀 /v1/...,未鉴权的 /healthz 存活探针除外。
鉴权
在环境变量中设置 GATEWAY_AUTH_TOKEN,即可要求所有 /v1/... 路由携带 bearer token。若未设置,网关接受所有请求(仅限本地开发环境使用)。
Authorization: Bearer <GATEWAY_AUTH_TOKEN>健康检查
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /healthz | 存活探针。网关正常时返回 200 及 \{"ok": true\}。 |
GET | /v1/healthz | /healthz 的版本化镜像。无需鉴权,返回 \{"ok": true, "ts": ...\}。 |
对话
| 方法 | 路径 | 描述 |
|---|---|---|
POST | /v1/chat/stream | 启动一个 Agent 轮次并立即返回 session id。轮次在后台运行…… |
POST | /v1/assist/system-prompt | 为 Web UI 向导的"AI 生成"入口流式输出自定义 Agent 系统提示词…… |
POST | /v1/chat/interject | 将引导消息加入当前会话正在执行的轮次队列。网关会将其注入…… |
POST | /v1/chat/interrupt | 停止当前会话正在执行的轮次。轮次会优雅结束,已完成的工作得以保留…… |
GET | /v1/chat/recommendation | 长轮询每个会话的功能推荐存储,获取最近计算的卡片…… |
GET | /v1/chat/sessions/:id/goal | 返回会话的持续目标;未设置时返回 null。Agent 会持续追踪该目标…… |
POST | /v1/chat/sessions/:id/goal | 为会话设置持续目标。目标已激活时拒绝,返回 400…… |
POST | /v1/chat/sessions/:id/goal/pause | 暂停持续目标的续行。手动轮次仍可正常使用;目标可恢复…… |
POST | /v1/chat/sessions/:id/goal/resume | 恢复已暂停的目标。重置轮次预算,目标将重新获得新一批轮次…… |
POST | /v1/chat/sessions/:id/goal/clear | 清除持续目标。不可撤销,目标将被永久删除。 |
POST | /v1/chat/sessions/:id/goal/subgoals | 为持续目标追加一条验收条件。评审方和下一轮次…… |
DELETE | /v1/chat/sessions/:id/goal/subgoals/:n | 删除位置 n(从 1 开始)处的验收条件。条件不存在时拒绝,返回 400…… |
对话会话
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/sessions/:parentId/subagent-runs/:childSessionId | 返回一次同步 subagent 委派的折叠转录记录。子…… |
GET | /v1/sessions | 列出用户的对话会话,包含最后活跃时间戳和消息数量,按最近排序…… |
GET | /v1/sessions/search | 在所有会话中搜索消息内容,按最佳匹配排序(SQLite FTS5,bm25……)。 |
POST | /v1/sessions | 创建新的 session id;Agent 循环将按会话范围管理状态(冻结快照……)。 |
GET | /v1/sessions/:id | 主要历史读取端点:会话元数据及所有已持久化的消息…… |
DELETE | /v1/sessions/:id | 删除会话及其所有消息(以及会话的磁盘工作区)…… |
PATCH | /v1/sessions/:id | 设置会话标题。手动重命名优先于后台 LLM 生成的标题…… |
GET | /v1/institution/sessions/:sessionId/pipeline | 返回会话专属 pipeline、最新运行快照(回退)或默认值…… |
PUT | /v1/institution/sessions/:sessionId/pipeline | 使用乐观版本控制验证并保存会话专属 pipeline。 |
GET | /v1/institution/sessions/:sessionId/runs | 按时间顺序返回不可变的圆桌研判快照、最终结果和报告…… |
状态与控制
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/status | 紧急停止开关状态、当日支出、工具数量、审核引擎状态,等同于…… |
GET | /v1/system-metrics | 进程与系统快照,用于仪表盘系统状态行:CPU 占用率、内存…… |
GET | /v1/dashboard/achievements | Web UI 仪表盘横幅的统计数据:激活时间戳、已发现…… |
GET | /v1/portfolio | 来自 Minara 后端的当前投资组合快照,已格式化供 Agent 使用…… |
GET | /v1/methodologies | 已注册方法论列表,包含通过/失败次数及近期结果…… |
GET | /v1/learning/audit/reports | 方法论审计健康报告的趋势与历史。可用 days 参数查询(默认 30)…… |
GET | /v1/learning/audit/reports/latest | 最新的完整方法论审计报告:综合健康评分、每日…… |
GET | /v1/learning/audit/reports/:passId | 按 pass id 查找的完整方法论审计报告。 |
POST | /v1/learning/audit/run | 按需运行一次审计并持久化。可选 body \{ windowDays \}(清……)。 |
POST | /v1/kill | 阻断所有等级 ≥ 2 的工具调用,直到调用 /v1/unkill。用于紧急…… |
POST | /v1/unkill | 清除紧急停止开关标志。 |
POST | /v1/interactions/:id/answer | 解决 Agent 在轮次中途提出的待决问题。问题通过 WS 送达…… |
投资组合
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/portfolio/status | 快速就绪探针:Minara 是否已鉴权,以及哪些交易所可访问…… |
GET | /v1/portfolio/spot | 汇总所有已连接钱包的现货余额,以网关……为单位标准化。 |
GET | /v1/portfolio/spot/snapshot | 通过一次已鉴权的 Minara 盈亏请求获取稳定币余额和非稳定币仓位,避免首次加载时重复请求上游。 |
GET | /v1/portfolio/spot/positions | 各资产现货仓位,包含已知的平均成本基础。 |
GET | /v1/portfolio/perps | 所有 Minara 永续合约子账户的未平仓仓位。可用 ?subAccountId= 筛选…… |
GET | /v1/portfolio/perps/summary | 跨永续合约子账户的汇总权益 / 保证金 / 未实现盈亏。 |
GET | /v1/portfolio/history | 按图表显示分桶的总投资组合价值时间序列。 |
GET | /v1/portfolio/spot/activity | 用户主钱包的跨链现货活动流(闪兑 + 转账)…… |
GET | /v1/tx/status | 按交易 id 轮询单笔交易的链上状态。封装 Minara…… |
永续合约
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/perps/account-state | 某个 Hyperliquid 子账户的实时状态:权益、保证金使用量、可提现金额、未结订单…… |
GET | /v1/perps/sub-accounts | 用户 Minara 永续合约钱包下的所有子钱包,附多交易所…… |
GET | /v1/perp-wallets | 与 /v1/perps/sub-accounts 相同的处理函数;与上游 OpenAPI 路径对齐…… |
POST | /v1/perp-wallets | 创建一个绑定到某个交易所(hyperliquid | lighter)的永续合约子账户…… |
POST | /v1/perps/sub-accounts | POST /v1/perp-wallets 的 Agent 原生别名。请求体和响应格式相同。 |
POST | /v1/perp-wallets/rename | 重命名已有的永续合约子账户。请求体:\{ subAccountId: string, name: string…… |
POST | /v1/perps/sub-accounts/rename | POST /v1/perp-wallets/rename 的 Agent 原生别名。 |
POST | /v1/trading-gateway/place-orders | 批量向子账户绑定的交易所下永续合约订单。每笔订单使用…… |
POST | /v1/trading-gateway/cancel-orders | 按 \{ symbol, orderId \} 批量撤单。请求体:\{ cancels: \{ symbol: string, order…… |
POST | /v1/trading-gateway/modify-order | 修改活跃订单的价格、数量或触发价。请求体:\{ symbol: str…… |
POST | /v1/trading-gateway/update-leverage | 一次 round-trip 内更改某标的的杠杆倍数和保证金模式(全仓 vs 逐仓)…… |
POST | /v1/trading-gateway/update-isolated-margin | 调整已有仓位的逐仓保证金金额。请求体:\{ symbol: stri…… |
POST | /v1/trading-gateway/withdraw | 将 USDC 提现到外部地址。请求体:\{ amount: string, toAddress: string…… |
GET | /v1/trading-gateway/summary | 单次读取某个子钱包的权益、未平仓仓位和未结订单…… |
GET | /v1/wallet/deposits | 包含现货和永续合约充值地址的统一信封。现货从用户的跨……映射。 |
GET | /v1/wallet/supported-chains | 代理上游 Minara /tokens/supported-chains 端点。返回……列表。 |
POST | /v1/wallet/withdraw/spot | 预览跨链现货提现(confirm: false)或执行(confirm: ……)。 |
POST | /v1/wallet/withdraw/perps | 预览永续合约 USDC/Arbitrum 提现(confirm: false)或执行(confir……)。 |
GET | /v1/wallet/withdrawals/{operationId} | 按提现操作 id 持久化查询状态。返回最新已知的 \{opera……。 |
GET | /v1/perps/trades | 某个子钱包的 Hyperliquid 成交历史(实时,非本地镜像)…… |
GET | /v1/perps/funding | 各永续合约仓位收到/支付的资金费率。 |
GET | /v1/perps/transfers | 钱包范围内的 Hyperliquid 充值、提现和账户划转记录。 |
GET | /v1/perps/order-history | 最近已成交/已撤销的订单。 |
GET | /v1/perps/lighter-pnl | Lighter 子钱包的滚动已实现盈亏,从 Lighter 一级…… |
GET | /v1/orders | 返回合约挂单,或通过 source=spot 返回现货条件单。 |
POST | /v1/perps/transfer | 将闲置 USDC 从一个永续合约子钱包转移到另一个。仅限 USDC。涉及资金:预览…… |
GET | /v1/perps/sub-account/:subAccountId/idle-usdc | 某个永续合约子钱包的"可转移"金额:扣除保证金后的闲置 USDC…… |
Autopilot
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/autopilot/managed/catalog | 列出选择器可提供的托管策略类型,如夏普优化…… |
GET | /v1/autopilot/managed/catalog/:strategyType/backtest | 某个托管策略类型的回测预览(净值曲线 + 核心指标)…… |
GET | /v1/autopilot/managed/strategies | 所有托管策略,包含绑定子账户和标准化状态。/autopilot…… |
GET | /v1/autopilot/managed/aggregated-summary | /autopilot KPI 栏和仪表盘托管策略模块共用的聚合数据源。 |
GET | /v1/autopilot/managed/xstrategy/deployments | 列出用户的实时 XStrategy 部署(所有状态),供 Autopilot 策略…… |
GET | /v1/autopilot/managed/xstrategy/backtest/:backtestId | 某次部署的完整多资产回测报告(附加 /curves 可获取净值……)。 |
GET | /v1/autopilot/managed/by-sub-account/:subAccountId | 详情面板所需的子账户快照:绑定策略(或 null)…… |
POST | /v1/autopilot/managed/strategies | 在子钱包上创建托管策略。涉及资金:省略 confirm(或传……)触发预览。 |
POST | /v1/autopilot/managed/run | 以 Autopilot 方式运行来自其他来源的策略。marketplace 订阅公开…… |
POST | /v1/autopilot/managed/:strategyId/disable | 停止正在运行的托管策略。影响资金,遵循相同的预览…… |
POST | /v1/autopilot/managed/xstrategy/:strategyId/stop | 停止用户创作的实时 XStrategy 部署(Autopilot 将其与……一同展示)。 |
POST | /v1/autopilot/managed/xstrategy/:strategyId/deploy | 通过克隆已有部署,将 XStrategy 部署到选定的子钱包…… |
行情数据
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/quote/batch | 一次 round-trip 获取多个标的的现货/永续合约报价,用于行情看板…… |
GET | /v1/quote/:ticker | 现货价格、24 小时涨跌幅及传统指标(市盈率、每股收益、股息率、52 周……)。 |
GET | /v1/quote/crypto/:symbol | 某个加密资产的市值、FDV、24 小时成交量(USD)、24 小时涨跌幅、名称、Logo 和链。 |
GET | /v1/market/candles | 某个标的和时间间隔的 OHLC K 线。路由到相应数据源(Hyperli……)。 |
GET | /v1/market/perps-price | 返回 Hyperliquid 或 Lighter 的永续市场当前价格和交易场所相关市场标识。 |
GET | /v1/market/sparkline | 仅含收盘价的紧凑序列,供 Web UI 内嵌迷你图渲染使用。 |
GET | /v1/market/trending | 返回用于 Workbench 资产切换器的标准化热门加密货币和股票条目。 |
GET | /v1/market/search | 模糊匹配加密货币、股票、ETF、大宗商品、外汇的标的代码和名称…… |
GET | /v1/markets/movers | 市场概览看板中涨跌幅最大的标的。class=stocks(默认)返回…… |
GET | /v1/markets/snapshot | 一次请求获取市场概览看板的宏观数据包:主要指数报价(含……)。 |
GET | /v1/markets/sectors | 看板热力图所需的 11 个 GICS 板块日涨跌幅,通过……代理获取。 |
GET | /v1/markets/news | 看板的市场头条资讯流,解析自 Yahoo Finance 的无密钥 RSS。 |
GET | /v1/markets/calendar | 来自 Nasdaq 无密钥日历的下一交易日财报数据,向前填充…… |
语音
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/voice/status | 语音服务是否已配置:stt_configured(转录提供商……)。 |
GET | /v1/voice/voices | 语音选择器选项列表:官方预设语音(ElevenLabs + OpenAI,始终……)。 |
GET | /v1/voice/settings | 当前用户可调的语音合成设置。传 provider=openai 获取语音…… |
PUT | /v1/voice/settings | 持久化用户调整的语音合成设置。传 provider=openai 或 provide…… |
POST | /v1/voice/cleanup | 删除对话消息中已持久化的语音音频(合成回复 + 麦克风录音)…… |
POST | /v1/voice/transcribe | 通过已配置的语音提供商(Eleven……)转录上传的音频录音。 |
POST | /v1/voice/tts | 流式合成最多 4096 个字符文本的语音。提供商 body 通过管道…… |
POST | /v1/sessions/:id/voice-audio | 将之前上传的音频文件(POST /v1/files)附加到助手消息…… |
图片与视频
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/media/settings | 返回 Fal.ai 连接状态,以及独立选择的图片和视频…… |
PUT | /v1/media/settings | 选择 Fal.ai 鉴权方式,或设置默认图片和视频端点…… |
GET | /v1/media/models | 列出某种输出模态的活跃 Fal.ai 端点,包含动态推断的…… |
POST | /v1/media/models/refresh | 绕过五分钟目录缓存,刷新一种或两种输出模态。 |
GET | /v1/media/models/schema | 返回已解析的 OpenAPI 输入输出 schema、字段顺序和推断…… |
POST | /v1/media/providers/fal/oauth/init | 启动 Fal.ai 设备流,返回用户码和验证 URL。 |
GET | /v1/media/providers/fal/oauth/poll | 轮询设备流。成功响应将存储可刷新的 OAuth 凭据…… |
POST | /v1/media/providers/fal/api-key | 验证并将 Fal.ai API key 存入结构化凭据存储,然后…… |
DELETE | /v1/media/providers/fal/auth/:kind | 删除已保存的 Fal.ai 登录档案或 API key 覆盖。另一种方式…… |
文件与产物
| 方法 | 路径 | 描述 |
|---|---|---|
POST | /v1/files | 将文件上传到沙盒工作区。返回可供后续引用的 key…… |
GET | /v1/files/:key | 将之前上传的沙盒文件流式返回给调用方。 |
GET | /v1/artifacts/:id | 按 id 获取 Agent 生成的产物(图表、电子表格、报告数据)…… |
GET | /v1/artifacts | 列出 Web UI 文件页面的已完成报告产物。可按 kind=ch…… 筛选。 |
DELETE | /v1/artifacts | 永久删除 1 至 200 个已归档的报告产物及其文件。每个……。 |
GET | /v1/sandbox/files/:name | 读取 Agent 写入其每会话沙盒的文件。无法逃逸沙盒…… |
工作区文件
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/workspace/files | 列举所有可编辑的工作区 md 文件,包含大小、mtime 和 sha256…… |
GET | /v1/workspace/files/:name | 返回单个工作区 md 文件的内容及其 sha256。:name 须…… |
PUT | /v1/workspace/files/:name | 原子替换工作区 md 文件。expected_sha256 为必填项,需传入…… |
POST | /v1/workspace/files/:name/restore-template | 用 src/workspace/templ…… 中的随附模板覆盖工作区文件。 |
研究
| 方法 | 路径 | 描述 |
|---|---|---|
POST | /v1/research | 直接从网关运行深度研究 pipeline,无需经过…… |
GET | /v1/institution/skills | 列出环境可用的技能,以及符合圆桌研判条件的只读工具…… |
GET | /v1/institution/agent-templates | 列出用于配置单个圆桌研判 Agent 的内置和用户创建模板。 |
POST | /v1/institution/agent-templates | 保存一个独立的可复用 Agent 配置。 |
PATCH | /v1/institution/agent-templates/:templateId | 更新用户创建的 Agent 模板。内置模板不可修改。 |
DELETE | /v1/institution/agent-templates/:templateId | 删除用户创建的 Agent 模板,不影响已有的圆桌研判副本…… |
GET | /v1/institution/roundtable-templates | 列出默认和用户创建的完整圆桌研判模板。 |
POST | /v1/institution/roundtable-templates | 保存带标题、描述的自包含阶段和 Agent 配置。 |
PATCH | /v1/institution/roundtable-templates/:templateId | 更新用户创建的圆桌研判标题、描述或配置。 |
DELETE | /v1/institution/roundtable-templates/:templateId | 删除用户创建的模板,不影响使用该模板的会话或运行快照…… |
GET | /v1/institution/runs/:runId/snapshot | 返回不可变的模板、pipeline、Agent 设置、使用量和最终结果…… |
个性化与记忆
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/profile | 读取 Agent 注入每个系统提示词的重建个性化快照…… |
GET | /v1/profile/onboarding | 用户是否已完成引导流程,以及原始保存的答案。供…… |
POST | /v1/profile/onboarding | 应用引导答案:将金融知识/频率/风险/市场偏好映射到…… |
GET | /v1/financial-profile | 最新持久化的 financial_profile 行:重建的平台钱包摘要(组合……)。 |
PUT | /v1/profile/prompt | 替换用户的自定义系统提示词附录(最多 2000 个字符)。在…… |
DELETE | /v1/profile/prompt | 删除附录。UI 在调用前会弹出强制确认。 |
PUT | /v1/profile/tags/:name | 设置或清除 11 个行为标签维度之一(如 risk、markets、……)。 |
DELETE | /v1/profile/tags/:name | 等同于 PUT 传 value: null,标签被清除,Agent 重新推断…… |
GET | /v1/memory | 按 category 筛选最近记忆,或进行混合(BM25 + 向量)搜索…… |
GET | /v1/memory/trading-cases | 旧版自由格式备注流(memories 表中 category = 'trading-cases' 的行)…… |
GET | /v1/memory/research-cases | 按 topic 筛选的 /research 运行记忆。供研究回顾…… |
POST | /v1/memory | 手动写入一条 Agent 应始终记住的记忆。服务端标记 category=pe…… |
PATCH | /v1/memory/:id | 编辑 source=user_manual 记忆的 statement、fact_type 或 tickers。其他来源…… |
DELETE | /v1/memory/:id | 标记 deleted_at = now()。读取路径(FTS、列表、快照)会过滤该行…… |
POST | /v1/memory/:id/restore | 清除 deleted_at。绑定 Web UI 撤销提示(5 秒窗口),也可直接调用…… |
POST | /v1/profile/refresh | 同步运行全部三项个性化重建(trading_summary / tags / memories)…… |
GET | /v1/profile/trade-history-breakdown | 金融档案仪表盘的三来源分解:本地 trade_hist…… |
GET | /v1/profile/reference-wallets | 用户的外部钱包地址观察列表。 |
PUT | /v1/profile/reference-wallets | 原子替换观察列表。服务端验证 EVM(0x + 40 位十六进制)和 Solan…… |
学习到的偏好
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/learned-preferences | 列出待处理的推断行为偏好(proposed / active / deprecated……)。 |
POST | /v1/learned-preferences/:id/:action | 转换某条学习偏好的状态。批准后变为 active 并纳入…… |
GET | /v1/learned-preferences/:id | 某条学习偏好 id 的完整记录(描述、信号强度、历史……)。 |
GET | /v1/watchlist | 持久化在档案中的用户自定义标的观察列表。 |
PUT | /v1/watchlist | 替换观察列表(最多 100 个标的)。 |
GET | /v1/runtime-preferences | 返回子功能开关 schema、当前覆盖值和已解析值…… |
PUT | /v1/runtime-preferences | 批量应用用户覆盖,全部成功或全部失败。支持 If-Match 版本控制…… |
GET | /v1/runtime-preferences/critical-unlock-status | 读取关键级别开关当前是否已解锁(通过 CLI minara c……)。 |
POST | /v1/runtime-preferences/critical-unlock | 颁发短期解锁,允许后续的 PUT /v1/runtime-preferences 修改…… |
POST | /v1/runtime-preferences/sign-ack | 生成短期签名 ack token,供下一次 PUT /v1/runtime-prefere…… 使用。 |
GET | /v1/credentials/families | 返回提供商系列注册表(网络搜索、行情数据、向量 / embedding、云……)。 |
PUT | /v1/credentials/families/:id | 将单个提供商系列的覆盖值写入 ~/…… 的 dataSources 槽。 |
DELETE | /v1/credentials/families/:id/field/:envVar | 删除单个字段的覆盖值(回退到环境变量派生的默认值)。 |
GET | /v1/credentials/secrets | 返回扁平凭据槽(dataS……)中所有已配置的凭据 key。 |
PUT | /v1/credentials/secrets/:key | 以 UPPER_SNAKE key 存储值。消息类环境变量路由到消息…… |
GET | /v1/credentials/custom | 返回 ~/.minara/credentials.json 自由格式 custom 槽中的所有 key…… |
PUT | /v1/credentials/custom/:key | 以任意 key 在 custom 槽存储值(原子 + 文件锁)…… |
DELETE | /v1/credentials/custom/:key | 从 custom 槽删除单个 key。 |
通知
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/notifications | 最近的应用内通知(最新优先)及 unread_count。通知…… |
DELETE | /v1/notifications | 删除所有通知。返回 \{ ok, cleared \}。 |
POST | /v1/notifications/read-all | 将所有未读通知标记为已读。返回 \{ ok, updated \}。 |
POST | /v1/notifications/:id/read | 将单条通知标记为已读(幂等)。返回 \{ ok: true, updated \}…… |
DELETE | /v1/notifications/:id | 按 id 删除单条通知。 |
学习与方法论
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/memory/trading-cases/stats | 交易案例仪表盘的 4 个数字快照:总案例数、近 30 天、胜…… |
GET | /v1/memory/trading-cases/methodology-trend | 过去 N 周内前 N 个方法论的 outcome_alpha_return 周度时间序列…… |
GET | /v1/memory/methodologies | 按 Wilson 置信度下界排名的前 N 个方法论,包含案例数、资产类别…… |
GET | /v1/memory/methodology-cases | 读取统一的 methodology_observations 台账。驱动审计台账视图…… |
GET | /v1/memory/trading-cases/:id | methodology_observations.id 的完整行 JSON。供右侧详情抽屉使用…… |
GET | /v1/memory/trades | 来自统一 trade_executions 的近期 Agent 执行交易:操作、from/to…… |
GET | /v1/memory/strategy-runs | 来自 strategy_runs 的用户 Autopilot/托管策略运行记录:名称、创建者…… |
GET | /v1/memory/facts | 按 fact_type 筛选的 FactLayer 行(observation.* / preference.* / goal.targ……)。 |
技能
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/skills | Agent 可激活的所有已注册领域技能。每条记录包含激活…… |
POST | /v1/skills/reload | 将外部技能包重新镜像到沙盒并重新注册…… |
统计
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/stats | 按对话会话分桶的 token、费用和工具调用计数器。 |
POST | /v1/telemetry/block-action | ui_block 事件(UBP v1)的即发即忘点击记录。由 Web…… |
LLM 提供商
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/llm/default-model | Agent 循环当前用于新轮次的模型 id。 |
PUT | /v1/llm/default-model | 将 Agent 循环切换到不同的模型 id。针对实时 avail…… 验证。 |
GET | /v1/llm/available-models | 网关可分发的模型,按提供商分组。反映用户的实际…… |
POST | /v1/llm/available-models/refresh | 强制重新拉取当前提供商的模型目录,绕过内存缓存…… |
GET | /v1/llm/background-models | 返回后台任务模型的支持状态、生效状态、配置来源、指定槽位,以及对话、标题、压缩、无人值守和视觉所用的模型。 |
PUT | /v1/llm/background-models | 开启或关闭后台任务模型,并为标题、压缩和无人值守工作指定模型;enabled: null 恢复环境或内置默认值。 |
GET | /v1/shortcut-questions | 手动编写的固定列表加上每个分类的 LLM 动态生成问题,用于…… |
主题
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/theme | Web UI 主题偏好(浅色/深色/跟随系统 + 主题色)。 |
POST | /v1/theme | 更新已持久化的主题偏好。 |
GET | /v1/settings/report-design | 返回机构模式和深度研究 HTML/…… 使用的已持久化视觉设置。 |
PUT | /v1/settings/report-design | 标准化并持久化机构模式和深度研究使用的视觉设置…… |
GET | /v1/report-style | 返回机构模式和深度研究共享的完整报告样式配置…… |
PUT | /v1/report-style | 一次请求更新报告设计设置和/或自定义 REPORT.css…… |
PUT | /v1/report-style/preset | 应用某个内置报告样式预设,同时保留其余设计…… |
PUT | /v1/report-style/css | 验证并替换在选定预设和……之后应用的自定义 REPORT.css。 |
网关
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/gateway/providers | 已注册到网关的入站消息提供商(Slack、Lark 等)。 |
POST | /v1/gateway/providers/:id/fields/:envVar/reveal | 返回单个已屏蔽凭据字段(如 TELEGRAM_B……)的明文值。 |
POST | /v1/gateway/providers/:id/resolve-chat-id | 用 gateway 已持有的 token 查询机器人应发送到的 chat id;调用方无需接触 token。轮询式:found / awaiting_start / conflict / invalid_token。 |
POST | /v1/gateway/providers/:id/oauth/init | 为 OAuth 类消息提供商(email-……)发起 Google OAuth 授权流程。 |
GET | /studio/p/:pageId | 将生成的数据工作室仪表盘作为独立 HTML 页面在其专属链接上提供服务…… |
迁移
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/migrate/manifest | 列出可导出的数据集(记忆、档案、偏好、工作流)。 |
POST | /v1/migrate/export | 将请求的 manifest 条目打包为可携带的 JSON 数据,用于备份/迁移…… |
POST | /v1/migrate/import | 从之前导出的数据包恢复。对稳定 id(记忆、……)幂等。 |
管理
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/admin/script-risk/decisions | execute_code / term…… 前置脚本风险闸门的决策审计日志。 |
GET | /v1/admin/script-risk/decisions/:id | 某次脚本风险闸门决策的完整审计记录。 |
GET | /v1/consent/grants | 列出从 cron / …… 运行的 Tier-3 / Tier-4 工具的创作时同意授权。 |
POST | /v1/consent/grants | 记录操作员对计划自主运行的 Tier-3 / Tier-4 工具调用的授权。 |
GET | /v1/consent/grants/:id | 返回某条同意授权的完整记录。 |
DELETE | /v1/consent/grants/:id | 将授权标记为已撤销。后续在同一范围内对该工具的自主调用…… |
POST | /v1/consent/grants/requirements | 对草稿 cron / 工作流 / Agent 定义进行试运行扫描,检测 Tier-3 / Tier-4 工具…… |
配置
| 方法 | 路径 | 描述 |
|---|---|---|
GET | /v1/config/financial-profile | 调试端点。返回当前加载的有效 FinancialProfileConfig…… |
GET | /v1/config/financial-profile | 当前已解析的 FinancialProfileConfig,可用于调试重建原因…… |
鉴权
| 方法 | 路径 | 描述 |
|---|---|---|
POST | /v1/auth/elevenlabs/api-key | 保存用于语音合成和转录的 ElevenLabs key,经验证后…… |
GET | /v1/auth/status | 列出所有已配置的认证档案(OpenAI / Anthropic / OpenRouter / Minara)。 |
POST | /v1/auth/oauth/openai/init | 启动 OpenAI Codex 设备码登录流程。返回 \{ flowId, userCode, verif…… |
GET | /v1/auth/oauth/openai/poll | 按 flowId(来自 /v1/auth/oauth/open……)轮询进行中的 OpenAI 设备码流程。 |
GET | /v1/auth/oauth/openai/callback | 已于 2026-05 停用。原 PKCE 回调目标现返回 410 Gone…… |
POST | /v1/auth/oauth/openrouter/init | 启动 OpenRouter OAuth PKCE 流程。 |
GET | /v1/auth/oauth/openrouter/callback | OpenRouter 的 OAuth 重定向目标。 |
POST | /v1/auth/openrouter/api-key | 跳过 OAuth 流程,直接注册 OpenRouter API key。 |
POST | /v1/auth/oauth/anthropic/init | 启动 Anthropic 设备流复用路径(复用已有的 Claude CLI 登录)…… |
POST | /v1/auth/oauth/anthropic/exchange | 通过交换 verifier 完成 Anthropic 设备流,获取凭据。 |
DELETE | /v1/auth/:provider | 删除已存储的认证档案。:provider 为 openai | openai-api-key | anth…… |
POST | /v1/auth/oauth/xai/init | 针对 auth.x.ai 启动 SuperGrok 风格的 PKCE 流程。网关绑定回调…… |
GET | /v1/auth/oauth/flows/:flowId | 在进程内编排器中查询进行中的 Web OAuth 流程状态…… |
DELETE | /v1/auth/oauth/flows/:flowId | 取消进行中的 Web OAuth 流程,立即关闭绑定的回调端口…… |
POST | /v1/auth/openai/api-key | 保存 OpenAI 平台 API key(api.openai.com)。通过 GET /v1/models 验证后持久化…… |
POST | /v1/auth/anthropic/api-key | 保存 Anthropic 平台 API key。通过 GET /v1/models 验证后持久化…… |
POST | /v1/auth/xai/api-key | 保存 xAI(Grok)API key。通过 GET /v1/models 验证后持久化。 |
POST | /v1/auth/kimi/api-key | 保存 Kimi API 平台 key。通过官方 GET /v1/models 验证后持久化。 |
POST | /v1/auth/ollama/api-key | 保存 Ollama Cloud API key。针对已配置的 Ollama 主机验证…… |
GET | /v1/auth/preferred-provider | 从 credentials.json(llm……)读取用户显式的"使用此提供商"覆盖值。 |
PUT | /v1/auth/preferred-provider | 设置或清除首选提供商覆盖。实时探测所选凭据…… |
GET | /v1/security/totp/status | 通过 Agent 的 normalizeTotpStatus 适配器投影 /auth/me。返回…… |
GET | /v1/user/wallet-addresses | 供旧客户端兼容使用的纯钱包地址投影;新客户端读取统一 profile…… |
GET | /v1/user/profile | 完整的已登录 Minara 账户资料,保留前端 /auth/me 字段并增加稳定的 Agent 别名…… |
POST | /v1/security/totp/generate | 为用户生成新的 TOTP 密钥,供其添加到验证器应用:otpauth:// 链接、预渲染的 PNG data URL 与手动输入用的 base32 密钥。不返回备份码…… |
POST | /v1/security/totp/enable | 用户提交 TOTP 码证明已配置验证器后,激活 TOTP…… |
POST | /v1/security/totp/disable | 关闭 TOTP 但不删除设备绑定。需同时提供新鲜的 TOTP 码…… |
POST | /v1/security/totp/verify | 已弃用。校验 6 位代码是否匹配账户当前的密钥,不改变任何状态…… |
POST | /v1/security/totp/unbind | 不可撤销地删除验证器绑定。重新启用需重新扫描…… |
POST | /v1/security/email-code | 触发上游 POST /auth/email/code,为用户发送新的验证码…… |
PUT | /v1/security/totp/settings | 保存账户的新设备登录与提现 TOTP 偏好。提现标记只被保存和回显,上游的提现守卫并不读取它…… |
POST | /v1/auth/minara/oauth/start | 启动 Minara 平台 OAuth 2.0 + PKCE 登录。绑定回调…… |
POST | [`/v1/auth |