Automation API endpoint reference

The full list of local Automation API endpoints, their responses, and how to authenticate each request.

All Automation API endpoints live on the local server at http://127.0.0.1:36912 (the port shown in your Automation panel). Every request must be authenticated.

Authentication

Send your token as a header on every request:

Authorization: Bearer YOUR_TOKEN

Or pass it as a query parameter: ?token=YOUR_TOKEN.

Endpoints

  • GET /sw/health — server status. Returns { ok, product, version }.
  • GET /sw/profiles — list your local profiles. Returns { ok, profiles: [{ id, name, browser, status }] }.
  • GET /sw/running — profiles currently open. Returns { ok, running: [...] }.
  • POST /sw/profile/{id}/start — launch a profile and return a raw CDP WebSocket. Returns { ok, ws, webSocketDebuggerUrl }.
  • POST /sw/profile/{id}/stop — close a running profile. Returns { ok }.
  • GET /sw/profile/{id}/ws — get the WebSocket of a profile that is already running. Returns { ok, ws }.

A typical sequence

  1. 1GET /sw/health to confirm the server is up.
  2. 2GET /sw/profiles to find the id of the profile you want.
  3. 3POST /sw/profile/{id}/start to launch it and receive the ws URL.
  4. 4Connect your automation client to ws and run your script.
  5. 5POST /sw/profile/{id}/stop when you're finished.

Note

The ws value is a raw CDP endpoint. Connect Puppeteer, Playwright or a CDP-capable Selenium client to it — you don't need any additional launch flags.

Still need a hand?

Email our team and a real person will get back to you, usually within a few hours.

[email protected]
Try in the cloud →Start free trial