Skip to content

Launch Browser

Description

Starts a profile. On success returns debuggingPort for Playwright/Puppeteer CDP connection.

Request

Method: POST

URL: /api/launchBrowser

Body: provide one of:

FieldTypeRequiredDescription
idintno*Profile ID
namestringno*Profile name
remarkstringno*Remark

*At least one identifier is required.

Example

json
{
  "id": 1
}
bash
curl --location 'http://localhost:9000/api/launchBrowser' \
  --header 'api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"id":1}'

Response

Success

json
{
  "success": true,
  "debuggingPort": 443
}

Connect Playwright:

javascript
await chromium.connectOverCDP(`http://localhost:${debuggingPort}`);

Error

json
{
  "success": false,
  "error": "Browser list is empty or not found."
}

See: Stop browser · Is running · Automation API