VirtualBrowser
    • 接入前必读
    • 附录 A:MCP 接口(AI 自动化)
    • 附录 B:常见问题
    • 环境基础
      • 获取浏览器环境列表
        GET
      • 获取浏览器环境列表
        POST
      • 获取环境完整参数
        GET
      • 获取运行中的环境列表
        GET
      • 创建环境
        POST
      • 更新环境
        POST
      • 删除环境
        POST
      • 启动环境
        POST
      • 关闭环境
        POST
    • 环境数据
      • 删除环境数据
        POST
      • 获取环境cookie
        GET
      • 更新环境cookie
        POST
      • 清除环境缓存
        POST
      • 更新环境指纹
        POST
    • 运行与工具
      • 查询当前环境ID是否在运行中
        GET
      • 窗口排列
        POST
      • 获取内核版本信息
        GET
    • 分组管理
      • 获取分组列表
        GET
      • 添加分组
        POST
      • 更新分组名称
        POST
      • 删除分组
        POST
    • 插件管理
      • 获取插件列表
        GET
      • 添加插件
        POST
      • 删除插件
        POST
    • 平台账号
      • 获取环境中平台保存的账号密码
      • 新增环境中平台账号密码
      • 更新环境中平台账号密码
      • 删除环境中平台账号密码
    • 云同步
      • 查询环境云同步状态
      • 设置环境云同步开关
      • 删除云端备份

    接入前必读

    服务地址#

    客户端启动时会在 9000~30000 之间选择一个可用端口监听,不是固定 9000。请以客户端界面显示的实际端口为准。
    监听地址为 0.0.0.0,同一局域网内的其他机器也可以访问。
    下文所有示例中的 http://localhost:9000 仅为示意,请替换为实际端口。

    认证方式#

    所有接口都必须在请求头携带 api-key:
    api-key: 你的密钥
    api-key 是客户端首次启动时生成并持久化的 32 位随机字符串,可在客户端设置中查看。它相当于本机 API 的访问口令,请勿写入代码仓库或公开文档。
    服务端会做两层校验:
    层级校验内容失败返回
    1请求头 api-key 必须与客户端生成的一致401 {"success":false,"error":"Unauthorized: Invalid API key"}
    2VIP 能力租约(local_api)必须有效403 {"success":false,"error":"VIP capability lease is missing or expired"}

    通用返回约定#

    字段类型说明
    successboolean业务是否成功
    dataobject / array业务数据,成功时返回
    errorstring失败原因,失败时返回
    totalint列表类接口的总条数(部分接口返回)

    状态码#

    HTTP含义
    200成功
    400参数缺失、格式错误或匹配到多个环境
    401api-key 缺失/错误,或未登录
    403VIP 能力不足或已过期
    404目标环境、分组、账号不存在
    429并发写请求过多(写队列上限 1000),请稍后重试
    500服务端内部错误(数据库被占用、文件被占用等)

    调用建议#

    1.
    涉及环境数据(cookie、账号、缓存、数据目录)的接口,请先关闭环境,否则文件被占用会返回 500。
    2.
    写操作有并发队列,批量创建/更新时请控制并发,遇到 429 加重试退避。
    3.
    环境 ID 是唯一稳定标识;用 name / remark 定位时要求全局唯一,匹配到多个会返回 400。
    修改于 2026-11-09 06:31:31
    下一页
    附录 A:MCP 接口(AI 自动化)
    Built with