# 中屹浏览器本地API ## API Docs - 服务 [获取服务状态](https://docs.zhongyibrowser.com/api-docs/486324265e0.md): 无需 API Key,用于确认本机服务是否正在运行。 - 环境管理 [创建环境](https://docs.zhongyibrowser.com/api-docs/490932557e0.md): 创建当前用户、当前团队下的单个未启动环境。请求只包含公开配置意图;Local API 注入真实桌面平台并在本机解析 API 代理,后端负责生成 UA Client Hints、噪声、电池和媒体设备等内部指纹值。 - 环境管理 [获取环境列表](https://docs.zhongyibrowser.com/api-docs/486348363e0.md): 分页返回当前用户、当前团队下的环境,标记 active/inactive 状态,并根据套餐额度和当前系统支持的内核计算环境是否可用。 - 环境管理 [启动环境](https://docs.zhongyibrowser.com/api-docs/486348365e0.md): 启动当前用户、当前团队下的环境。已活跃或正在启动的环境仍会按当前登录态校验环境归属,但不会重复创建进程;url 会在启动后新开标签。headless 显式值优先,未传时沿用环境 command_line;无头模式忽略 window_state。 - 环境管理 [重启环境](https://docs.zhongyibrowser.com/api-docs/487985048e0.md): 校验当前登录用户和团队环境后,正常关闭当前活跃浏览器并重新启动。url、window_state、headless 与启动接口语义一致;未活跃环境返回 40903,成功响应的 reused 固定为 false。 - 环境管理 [编辑环境](https://docs.zhongyibrowser.com/api-docs/491163793e0.md): 部分编辑当前用户、当前团队下的环境。只更新请求中明确提供的字段;运行中的环境可以保存,新配置在下次启动时生效。浏览器兼容条件变化时由后端重新生成内部 UA 字段,未修改的随机指纹值保持不变。 - 环境管理 [获取环境详情](https://docs.zhongyibrowser.com/api-docs/486348364e0.md): 返回当前用户、当前团队下的指定环境,并叠加 active/inactive 状态和本机可用性。 - 环境管理 [批量重启环境](https://docs.zhongyibrowser.com/api-docs/488220644e0.md): 按 env_ids 首次出现顺序去重,并以有界并发重启当前活跃环境。每项独立校验登录态和团队归属,未活跃环境在对应 item 中返回 40903;部分失败不回滚其他成功项。 - 环境管理 [关闭环境](https://docs.zhongyibrowser.com/api-docs/486348366e0.md): 停止当前用户、当前团队下的环境浏览器;合法环境已不活跃时保持幂等,不存在或不可访问时返回 40401。 - 环境管理 [批量启动环境](https://docs.zhongyibrowser.com/api-docs/488220645e0.md): 按首次出现顺序去重并以有界并发启动环境。每项可独立设置 headless;未传时沿用对应环境 command_line。每个环境独立返回成功或错误,业务失败不会回滚已成功启动的环境。 - 环境管理 [批量关闭环境](https://docs.zhongyibrowser.com/api-docs/488220646e0.md): 按首次出现顺序去重并以有界并发停止环境。每个环境独立校验归属并返回成功或错误。 - 环境管理 [关闭所有环境](https://docs.zhongyibrowser.com/api-docs/488225834e0.md): 对请求到达时环境管理模块中已打开的浏览器创建快照,并按当前登录用户和团队逐项校验、关闭。接口不操作 RPA/RPA Plus runtime;部分环境失败不影响其他环境,响应结构与批量停止一致。 - 环境配置项 [获取当前电脑支持的浏览器内核](https://docs.zhongyibrowser.com/api-docs/490218776e0.md): 根据运行 Local API 的桌面平台和实际可用内核版本,返回创建环境时可以选择的内核主版本。 - 环境配置项 [获取指定内核支持的操作系统](https://docs.zhongyibrowser.com/api-docs/490218777e0.md): 返回指定可用内核支持的操作系统、系统版本以及每个组合可选择的 UA 主版本。 - 环境配置项 [随机获取指定内核支持的操作系统](https://docs.zhongyibrowser.com/api-docs/490290246e0.md): 在指定可用内核的兼容范围内,依次随机选择操作系统、系统版本和 UA 主版本,返回的四个字段可直接作为同一组环境选项使用。 - 环境配置项 [获取时区选项](https://docs.zhongyibrowser.com/api-docs/490218778e0.md): 一次返回创建环境时可选择的全部 IANA 时区,支持按时区 ID 或显示文本筛选。 - 环境配置项 [获取语言选项](https://docs.zhongyibrowser.com/api-docs/490218779e0.md): 一次返回创建环境时可选择的全部 BCP 47 语言代码和稳定英文名称。 - 环境配置项 [获取屏幕分辨率预设](https://docs.zhongyibrowser.com/api-docs/490218780e0.md): 返回创建环境时可直接选择的全部屏幕宽高预设。 - 环境配置项 [随机获取屏幕分辨率](https://docs.zhongyibrowser.com/api-docs/490290247e0.md): 从公开的屏幕分辨率预设中随机返回一组宽高。 - 环境配置项 [获取内存和 CPU 预设](https://docs.zhongyibrowser.com/api-docs/490218781e0.md): 返回创建环境时可直接选择的内存容量和 CPU 核心数预设。 - 环境配置项 [随机获取内存和 CPU](https://docs.zhongyibrowser.com/api-docs/490290248e0.md): 分别从公开预设中随机返回内存容量和 CPU 核心数。 - 环境配置项 [获取字体选项](https://docs.zhongyibrowser.com/api-docs/490218782e0.md): 分页返回创建环境时可选择的自定义字体,支持按字体名称筛选。 - 环境配置项 [按数量随机获取字体](https://docs.zhongyibrowser.com/api-docs/490290249e0.md): 根据 count 从完整字体候选池中无重复随机返回字体;本接口不分页。 - 环境配置项 [随机获取兼容 WebGL 元数据](https://docs.zhongyibrowser.com/api-docs/490218783e0.md): 先验证内核、操作系统和可选系统版本的兼容关系,再随机返回一组公开的 WebGL Vendor 与 Renderer。 - 环境分组 [获取分组列表](https://docs.zhongyibrowser.com/api-docs/488462680e0.md): 分页返回当前用户、当前团队可访问的环境分组,并返回每个分组下的环境数量。 - 环境分组 [创建分组](https://docs.zhongyibrowser.com/api-docs/488462681e0.md): 在当前团队下创建普通环境分组,默认分组由系统维护。 - 环境分组 [获取分组详情](https://docs.zhongyibrowser.com/api-docs/488462682e0.md): 返回当前用户、当前团队可访问的指定分组,并包含该分组下的环境摘要。 - 环境分组 [更新分组](https://docs.zhongyibrowser.com/api-docs/488462683e0.md): 更新当前团队下的普通分组名称和备注;默认分组不允许通过 Local API 修改。 - 环境分组 [删除分组](https://docs.zhongyibrowser.com/api-docs/488462684e0.md): 删除当前团队下的普通分组;默认分组不能删除。被删除分组下存在环境时,Local API 会先将这些环境移动到默认分组。 - 环境分组 [移动环境到分组](https://docs.zhongyibrowser.com/api-docs/488462685e0.md): 将环境移动到指定分组。Local API 会先校验目标分组和环境均属于当前用户、当前团队;不存在或不可访问的环境按单项失败返回。 - 环境回收站 [获取回收站环境](https://docs.zhongyibrowser.com/api-docs/489177778e0.md): 分页返回当前团队回收站中的环境,并给出进入回收站时间和 30 天自动永久删除时间。后端会在查询前清理已经过期的记录。 - 环境回收站 [永久删除回收站环境](https://docs.zhongyibrowser.com/api-docs/489177779e0.md): 批量永久删除当前团队回收站环境。全部 ID 校验通过后先安全清理本机环境缓存,再删除后端记录;重复 ID 自动去重。缓存正在使用或清理服务繁忙时不会调用后端删除。 - 环境回收站 [恢复回收站环境](https://docs.zhongyibrowser.com/api-docs/489177780e0.md): 批量恢复当前团队回收站环境。重复 ID 自动去重,全部 ID 校验通过后才调用后端;恢复后的环境总数超过套餐限制时返回 40915。该操作保留本机环境缓存。 - 环境回收站 [清空回收站](https://docs.zhongyibrowser.com/api-docs/489177781e0.md): 清空当前团队回收站。Local API 从后端读取全部环境 ID,先逐个安全清理本机缓存,再清空后端记录;调用方不需要也不能传入环境 ID。 - 代理管理 [获取代理列表](https://docs.zhongyibrowser.com/api-docs/488710817e0.md): 分页返回当前用户、当前团队有权访问的代理。支持 custom、api、integ、syt 四种模式,连接配置包含完整用户名和密码;password 与 API 提取地址属于敏感字段,不应写入调用方日志。 - 代理管理 [创建代理](https://docs.zhongyibrowser.com/api-docs/489153597e0.md): 创建 custom 或 api 代理并返回创建后的完整详情。API 代理只需提供提取地址,Local API 会在本机解析当前 IP 和端口;integ、syt 不能通过该接口创建。用户名、密码和提取地址属于敏感字段,不应写入调用方日志。 - 代理管理 [获取代理详情](https://docs.zhongyibrowser.com/api-docs/489153598e0.md): 返回当前用户、当前团队有权访问的指定代理。响应包含完整连接配置、用户名、密码、最近检测状态和当前绑定的环境 ID;敏感字段不应写入调用方日志。 - 代理管理 [更新代理](https://docs.zhongyibrowser.com/api-docs/489153599e0.md): 完整替换 custom 或 api 代理的名称、备注和连接配置,并返回更新后的完整详情。mode 必须与当前代理一致;省略 remark、username 或 password 会将对应字段清空。integ、syt 属于平台管理代理,不能通过该接口更新。更新不会改变最近检测状态、检测时间和环境绑定关系。 - 代理管理 [检测临时代理](https://docs.zhongyibrowser.com/api-docs/489153601e0.md): 检测请求体中的 custom 或 api 临时代理配置,不创建代理,也不更新任何已保存代理。API 模式会先访问提取地址解析当前 IPv4 和端口,再检测该连接;代理连接失败或超时属于正常检测结果,HTTP 200 响应中的 status 为 unavailable。本接口只需要 Local API Key,不依赖客户端后端登录态。 - 代理管理 [检测已保存代理](https://docs.zhongyibrowser.com/api-docs/489153602e0.md): 检测当前用户、当前团队有权访问的已保存代理,支持 custom、api、integ、syt 四种模式,并更新该代理的 status 和 checked_at。同一代理的并发检测复用一个任务。API 代理会先检测当前 endpoint;失败时重新访问提取地址,必要时保存新的 endpoint 后再检测。代理连接失败或提取失败均作为 status=unavailable 的正常检测结果返回。 - 代理管理 [删除代理](https://docs.zhongyibrowser.com/api-docs/489153600e0.md): 删除当前用户、当前团队有权访问的 custom 或 api 代理,解除其环境绑定,并返回解绑环境数量。integ、syt 属于平台管理代理,不能通过该接口删除。 - 代理管理 [替换代理绑定环境](https://docs.zhongyibrowser.com/api-docs/489153603e0.md): 使用完整替换语义设置代理绑定的环境列表,支持 custom、api、integ、syt 四种代理。重复环境 ID 自动去重,空数组表示解绑全部。Local API 会先校验代理和全部环境均属于当前用户、当前团队;任何环境不存在或不可访问时整体返回 404,不调用后端绑定接口。该操作只更新代理绑定和环境代理信息,不启动或关闭浏览器。 - 平台账号 [获取账号平台](https://docs.zhongyibrowser.com/api-docs/490746733e0.md): 不分页返回当前用户可用的系统预设平台和自定义平台。可按 type 或 keyword 筛选;响应不包含页面元素定位器等内部字段。 - 平台账号 [创建自定义账号平台](https://docs.zhongyibrowser.com/api-docs/490932556e0.md): 为当前用户创建一个自定义账号平台。website 必须是包含 http:// 或 https:// 协议的有效网址;同一用户不能重复创建相同网址。接口不支持创建系统预设平台。 - 平台账号 [获取账号列表](https://docs.zhongyibrowser.com/api-docs/490672269e0.md): 分页返回当前用户、当前团队可访问的账号。响应包含密码和两步验证密钥等敏感字段,仅允许经 API Key 鉴权读取,且响应禁止缓存。 - 平台账号 [创建账号](https://docs.zhongyibrowser.com/api-docs/490672270e0.md): 使用已有账号平台 ID 创建 preset 或 custom 账号,成功后直接返回完整账号详情。账号平台必须与 type 对应。 - 平台账号 [获取账号详情](https://docs.zhongyibrowser.com/api-docs/490672271e0.md): 返回当前用户、当前团队可访问的指定账号,并包含完整环境绑定关系。不存在或不可访问时统一返回 40408。 - 平台账号 [更新账号](https://docs.zhongyibrowser.com/api-docs/490672272e0.md): 部分更新当前用户有权编辑的账号:省略字段保持原值,显式 null 清空可空字段。切换 preset/custom 类型时必须同时传递对应 platform_id。 - 平台账号 [删除账号](https://docs.zhongyibrowser.com/api-docs/490672273e0.md): 删除当前用户有权操作的单个账号。账号与环境的绑定关系会同步删除,环境本身不会被删除、启动或关闭。 - 扩展管理 [获取我的扩展](https://docs.zhongyibrowser.com/api-docs/489173378e0.md): 分页返回当前用户在当前团队下添加的扩展。该接口只读取服务端扩展资源和环境绑定关系,不下载、安装或更新本机扩展文件。 - 扩展管理 [获取团队扩展](https://docs.zhongyibrowser.com/api-docs/489173379e0.md): 分页返回当前团队已共享的扩展。该接口只读取共享资源,不改变团队共享状态或本机扩展文件。 - 扩展管理 [获取扩展详情](https://docs.zhongyibrowser.com/api-docs/489173380e0.md): 按完整 ID 返回当前用户自己的扩展或当前团队共享扩展,并包含完整环境绑定关系。不存在或当前用户不可见时返回 40404。 - 扩展管理 [替换扩展绑定环境](https://docs.zhongyibrowser.com/api-docs/489173381e0.md): 使用完整替换语义设置当前用户自己的扩展或当前团队共享扩展所绑定的环境。重复环境 ID 自动去重,空数组表示解绑全部;指定环境绑定会关闭全局启用。团队扩展的绑定关系属于团队共享资源,更新会影响该扩展在整个团队中的环境关系。任一环境不存在或不可访问时整体返回 404,不调用后端绑定接口。该操作不下载扩展,也不启动或关闭浏览器。 ## Schemas - [AccountCreateRequest](https://docs.zhongyibrowser.com/api-docs/296950214d0.md): - [AccountDeleteSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296950215d0.md): - [AccountDetailSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296950216d0.md): - [AccountListItem](https://docs.zhongyibrowser.com/api-docs/296950217d0.md): - [AccountListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296950218d0.md): - [AccountPlatformCreateRequest](https://docs.zhongyibrowser.com/api-docs/297124396d0.md): - [AccountUpdateRequest](https://docs.zhongyibrowser.com/api-docs/296950219d0.md): - [AccountPlatformCreateSuccessResponse](https://docs.zhongyibrowser.com/api-docs/297124397d0.md): - [AccountPlatformListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296997857d0.md): - [ActiveBrowser](https://docs.zhongyibrowser.com/api-docs/294231443d0.md): - [BrowserGroup](https://docs.zhongyibrowser.com/api-docs/294718972d0.md): - [ApiErrorResponse](https://docs.zhongyibrowser.com/api-docs/294017995d0.md): - [BrowserBatchRestartRequest](https://docs.zhongyibrowser.com/api-docs/295274879d0.md): - [BrowserBatchRestartSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295274880d0.md): - [BrowserBatchStartRequest](https://docs.zhongyibrowser.com/api-docs/294782116d0.md): - [BrowserBatchStartSuccessResponse](https://docs.zhongyibrowser.com/api-docs/294782117d0.md): - [BrowserStopAllRequest](https://docs.zhongyibrowser.com/api-docs/295124887d0.md): - [BrowserBatchStopRequest](https://docs.zhongyibrowser.com/api-docs/294782118d0.md): - [BrowserBatchStopSuccessResponse](https://docs.zhongyibrowser.com/api-docs/294782119d0.md): - [BrowserStopRequest](https://docs.zhongyibrowser.com/api-docs/294018001d0.md): - [BrowserCreateRequest](https://docs.zhongyibrowser.com/api-docs/297124398d0.md): - [BrowserCreateSuccessResponse](https://docs.zhongyibrowser.com/api-docs/297124399d0.md): - [ExtensionBindBrowsersRequest](https://docs.zhongyibrowser.com/api-docs/295882439d0.md): - [BrowserDetailSuccessResponse](https://docs.zhongyibrowser.com/api-docs/294017996d0.md): - [ExtensionListItem](https://docs.zhongyibrowser.com/api-docs/295882442d0.md): - [BrowserListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/294017997d0.md): - [BrowserRestartRequest](https://docs.zhongyibrowser.com/api-docs/295120130d0.md): - [BrowserRestartSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295120131d0.md): - [BrowserStartRequest](https://docs.zhongyibrowser.com/api-docs/294017999d0.md): - [BrowserStartSuccessResponse](https://docs.zhongyibrowser.com/api-docs/294018000d0.md): - [GroupMoveBrowsersRequest](https://docs.zhongyibrowser.com/api-docs/295424938d0.md): - [GroupMutationRequest](https://docs.zhongyibrowser.com/api-docs/295424940d0.md): - [BrowserStopSuccessResponse](https://docs.zhongyibrowser.com/api-docs/294018002d0.md): - [BrowserUpdateRequest](https://docs.zhongyibrowser.com/api-docs/297286578d0.md): - [BrowserUpdateSuccessResponse](https://docs.zhongyibrowser.com/api-docs/297286579d0.md): - [ExtensionBindBrowsersSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295882440d0.md): - [ExtensionDetailSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295882441d0.md): - [ExtensionListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295882443d0.md): - [GroupDeleteSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295424935d0.md): - [GroupDetailSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295424936d0.md): - [GroupListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295424937d0.md): - [GroupMoveBrowsersSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295424939d0.md): - [ProxyBindBrowsersRequest](https://docs.zhongyibrowser.com/api-docs/295867788d0.md): - [ProfileFontListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296606877d0.md): - [ProfileFontRandomSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296664239d0.md): - [ProfileHardwareRandomSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296664240d0.md): - [ProfileHardwareSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296606878d0.md): - [ProfileKernelListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296606879d0.md): - [ProfileLanguageListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296606880d0.md): - [ProfileScreenListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296606881d0.md): - [ProfileScreenRandomSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296664241d0.md): - [ProfileSystemListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296606882d0.md): - [ProfileSystemRandomSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296664242d0.md): - [ProfileTimezoneListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296606883d0.md): - [ProfileWebglSuccessResponse](https://docs.zhongyibrowser.com/api-docs/296606884d0.md): - [RecycleBinListItem](https://docs.zhongyibrowser.com/api-docs/295884480d0.md): - [ProxyBindBrowsersSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295867789d0.md): - [ProxyCheckRequest](https://docs.zhongyibrowser.com/api-docs/295867790d0.md): - [RecycleBinMutationRequest](https://docs.zhongyibrowser.com/api-docs/295884482d0.md): - [ProxyCheckSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295867791d0.md): - [ProxyCreateRequest](https://docs.zhongyibrowser.com/api-docs/295867792d0.md): - [ProxyDeleteSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295867793d0.md): - [ProxyDetailSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295867794d0.md): - [ProxyListItem](https://docs.zhongyibrowser.com/api-docs/295574820d0.md): - [ProxyListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295574821d0.md): - [ProxySavedCheckSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295867795d0.md): - [ProxyUpdateRequest](https://docs.zhongyibrowser.com/api-docs/295867796d0.md): - [RecycleBinClearSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295884478d0.md): - [RecycleBinDeleteSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295884479d0.md): - [RecycleBinListSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295884481d0.md): - [RecycleBinRestoreSuccessResponse](https://docs.zhongyibrowser.com/api-docs/295884483d0.md): - [StatusSuccessResponse](https://docs.zhongyibrowser.com/api-docs/294018003d0.md):