Roxy Browser

https://roxybrowser.cn/docs/
Admin
Roxy Browser Help Center provides documentation to quickly resolve user issues and explore advanced...
Tokens:48,376
Snippets:241
Trust Score:2.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### GET /browser/detail

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

获取指定浏览器窗口的详细信息。

```APIDOC
## GET /browser/detail

### Description
获取指定浏览器窗口的详细信息。

### Method
GET

### Endpoint
/browser/detail

### Parameters
#### Query Parameters
- **workspaceId** (int) - Required - 团队id
- **dirId** (string) - Required - 浏览器窗口id

### Request Example
{
  "workspaceId": 10,
  "dirId": "dc1e73d4dd954a"
}

### Response
#### Success Response (200)
- **code** (int) - 状态码
- **data** (object) - 返回数据

#### Response Example
{
  "code": 0,
  "data": {
    "total": 1,
    "rows": [
      {
        "dirId": "dc1e73d4dd954a",
        "windowSortNum": 99,
        "windowName": "Roxytest",
        "coreVersion": "117",
        "os": "Windows",
        "osVersion": "11"
      }
    ]
  }
}
```

--------------------------------

### GET /browser/list_v3

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

获取浏览器窗口列表，支持通过团队ID、窗口ID、名称、操作系统等条件进行筛选和分页查询。

```APIDOC
## GET /browser/list_v3

### Description
获取浏览器窗口列表，支持通过团队ID、窗口ID、名称、操作系统等条件进行筛选和分页查询。

### Method
GET

### Endpoint
/browser/list_v3

### Parameters
#### Query Parameters
- **workspaceId** (int) - Required - 团队id
- **dirIds** (string) - Optional - 浏览器窗口id，多个以英文逗号分隔
- **windowName** (string) - Optional - 浏览器窗口名称
- **sortNums** (string) - Optional - 窗口序号，多个以英文逗号分隔
- **os** (string) - Optional - 操作系统
- **projectIds** (string) - Optional - 项目ID，多个以英文逗号分隔
- **windowRemark** (string) - Optional - 窗口备注
- **page_index** (int) - Optional - 分页索引，默认1
- **page_size** (int) - Optional - 分页条数，默认15

### Request Example
{
  "workspaceId": 10,
  "dirIds": "dc1ed4d,2e18ce,yy67yegk",
  "windowName": "Roxytest",
  "sortNums": "11,12",
  "os": "Windows",
  "projectIds": "10,11",
  "windowRemark": "Windows",
  "page_index": 1,
  "page_size": 15
}

### Response
#### Success Response (200)
- **code** (int) - 状态码
- **data** (object) - 返回数据
- **msg** (string) - 提示信息

#### Response Example
{
  "code": 0,
  "data": {
    "total": 1,
    "rows": [
      {
        "dirId": "dc1e73d4dd954a",
        "windowSortNum": 99,
        "windowName": "Roxytest",
        "coreVersion": "117",
        "coreType": "Chrome",
        "os": "Windows",
        "osVersion": "11",
        "windowRemark": "Roxytest",
        "createTime": "2023-12-04 21:55:58",
        "updateTime": "2023-12-04 21:56:01",
        "userName": "roxytest"
      }
    ]
  },
  "msg": "成功"
}
```

--------------------------------

### Node.js API Client Initialization

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Basic setup for interacting with the Roxy API using the node-fetch library.

```javascript
const fetch = require('node-fetch');
```

--------------------------------

### Get Account List

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Retrieves account information for a specific workspace.

```json
{
    "workspaceId": 1,       // 团队id，int类型，必传，通过团队项目接口【/browser/workspace】获取
    "accountId": 1,         // 账号库id, int类型, 非必传
    "page_index": 1,        // 分页索引, int类型, 非必传, 默认1
    "page_size": 15        // 分页条数, int类型, 非必传, 默认15
}
```

```json
{
    "code": 0,                                                                  // 状态码, 0:成功，500：失败，int类型
    "data": {
        "total": 1,                                                             // 总条数
        "rows": [
            {
                "id": 3,                                                        // 账号库id
                "platformUrl": "https://www.tiktok.com/",                       // 平台账号url
                "platformUserName": "Roxytest",                                 // 账号库用户名
                "platformPassword": "123456",                                   // 账号库密码
                "platformEfa": "2F3CD67B6D",                                    // 账号库Efa
                "platformCookies": [{"name": "1","value": "2","domain": "3"}],  // 账号库Cookies
                "platformName": "Roxytest",                                     // 平台名称
                "platformRemarks": "Roxytest",                                  // 平台备注
                "createTime": "2024-10-23 15:45:46",                            // 创建时间
                "updateTime": "2024-10-23 15:45:46"                             // 修改时间
            }
        ] 
    },
    "msg": "成功"                                                               // 返回结果, str类型
}
```

--------------------------------

### Selenium Automation Integration

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Example demonstrating how to open a browser via RoxyClient and connect a Selenium WebDriver instance using the returned debugger address.

```python
from selenium import webdriver
from selenium.common.exceptions import TimeoutException
from selenium.webdriver.common.keys import Keys
from selenium.webdriver.chrome.options import Options
from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
from selenium.webdriver.chrome.service import Service
import RoxyClient

if __name__ == "__main__":
    brwoser_id = "8ba009cbbedf192f34817574c81c9454"
    # 初始化客户端
    client = RoxyClient(port=50000,token="d1f491a404druyt54880943e5c3cd9ca25")
    # 打开浏览器
    rsp = client.browser_open(brwoser_id)
    if rsp.get("code") != 0:
        print("浏览器打开失败:",rsp)
        exit(0)
    # 获取selenium的连接信息
    debuggerAddress = rsp.get("data").get("http")
    driverPath = rsp.get("data").get("driver")
    print(f"浏览器打开成功,debuggerAddress:{debuggerAddress},driverPath:{driverPath}")

    # selenium 连接代码
    chrome_options = webdriver.ChromeOptions()
    chrome_options.add_experimental_option("debuggerAddress", debuggerAddress)

    chrome_service = Service(driverPath)
    driver = webdriver.Chrome(service=chrome_service, options=chrome_options)

    driver.get('https://ip123.in/')
    print(driver.title)

    #client.browser_close(brwoser_id)
```

--------------------------------

### GET /proxy/list

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

获取指定团队下的代理 IP 列表，支持分页查询。

```APIDOC
## GET /proxy/list

### Description
根据团队 ID 获取代理 IP 列表，支持通过分页参数进行筛选。

### Method
GET

### Endpoint
/proxy/list

### Parameters
#### Query Parameters
- **workspaceId** (int) - Required - 团队id
- **page_index** (int) - Optional - 分页索引, 默认1
- **page_size** (int) - Optional - 分页条数, 默认15

### Response
#### Success Response (200)
- **code** (int) - 状态码, 0:成功，500：失败
- **data** (object) - 包含 total 和 rows 列表
- **msg** (string) - 返回结果

#### Response Example
{
    "code": 0,
    "data": {
        "total": 1,
        "rows": []
    },
    "msg": "成功"
}
```

--------------------------------

### GET /account/list

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Retrieves a paginated list of platform accounts for a specific workspace.

```APIDOC
## GET /account/list

### Description
Retrieves a paginated list of platform accounts for a specific workspace.

### Method
GET

### Endpoint
/account/list

### Parameters
#### Request Body
- **workspaceId** (int) - Required - 团队id
- **page_index** (int) - Optional - 分页索引
- **page_size** (int) - Optional - 分页条数

### Response
#### Success Response (200)
- **code** (int) - 状态码, 0:成功，500：失败
- **data** (object) - 包含total和rows列表
- **msg** (string) - 返回结果
```

--------------------------------

### GET /browser/account

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Retrieves a list of configured platform accounts for a specific workspace.

```APIDOC
## GET /browser/account

### Description
Retrieves a list of configured platform accounts for a specific workspace.

### Method
GET

### Endpoint
/browser/account

### Parameters
#### Query Parameters
- **workspaceId** (integer) - Required - The ID of the team workspace.
- **accountId** (integer) - Optional - The ID of the account library.
- **page_index** (integer) - Optional - Page number for pagination.
- **page_size** (integer) - Optional - Number of items per page.
```

--------------------------------

### GET /browser/list_v3

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Retrieves a list of browser windows within a specific workspace.

```APIDOC
## GET /browser/list_v3

### Description
Retrieves a list of browser windows within a specific workspace.

### Method
GET

### Endpoint
/browser/list_v3

### Parameters
#### Query Parameters
- **workspaceId** (integer) - Required - The ID of the team workspace.
- **sortNums** (string) - Optional - Sorting criteria.
- **page_index** (integer) - Optional - Page number for pagination.
- **page_size** (integer) - Optional - Number of items per page.
```

--------------------------------

### 获取已购代理 IP 列表请求参数

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

调用 GET /proxy/bought_list 接口时使用的 JSON 请求体。

```json
{
    "workspaceId": 1,    // 团队 id，int类型，必传，通过团队项目接口【/browser/workspace】获取
    "page_index": 1,     // 分页索引，int类型，非必传，默认1
    "page_size": 15,     // 分页条数，int类型，非必传，默认15
    "type":0             // 查询类型，int类型，非必传，默认0，0:查询所有，1:查询可用，
}
```

--------------------------------

### Get Team Project List

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Retrieves a paginated list of team projects.

```json
{
    "page_index": 1,                                // 分页索引, int类型, 非必传, 默认1
    "page_size": 15                                // 分页条数, int类型, 非必传, 默认15
}
```

```json
{
    "code": 0,                                              // 状态码, 0:成功，500：失败，int类型
    "data": {
        "total": 1,                                         // 总条数
        "rows": [
            {
                "id": 1,                                    // 团队ID
                "workspaceName": "feihairui's Team",   // 团队名称
                "project_details": [                        // 项目详细信息
                    {   
                        "projectId": 1,                     // 项目编号
                        "projectName": "xx项目"             // 项目名称
                    }
                ]
            }
        ]
    },
    "msg": "成功"                                           // 返回结果, str类型
}
```

--------------------------------

### 创建浏览器窗口

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Initializes a new browser window instance with custom configuration parameters.

```APIDOC
## 创建浏览器窗口

### Parameters
#### Request Body
- **workspaceId** (int) - Required - 团队id
- **windowName** (string) - Optional - 窗口名称
- **coreVersion** (string) - Optional - 内核版本，枚举值 例如：138，137，136等
- **coreType** (string) - Optional - 浏览器内核类型，Chrome/Firefox
- **os** (string) - Optional - 操作系统, 枚举值：Windows、macOS、Linux、IOS、Android
- **osVersion** (string) - Optional - 操作系统版本
- **openWorkbench** (int) - Optional - 是否打开工作台, 关闭: 0，开启: 1，跟随软件设置: 2
- **resolutionType** (boolean) - Optional - 分辨率，true: 自定义, false: 跟随系统
- **resolutionX** (string) - Optional - 自定义分辨率宽度值
- **resolutionY** (string) - Optional - 自定义分辨率高度值
- **fontType** (boolean) - Optional - 字体指纹，随机：true，跟随系统：false
- **webRTC** (int) - Optional - webrtc 替换: 0，真实：1，禁止：2
- **webGL** (boolean) - Optional - webGL图像， 随机：true，真实：false
- **webGLInfo** (boolean) - Optional - webGLInfo开关，自定义：true，真实：false
- **webGLManufacturer** (string) - Optional - webGLInfo为自定义时指定的webGL厂商值
- **webGLRender** (string) - Optional - webGLInfo为自定义时指定的webGL渲染值
- **webGpu** (string) - Optional - webGpu，基于webgl匹配：webgl，真实：real，禁用：block
- **canvas** (boolean) - Optional - canvas，随机：true，真实：false
- **audioContext** (boolean) - Optional - audioContext值，随机：true，真实：false
- **speechVoices** (boolean) - Optional - Speech Voices，随机：true，真实：false
- **doNotTrack** (boolean) - Optional - doNotTrack，true：开启，false：关闭
- **clientRects** (boolean) - Optional - ClientRects，随机：true，真实：false
- **deviceInfo** (boolean) - Optional - 媒体设备，随机：true，真实：false
- **deviceNameSwitch** (boolean) - Optional - 设备名称，随机：true，真实：false
- **macInfo** (boolean) - Optional - MAC地址，自定义：true，真实：false
- **hardwareConcurrent** (string) - Optional - 硬件并发数
- **deviceMemory** (string) - Optional - 设备内存
- **disableSsl** (boolean) - Optional - ssl指纹设置, true: 开启, false: 关闭
- **disableSslList** (array) - Optional - ssl特性值列表
- **portScanProtect** (boolean) - Optional - 端口扫描保护, false: 关闭, true: 开启
- **portScanList** (string) - Optional - 端口扫描保护开启时的白名单
- **useGpu** (boolean) - Optional - 使用硬件加速模式，true：是，false：否
- **sandboxPermission** (boolean) - Optional - 禁用沙盒，true：开启，false：关闭
- **startupParam** (string) - Optional - 浏览器启动参数
- **openBattery** (boolean) - Optional - 电池 API 模拟总开关
- **openCharging** (boolean) - Optional - 开启电池模拟时的充电状态
- **chargingTime** (string) - Optional - 距离充满的秒数
- **dischargingTime** (string) - Optional - 距离耗尽的秒数
- **level** (string) - Optional - 电量，0–1
- **openNetwork** (boolean) - Optional - Network Information API 模拟总开关
- **networkType** (string) - Optional - 连接类型：wifi、cellular、ethernet、bluetooth、wimax、other、unknown
- **networkSpeed** (string) - Optional - 有效连接类型：slow-2G、2g、3g、4g
- **downloadSpeed** (string) - Optional - 下行速率（Mbps）
- **maxDownloadSpeed** (string) - Optional - 最大下行速率（Mbps）
- **latency** (string) - Optional - 往返时延（ms）
- **saveFlowMode** (boolean) - Optional - 省流 / Save-Data 模式
- **openBluetooth** (boolean) - Optional - 蓝牙模拟总开关
- **bluetoothAdapter** (boolean) - Optional - 是否模拟存在蓝牙适配器
- **blockDomainList** (string) - Optional - 网址访问黑名单
- **allowDomainList** (string) - Optional - 网址访问白名单
```

--------------------------------

### POST /browser/create

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Creates a new browser window with specified configurations such as OS, proxy settings, and platform accounts.

```APIDOC
## POST /browser/create

### Description
Creates a new browser window within a specified workspace. Allows configuration of browser environment, proxy settings, and initial platform account data.

### Method
POST

### Endpoint
/browser/create

### Parameters
#### Request Body
- **workspaceId** (int) - Required - Team ID, retrieved via /browser/workspace
- **windowName** (string) - Optional - Name of the browser window
- **coreVersion** (string) - Optional - Browser core version (e.g., 138, 137, 136)
- **coreType** (string) - Optional - Browser core type (Chrome/Firefox)
- **os** (string) - Optional - Operating system (Windows, macOS, Linux, IOS, Android)
- **osVersion** (string) - Optional - OS version
- **userAgent** (string) - Optional - User Agent string
- **cookie** (List) - Optional - Initial cookies
- **searchEngine** (string) - Optional - Default search engine (Google, Microsoft Bing, Yahoo, Yandex, DuckDuckGo)
- **labelIds** (List) - Optional - List of label IDs
- **windowPlatformList** (List) - Optional - List of platform account objects
- **defaultOpenUrl** (List) - Optional - List of initial browser tab URLs
- **windowRemark** (string) - Optional - Window notes
- **projectId** (int) - Optional - Project ID
- **proxyInfo** (object) - Optional - Proxy configuration object

### Request Example
{
    "workspaceId": 1,
    "windowName": "Roxytest",
    "coreVersion": "117",
    "coreType": "Chrome",
    "os": "Windows",
    "osVersion": "11",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
    "cookie": [],
    "searchEngine": "Google",
    "labelIds": [12, 13],
    "windowPlatformList": [{
        "id": 0,
        "platformUrl": "https://www.tiktok.com/",
        "platformUserName": "Roxytest",
        "platformPassword": "12345655",
        "platformEfa": "2F3CD67B6D",
        "platformRemarks": "Roxytest"
    }],
    "defaultOpenUrl": ["https://www.facebook.com"],
    "windowRemark": "Roxytest",
    "projectId": 1,
    "proxyInfo": {
        "moduleId": 0,
        "proxyMethod": "custom",
        "proxyCategory": "noproxy"
    }
}
```

--------------------------------

### 创建浏览器窗口

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Configures and creates a new browser window instance with specific environment and fingerprint settings.

```APIDOC
## 创建浏览器窗口

### Description
Creates a new browser window with custom configurations including proxy settings, fingerprinting, and synchronization preferences.

### Parameters
#### Request Body
- **userAgent** (string) - Optional - Browser user agent string
- **cookie** (boolean) - Optional - Cookie settings
- **searchEngine** (string) - Optional - Default search engine
- **labelIds** (List) - Optional - List of label IDs
- **defaultOpenUrl** (List) - Optional - List of URLs to open on startup
- **windowRemark** (string) - Optional - Window description
- **projectId** (number) - Optional - Project ID
- **windowPlatformList** (List) - Optional - Platform account details (platformUrl, platformUserName, platformPassword, platformEfa, platformRemarks)
- **proxyInfo** (object) - Optional - Proxy configuration (proxyMethod, proxyCategory, ipType, host, port, proxyUserName, proxyPassword, refreshUrl, checkChannel)
- **fingerInfo** (object) - Optional - Fingerprint and browser behavior settings (isLanguageBaseIp, language, isDisplayLanguageBaseIp, displayLanguage, isTimeZone, timeZone, position, isPositionBaseIp, longitude, latitude, precisionPos, forbidAudio, forbidImage, forbiddenPictureSize, forbidMedia, openWidth, openHeight, openBookmarks, positionSwitch, windowRatioPosition, isDisplayName, syncBookmark, syncHistory, syncTab, syncCookie, syncExtensions, syncPassword, syncIndexedDb, syncLocalStorage, clearCacheFile, clearCookie, clearLocalStorage, randomFingerprint, forbidSavePassword, stopOpenNet, stopOpenIP, stopOpenPosition, openWorkbench, resolutionType, resolutionX, resolutionY, fontType, webRTC, webGL, webGLInfo, webGLManufacturer, webGLRender, webGpu, canvas, audioContext, speechVoices, doNotTrack, clientRects, deviceInfo)
```

--------------------------------

### GET /proxy/detect_channel

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

获取可用的代理检测渠道列表。

```APIDOC
## GET /proxy/detect_channel

### Description
获取检测渠道列表，用于后续创建代理时指定查询渠道。

### Method
GET

### Endpoint
/proxy/detect_channel

### Response
#### Success Response (200)
- **code** (int) - 状态码, 0:成功，500：失败
- **data** (array) - 渠道列表
- **msg** (string) - 返回结果

#### Response Example
{
    "code": 0,
    "data": [
        {
            "label": "",
            "type": "",
            "value": ""
        }
    ],
    "msg": "成功"
}
```

--------------------------------

### 创建浏览器窗口

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Initializes a browser window with specific proxy and fingerprint settings.

```APIDOC
## POST /create-browser-window

### Description
Creates a new browser window instance with configurable proxy settings and browser fingerprinting options.

### Request Body
- **ipType** (str) - Optional - Network protocol (IPV4, IPV6). Default: IPV4.
- **host** (str) - Optional - Proxy host.
- **port** (str) - Optional - Proxy port.
- **proxyUserName** (str) - Optional - Proxy username.
- **proxyPassword** (str) - Optional - Proxy password.
- **refreshUrl** (str) - Optional - Refresh URL.
- **checkChannel** (str) - Optional - IP query channel (IPRust.io, IP-API, IP123.in).
- **fingerInfo** (object) - Optional - Browser fingerprint configuration object containing settings for language, timezone, geolocation, and synchronization.
```

--------------------------------

### GET /browser/account

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Retrieves a list of accounts within a specific workspace.

```APIDOC
## GET /browser/account

### Description
Retrieves a paginated list of accounts for a given workspace.

### Method
GET

### Endpoint
/browser/account

### Parameters
#### Query Parameters
- **workspaceId** (int) - Required - 团队id
- **accountId** (int) - Optional - 账号库id
- **page_index** (int) - Optional - 分页索引, 默认1
- **page_size** (int) - Optional - 分页条数, 默认15

### Response
#### Success Response (200)
- **code** (int) - 状态码, 0:成功，500：失败
- **data** (object) - 包含 total 和 rows 的数据对象
- **msg** (string) - 返回结果

#### Response Example
{
    "code": 0,
    "data": {
        "total": 1,
        "rows": [
            {
                "id": 3,
                "platformUrl": "https://www.tiktok.com/",
                "platformUserName": "Roxytest",
                "platformPassword": "123456",
                "platformEfa": "2F3CD67B6D",
                "platformCookies": [{"name": "1","value": "2","domain": "3"}],
                "platformName": "Roxytest",
                "platformRemarks": "Roxytest",
                "createTime": "2024-10-23 15:45:46",
                "updateTime": "2024-10-23 15:45:46"
            }
        ]
    },
    "msg": "成功"
}
```

--------------------------------

### GET /browser/label

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Retrieves a list of labels associated with a specific workspace.

```APIDOC
## GET /browser/label

### Description
Retrieves all labels for a given workspace.

### Method
GET

### Endpoint
/browser/label

### Parameters
#### Query Parameters
- **workspaceId** (int) - Required - 团队id

### Response
#### Success Response (200)
- **code** (int) - 状态码, 0:成功，500：失败
- **data** (array) - 标签列表
- **msg** (string) - 返回结果

#### Response Example
{
    "code": 0,
    "data": [
        {
            "id": 3,
            "color": "#7558F5",
            "name": "roxy测试标签"
        }
    ],
    "msg": "成功"
}
```

--------------------------------

### POST /account/create

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Creates a new platform account within a specified workspace.

```APIDOC
## POST /account/create

### Description
Creates a new platform account within a specified workspace.

### Method
POST

### Endpoint
/account/create

### Parameters
#### Request Body
- **workspaceId** (int) - Required - 团队id
- **platformUrl** (string) - Required - 平台 URL
- **platformUserName** (string) - Optional - 平台账号
- **platformPassword** (string) - Optional - 平台密码
- **platformEfa** (string) - Optional - 2FA密钥
- **platformRemarks** (string) - Optional - 备注

### Response
#### Success Response (200)
- **code** (int) - 状态码, 0:成功，500：失败
- **data** (object) - 包含platform_id
- **msg** (string) - 返回结果
```

--------------------------------

### GET /browser/workspace

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Retrieves a list of team projects associated with the user.

```APIDOC
## GET /browser/workspace

### Description
Retrieves a paginated list of team projects.

### Method
GET

### Endpoint
/browser/workspace

### Parameters
#### Query Parameters
- **page_index** (int) - Optional - 分页索引, 默认1
- **page_size** (int) - Optional - 分页条数, 默认15

### Response
#### Success Response (200)
- **code** (int) - 状态码, 0:成功，500：失败
- **data** (object) - 包含 total 和 rows 的数据对象
- **msg** (string) - 返回结果

#### Response Example
{
    "code": 0,
    "data": {
        "total": 1,
        "rows": [
            {
                "id": 1,
                "workspaceName": "feihairui's Team",
                "project_details": [
                    { "projectId": 1, "projectName": "xx项目" }
                ]
            }
        ]
    },
    "msg": "成功"
}
```

--------------------------------

### POST /browser/create

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Creates a new browser window.

```APIDOC
## POST /browser/create

### Description
Creates a new browser window.

### Method
POST

### Endpoint
/browser/create

### Parameters
#### Request Body
- **workspaceId** (integer) - Required - The ID of the team workspace.
```

--------------------------------

### POST /browser/open

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Opens a browser window with specified configuration and returns automation connection details.

```APIDOC
## POST /browser/open

### Description
Opens a browser window based on the provided workspace and directory ID.

### Method
POST

### Endpoint
/browser/open

### Parameters
#### Request Body
- **workspaceId** (int) - Required - 团队id
- **dirId** (string) - Required - 浏览器窗口id
- **args** (List) - Optional - 浏览器启动参数
- **forceOpen** (boolean) - Optional - 是否强制打开
- **headless** (boolean) - Optional - 是否以无头模式打开

### Request Example
{
    "workspaceId": 1,
    "dirId": "dc1e73d4dd954a3a8ca087d53d2e18ce",
    "args": ["--remote-allow-origins=*", "--disable-audio-output"],
    "forceOpen": false,
    "headless": false
}

### Response
#### Success Response (200)
- **code** (int) - 状态码, 0:成功，500：失败
- **data** (object) - 包含自动化工具接口信息
- **msg** (string) - 返回结果
```

--------------------------------

### Get Label List

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Retrieves all labels associated with a specific workspace.

```json
{
    "workspaceId": 1       // 团队id，int类型，必传，通过团队项目接口【/browser/workspace】获取
}
```

```json
{
    "code": 0,                                                                  // 状态码, 0:成功，500：失败，int类型
    "data": [
        {
            "id": 3,                                                           // 标签id
            "color": "#7558F5",                                                // 标签颜色
            "name": "roxy测试标签"                                              // 标签名称
        }
    ],
    "msg": "成功"                                                               // 返回结果, str类型
}
```

--------------------------------

### Open Browser Window

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Initiates a browser session. Note that certain command-line arguments are reserved by the system and cannot be overridden.

```json
{
    "workspaceId": 1,                                                   // 团队id，int类型，必传，通过团队项目接口【/browser/workspace】获取
    "dirId": "dc1e73d4dd954a3a8ca087d53d2e18ce",                        // 浏览器窗口id, str类型，必传
    "args": ["--remote-allow-origins=*", "--disable-audio-output"],      // 浏览器启动参数，List类型，非必传
    "forceOpen": false,  // 是否强制打开
    "headless": false    // 是否以无头模式打开
}
```

```json
 {
    "code": 0,                                                                              // 状态码, 0:成功，500：失败，int类型
    "data": {       
        "ws": "ws://127.0.0.1:52314/devtools/browser/857b2d0d-aae6-4852-ab3c-0784f0b2c1fb", // 用于自动化工具的ws接口
        "http": "127.0.0.1:52314",                                                          // 用于自动化工具的http接口
        "coreVersion": "112",                                                               // 内核版本
        "driver": "C:\\Users\\lumibrowser\\AppData\\Roaming\\lumibrowser\\chrome-bin\\125\\chromedriver.exe",  // 用于自动化工具的webdriver
        "sortNum": 3474,                                                                    // 窗口排序号
        "windowName": "",                                                                   // 窗口名称
        "windowRemark": "",                                                                 // 窗口备注
        "pid":1111                                                                          // 进程id
    },
    "msg": "成功"                                                                           // 返回结果, str类型
}
```

--------------------------------

### GET /browser/connection_info

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Retrieves connection information for currently opened browsers.

```APIDOC
## GET /browser/connection_info

### Description
Retrieves connection details for opened browsers, optionally filtered by window IDs.

### Method
GET

### Endpoint
/browser/connection_info

### Parameters
#### Query Parameters
- **dirIds** (list) - Optional - List of browser window IDs to query.
```

--------------------------------

### Configure Stdio MCP Server

Source: https://roxybrowser.cn/docs/features/ai-agent.html

Use the command line interface to connect local MCP services via standard input/output.

```text
npx -y excel-csv-mcp-server
```

--------------------------------

### Create Browser Window Request

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

JSON request body for the POST /browser/create endpoint to initialize a new browser window.

```json
{
    "workspaceId": 1,                                           // 团队id，int类型，必传，通过团队项目接口【/browser/workspace】获取
    "windowName": "Roxytest",                                   // 窗口名称, str类型，非必传
    "coreVersion": "117",                                       // 内核版本，枚举值 例如：138，137，136等, str类型，非必传
    "coreType": "Chrome",                                       // 浏览器内核类型，Chrome/Firefox, str类型，非必传
    "os": "Windows",                                            // 操作系统, 枚举值：Windows、macOS、Linux、IOS、Android, str类型，非必传，默认Windows
    "osVersion": "11",                                          // 操作系统版本, Windows的枚举值：11、10、8、7; Linux的枚举值：ALL; macOS的枚举值: 15.3.2,15.3.1,15.3,15.2,15.1,15.0.1,15.0,14.7.4,14.7.3,14.7.2,14.7.1,14.7,14.6.1,14.6,14.5,14.4.1,14.4,14.3.1,14.3,14.2.1,14.2,14.1,13.7.4,13.7.3,13.7.2,13.7.1,13.7，Android的枚举值：14,13,12,11,10,9；IOS的枚举值：18.2,18.1,18.0,17.0,16.6,16.5,16.4,16.3,16.2,16.1,16.0,15.7,15.6,15.5,15.4,15.3,15.2,15.1,15.0,14.7,14.6,14.5,14.4,14.3,14.2,14.1,14.0；str类型，非必传，默认取最大值
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",   // userAgent, str类型，非必传
    "cookie": [],                                               // cookie, List类型，非必传
    "searchEngine": "Google",                                   // 搜索引擎，枚举值：Google, Microsoft Bing, Yahoo, Yandex, DuckDuckGo, str类型，非必传，默认为Google
    "labelIds": [12,13],                                        // 标签列表id，List类型，非必传，通过标签列表接口【/browser/label】获取
    "windowPlatformList": [{
        "id": 0,                                                // 平台账号id，int类型，非必传，通过平台账号列表接口【/account/list】获取
        "platformUrl": "https://www.tiktok.com/",               // 平台账号URL，str类型，非必传
        "platformUserName": "Roxytest",                         // 平台账号，str类型，非必传
        "platformPassword": "12345655",                         // 平台密码，str类型，非必传
        "platformEfa": "2F3CD67B6D",                            // efa，str类型，非必传                           
        "platformRemarks": "Roxytest"                           // 平台备注，str类型，非必传      
    }],
    "defaultOpenUrl": ["https://www.facebook.com"],             // 存储浏览器标签页，List类型，非必传
    "windowRemark": "Roxytest",                                 // 窗口备注, str类型，非必传
    "projectId":1,                                              // 项目ID, int类型, 非必传，通过团队项目接口【/browser/workspace】获取
    "proxyInfo": {
        "moduleId": 0,                                          // 代理id，int类型，0 为不使用，非必传，通过代理列表接口【/proxy/list】获取
        "proxyMethod": "custom",                                // 代理方式，枚举值：手动填写：custom，选择代理 IP：choose，str类型
        "proxyCategory": "noproxy",                             // 代理类型，枚举值：noproxy, HTTP, HTTPS, SOCKS5, SSH, str类型，非必传，默认为noproxy
```

--------------------------------

### GET /health

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

Performs a health check on the RoxyBrowser service to ensure it is operational.

```APIDOC
## GET /health

### Description
Performs a health check on the RoxyBrowser service.

### Method
GET

### Endpoint
/health

### Response
#### Success Response (200)
- **code** (int) - 状态码, 0:成功，500：失败
- **msg** (string) - 返回结果

#### Response Example
{
    "code": 0,
    "msg": "成功"
}
```

--------------------------------

### POST /proxy/create

Source: https://roxybrowser.cn/docs/api-documentation/api-endpoint.html

创建一个新的代理 IP 配置。

```APIDOC
## POST /proxy/create

### Description
向指定团队添加一个新的代理 IP 配置信息。

### Method
POST

### Endpoint
/proxy/create

### Parameters
#### Request Body
- **workspaceId** (int) - Required - 团队id
- **checkChannel** (string) - Required - 查询渠道
- **ipType** (string) - Required - 网络协议 (IPV4, IPV6)
- **protocol** (string) - Required - 代理协议 (HTTP, HTTPS, SOCKS5)
- **host** (string) - Required - 代理主机
- **port** (string) - Required - 代理端口
- **proxyUserName** (string) - Optional - 代理账号
- **proxyPassword** (string) - Optional - 代理密码
- **refreshUrl** (string) - Optional - 刷新URL
- **remark** (string) - Optional - 备注

### Response
#### Success Response (200)
- **code** (int) - 状态码, 0:成功，500：失败
- **msg** (string) - 返回结果

#### Response Example
{
    "code": 0,
    "msg": "成功"
}
```
Tokens:
Raw