API 参考

PicoAide HTTP API 接口文档

PicoAide 提供完整的 RESTful JSON API，所有端点返回 JSON 格式数据。API 专为浏览器扩展和桌面客户端集成而设计。

通用说明

认证方式

除登录接口外，所有 API 请求需携带会话 Cookie：

Cookie: picoaide-session=<session-value>

MCP 相关接口使用 Bearer Token 或 Query Parameter 认证：

# Bearer Token 方式
Authorization: Bearer <mcp-token>

# Query Parameter 方式
?token=<mcp-token>

CSRF 保护

所有 POST 请求需要携带 CSRF Token：

X-CSRF-Token: <csrf-token>

通过 GET /api/csrf 获取 CSRF Token。

响应格式

所有接口返回统一的 JSON 格式：

{
  "success": true,
  "message": "操作成功",
  "data": {}
}

错误响应：

{
  "success": false,
  "error": "错误描述"
}

认证接口

方法端点说明
POST/api/login用户登录
POST/api/logout用户登出
GET/api/user/info获取当前用户信息
POST/api/user/password修改密码（仅本地模式）
GET/api/csrf获取 CSRF Token

MCP SSE 接口

方法端点说明
GET/api/mcp/token获取当前用户的 MCP Token
GET/api/mcp/sse/{service}建立 MCP SSE 连接
POST/api/mcp/sse/{service}发送 MCP JSON-RPC 消息
GET/api/browser/ws浏览器扩展 WebSocket 连接
GET/api/computer/ws桌面客户端 WebSocket 连接

MCP SSE 服务支持 {service} 值为 browser 或 computer。

用户接口

方法端点说明
GET/api/config读取全局配置
POST/api/config保存全局配置
GET/api/dingtalk读取钉钉配置
POST/api/dingtalk保存钉钉配置并重启容器
GET/api/cookies获取 Cookie 数据

文件管理接口

方法端点说明
GET/api/files列出文件（JSON）
POST/api/files/upload上传文件
GET/api/files/download下载文件
POST/api/files/delete删除文件或目录
POST/api/files/mkdir创建目录
GET/api/files/edit读取文件内容
POST/api/files/edit保存文件内容

管理接口

以下接口需要管理员权限。

用户管理

方法端点说明
GET/api/admin/users用户列表
POST/api/admin/users/create创建用户
POST/api/admin/users/delete删除用户

超级管理员

方法端点说明
GET/api/admin/superadmins超管列表
POST/api/admin/superadmins/create创建超管
POST/api/admin/superadmins/delete删除超管
POST/api/admin/superadmins/reset重置超管密码

容器管理

方法端点说明
POST/api/admin/container/start启动容器
POST/api/admin/container/stop停止容器
POST/api/admin/container/restart重启容器
GET/api/admin/container/logs获取容器日志

镜像管理

方法端点说明
GET/api/admin/images本地镜像列表
POST/api/admin/images/pull拉取镜像（SSE 流式）
POST/api/admin/images/delete删除镜像
POST/api/admin/images/migrate迁移镜像
POST/api/admin/images/upgrade升级镜像
GET/api/admin/images/registry远程仓库标签列表
GET/api/admin/images/local-tags本地镜像标签列表
GET/api/admin/images/upgrade-candidates可升级镜像列表
GET/api/admin/images/users镜像关联用户列表

组管理

方法端点说明
GET/api/admin/groups组列表
POST/api/admin/groups/create创建组
POST/api/admin/groups/delete删除组
GET/api/admin/groups/members组成员列表
POST/api/admin/groups/members/add添加组成员
POST/api/admin/groups/members/remove移除组成员
POST/api/admin/groups/skills/bind绑定技能到组
POST/api/admin/groups/skills/unbind解绑组技能

技能管理

方法端点说明
GET/api/admin/skills技能列表
POST/api/admin/skills/deploy部署技能
GET/api/admin/skills/download下载技能
POST/api/admin/skills/remove删除技能
POST/api/admin/skills/install安装技能
GET/api/admin/skills/repos/list仓库列表
POST/api/admin/skills/repos/add添加仓库
POST/api/admin/skills/repos/pull拉取仓库
POST/api/admin/skills/repos/remove删除仓库

白名单管理

方法端点说明
GET/api/admin/whitelist白名单列表
POST/api/admin/whitelist更新白名单

认证配置

方法端点说明
POST/api/admin/auth/test-ldap测试 LDAP 连接
GET/api/admin/auth/ldap-users获取 LDAP 用户列表
POST/api/admin/auth/sync-groups同步 LDAP 组

系统管理

方法端点说明
POST/api/admin/config/apply应用配置并重启
GET/api/admin/task/status异步任务状态查询
在 GitHub 上编辑此页