管理

配置、用户、监视器、审计日志 —— 这些是运维人员使用的 API。大多数需要管理员权限。

配置

方法	路径	功能
GET	/api/settings	全部配置
PUT	/api/settings	保存配置（仅需变更项）
POST	/api/settings/test-platform	实际测试 Platform 集成密钥
POST	/api/settings/mcp/refresh	刷新 MCP 服务器列表（正文中填 serverId，省略则为全部）

AI 供应商配置位于 ai 之下。

{
  "ai": { "provider": "anthropic", "model": "...", "baseUrl": "..." }
}

密钥值本身不会包含在响应中。可以保存，但无法再次读取。

品牌

方法	路径	功能
PUT	/api/settings	品牌名称（{ "brandName": "..." }）
POST	/api/settings/branding-logo	上传徽标（mime、dataBase64）
DELETE	/api/settings/branding-logo	删除徽标

用户

方法	路径	功能
GET	/api/users	用户列表
GET	/api/users/directory	用于选择共享对象的简易列表
POST	/api/users	创建用户（userId、password、name、role）
PUT	/api/users/{id}	修改姓名与角色
POST	/api/users/{id}/password	重置密码
DELETE	/api/users/{id}	删除
POST	/api/users/{id}/avatar	头像（mime、dataBase64）
GET	/api/avatar/{loginId}	读取头像

{id} 需进行 URL 编码。

监视器

监视器是按设定周期运行、条件命中时发出通知的监视规则。

方法	路径	功能
GET	/api/watchers	列表
POST	/api/watchers/draft	根据自然语言描述生成监视器草稿（正文中填 text）
POST	/api/watchers	创建（name、instruction、intervalMinutes）
PATCH	/api/watchers/{id}	修改
DELETE	/api/watchers/{id}	删除
POST	/api/watchers/{id}/run	不等待周期，立即执行

之所以提供草稿 API，是因为与其手写条件，不如直接说“3号线压缩机排气温度超过90度时通知我”来得快。

通知

方法	路径	功能
GET	/api/notifications?limit={n}&offset={n}&q={검색어}	通知列表
GET	/api/notifications/unread	未读项
POST	/api/notifications/seen	全部标记为已读
GET	/api/notifications/stream	以流式方式接收新通知

审计与用量

方法	路径	功能
GET	/api/audit?offset={n}&limit={n}&q={검색어}	审计日志（默认50条）
GET	/api/usage?days={n}	用量（默认30天）
GET	/api/stats/overview?days={n}	统计摘要
GET	/api/activity	最近活动

模板与图库

方法	路径	功能
GET	/api/templates	模板列表
DELETE	/api/templates/{key}	删除模板
GET	/api/gallery/{id}/doc	图库项目的说明文档

引导上手

GET /api/onboarding

获取首次登录用户需要显示的引导状态。