Core API

Launch a profile

POST to launch a profile and receive a ready CDP endpoint plus driver recipes. An optional body sets per launch overrides that apply only to that launch.

Request

Send POST /api/profiles/{id}/launch. The body is optional. Any fields you pass are per launch overrides: they are applied to this launch only and are never written back to the saved profile.

POST /api/profiles/de-store-01/launch HTTP/1.1
Host: 127.0.0.1:8378
Authorization: Bearer <token>
Content-Type: application/json
 
{
  "stealth": "balanced",
  "headless": false,
  "proxy": "socks5://user:pass@gateway.example.com:1080",
  "args": ["--lang=de-DE"],
  "window": { "w": 1280, "h": 800 }
}

Launch options

All options are optional. Anything you omit falls back to the saved profile.

Field	Type	Description
stealth	"off" \| "balanced" \| "max"	Fingerprint strategy. off is clean Chromium with no fingerprint injection. balanced uses native fingerprints. max applies the strongest noise.
headless	boolean	Run without a visible window.
proxy	string	Overrides the profile proxy for this launch only.
args	string[]	Extra Chrome flags appended to the launch command line.
window	{ w, h }	Window size in pixels for this launch.
automation	boolean	Advisory hint. Accepted but advisory today.
ephemeral	boolean	Advisory hint. Accepted but advisory today.

stealth "off" is Chrome only. Firefox engine profiles always spoof their fingerprint.

Response

The response returns a ready CDP endpoint plus copy paste recipe strings for common drivers, so you do not have to assemble the connection arguments yourself.

{
  "profile_id": "de-store-01",
  "status": "running",
  "ws_endpoint": "ws://127.0.0.1:9222/devtools/browser/abc123",
  "cdp_http": "http://127.0.0.1:9222",
  "debugger_address": "127.0.0.1:9222",
  "playwright": "chromium.connectOverCDP(\"ws://127.0.0.1:9222/devtools/browser/abc123\")",
  "puppeteer": "puppeteer.connect({ browserWSEndpoint: \"ws://127.0.0.1:9222/devtools/browser/abc123\" })",
  "selenium": "options.debugger_address = \"127.0.0.1:9222\""
}

Field	Description
profile_id	The id of the launched profile.
status	Launch state, for example running.
ws_endpoint	WebSocket CDP endpoint for Playwright and Puppeteer.
cdp_http	HTTP CDP base, useful for the /json endpoints.
debugger_address	host:port form used by Selenium debugger_address.
playwright	Ready Playwright connect recipe string.
selenium	Ready Selenium debugger_address recipe string.
puppeteer	Ready Puppeteer connect recipe string.

Start free Quickstart