Start Browser (POST)
API Description
Request Parameters
| Parameter | Description | Type | Required | Optional Values | Default |
|---|---|---|---|---|---|
| env_id | Browser ID (unique ID generated after environment import) | string | Yes | ||
| custom_data | Custom data that can be read from localStorage's customData variable | any | No | ||
| accelerator_keys | Shortcut keys combination | string | No | Left part: ctrl/alt/shift (at least one); Right part: 0-9/a-z/F1-F12 | |
| headless | Whether to start in headless mode | string | No | Not passed: No, 1: Yes | Not passed |
| append_cmd | Browser startup command | string | No | ||
| bypasslist | Proxy bypass list (domains separated by comma) | string | No | ||
| no_sandbox | Disable sandbox | number | No | 0, 1 | |
| urls | URLs to open | string[] | No | ||
| cookies | Cookies to set | string | No | ||
| proxy | Proxy configuration | object | No | ||
| blacklist | Domain blacklist | string[] | No | ||
| remote_debugging | Enable remote debugging for RPA | number | No | 1: Enable, 0: Disable | 0 |
| remotedebuggingaddress | Remote control IP address | string | No | LAN IP address | |
| enableextensiongetall | Built-in extensions access | number | No | 1: Can get all extensions via chrome.management.getAll, 0: Only from Chrome Store | 0 |
| copy_plugins | Plugins to copy | string | No | "all" for all plugins, or plugin names separated by space |
Proxy Configuration
| Parameter | Description | Type | Optional Values | Default |
|---|---|---|---|---|
| protocol | Proxy protocol | string | socks5 | |
| host | IP address | string | ||
| port | Port number | number | ||
| userName | Username | string | ||
| password | Password | string |
Request Example
POST http://127.0.0.1:*/api/v1/browser/start?env_id=337a934fa89244a183c64**********{
"env_id": "60d70438977a4517a83*********",
"custom_data": "test custom data",
"accelerator_keys": "ctrl|alt|shift+F9",
"urls": ["www.baidu.com", "www.163.com"],
"append_cmd": "",
"cookies": "",
"proxy": {
"protocol": "http",
"host": "192.168.0.171",
"port": 10809,
"userName": "",
"password": ""
},
"blacklist": ["taobao.com"],
"remote_debugging": 1,
"remotedebuggingaddress": "",
"copy_plugins": "all"
}Response Data
| Parameter | Description | Type | Optional Values | Default |
|---|---|---|---|---|
| code | Execution status code | int | 0: success, -1: input format error, -2: quantity exception | |
| msg | Return success or failure message | string | ||
| data | Return data | object |
Data Structure
| Parameter | Description | Type | Optional Values | Default |
|---|---|---|---|---|
| status | Browser status | string | Active: Browser is running, Inactive: Browser is not running | |
| ws | WebSocket information | object | ||
| debuggingPort | Debug port | string | ||
| webdriver | Browser program location | string |
WS Structure
| Parameter | Description | Type | Optional Values | Default |
|---|---|---|---|---|
| selenium | Browser debug interface for Selenium automation | string | ||
| puppeteer | Browser debug interface for Puppeteer automation | string |
Example Response
{
"code": 0,
"msg": "success",
"data": {
"status": "Active",
"ws": {
"selenium": "127.0.0.1:53785",
"puppeteer": "ws://127.0.0.1:53785/devtools/browser/3f868b43-4f3f-4e7b-8faf-8f2d7e79d6cc"
},
"debuggingPort": "53785",
"webdriver": "D:\\test\\browser-api\\browser\\chrome119-1.0.1.3\\chromedriver.exe"
}
}{
"code": -1,
"data": {},
"msg": "failed"
}Status Codes
| Code | Description |
|---|---|
| 0 | Success |
| -1 | Server error |
| -2 | Missing appid |
Modified at 2025-06-21 02:16:35