Open Docs
  1. API Usage Guide
Open Docs
  • Developer Guide
    • Introduction
    • Beginner's Guide
    • Integration Guide
  • API Usage Guide
    • Create Browser Fingerprint
    • Query All Launched Browsers
    • Query Browser Fingerprint
    • Start Browser (POST)
    • Start Browser (GET)
    • Stop All Browsers
    • Query API Status
  1. API Usage Guide

Start Browser (GET)

API Description#

Function: Start a browser instance
Protocol: HTTP
Method: GET
URI: /api/v1/browser/start

Request Parameters#

ParameterDescriptionTypeRequiredOptional ValuesDefault
env_idBrowser ID (unique ID generated after environment import)stringYes
headlessWhether to start in headless modenumberNoNot passed: No, 1: YesNot passed
append_cmdBrowser startup commandstringNo

Request Example#

GET http://127.0.0.1:50230/api/v1/browser/start?env_id=337a934fa89244a183c64**********

Response Data#

ParameterDescriptionTypeOptional ValuesDefault
codeExecution status codeint0: success, -1: input format error, -2: quantity exception
msgReturn success or failure messagestring
dataReturn dataobject

Data Structure#

ParameterDescriptionTypeOptional ValuesDefault
debuggingPortDebug portstring
webdriverBrowser program locationstring
wsWebSocket informationobject

WS Structure#

ParameterDescriptionTypeOptional ValuesDefault
seleniumBrowser debug interface for Selenium automationstring
puppeteerBrowser debug interface for Puppeteer automationstring

Example Response#

Success:
{
  "code": 0,
  "msg": "success",
  "data": {
    "status": "Active"
  }
}
Failure:
{
  "code": -1,
  "data": {},
  "msg": "failed"
}

Status Codes#

CodeDescription
0Success
-1Server error
-2Missing appid
Modified at 2025-06-21 02:16:50
Previous
Start Browser (POST)
Next
Stop All Browsers
Built with