Local API reference
Version 0.6.0. The desktop app runs this API on http://127.0.0.1:<port>. Find the port and token under Settings → API. Send Authorization: Bearer <token>. The app also serves interactive docs at /docs and the raw spec at /openapi.json; download the spec.
Service
GET | /health | Liveness check (no token needed) |
GET | /openapi.json | This OpenAPI document |
GET | /docs | Swagger UI (HTML) |
GET | /meta | Statuses, folders, tags and trash count |
Profiles
GET | /profiles | List profiles (lite rows) |
POST | /profiles | Create a profile |
POST | /profiles/bulk-create | Create many profiles |
POST | /profiles/quick | Create a quick profile with defaults |
POST | /profiles/bulk | Bulk start/stop/update/trash/restore/purge |
GET | /profiles/{id} | Get one profile (full fingerprint) |
PATCH | /profiles/{id} | Update a profile |
DELETE | /profiles/{id} | Delete a profile permanently |
POST | /profiles/{id}/clone | Clone a profile |
POST | /profiles/{id}/trash | Move to trash |
POST | /profiles/{id}/restore | Restore from trash |
POST | /trash/purge | Purge old (or all) trashed profiles |
Fingerprint
GET | /devices | Device presets |
GET | /profiles/{id}/health | Fingerprint health report |
POST | /profiles/{id}/health/check | Re-check proxy and recompute health |
POST | /profiles/{id}/fingerprint-test | Run the built-in fingerprint test page |
Browser
POST | /profiles/{id}/start | Start the profile; returns wsEndpoint for Puppeteer/Playwright |
POST | /profiles/{id}/stop | Stop the profile |
GET | /running | Running profiles |
GET | /profiles/{id}/debug | Remote debugging endpoint of a running profile (wsEndpoint, browserURL, debuggerAddress) |
GET | /browser | Bundled Chromium install status |
POST | /browser/install | Download Chrome for Testing |
Cookies
GET | /profiles/{id}/cookies | Export cookies (JSON or Netscape) |
POST | /profiles/{id}/cookies | Import cookies |
GET | /profiles/{id}/cookies/cached | Last cookie snapshot without launching the browser (used by cloud sync) |
Proxies
GET | /proxies | Proxy library |
POST | /proxies | Add a proxy |
POST | /proxies/import | Bulk import (one per line) |
PATCH | /proxies/{id} | Update a proxy |
DELETE | /proxies/{id} | Delete a proxy (unlinks profiles) |
POST | /proxies/{id}/check | Check a saved proxy |
POST | /proxies/{id}/change-ip | Call the proxy change-IP URL |
POST | /proxy/check | Check an ad-hoc proxy string |
Extensions
GET | /extensions | Extension library |
POST | /extensions | Add an unpacked folder or .crx/.zip (base64) |
DELETE | /extensions/{id} | Delete an extension |
Automation
GET | /flows | RPA flows |
POST | /flows | Create or replace a flow |
POST | /flows/validate | Validate a flow without saving |
GET | /flows/{id} | Get a flow |
PUT | /flows/{id} | Update a flow |
DELETE | /flows/{id} | Delete a flow (and its tasks) |
POST | /flows/{id}/run | Run a flow on many profiles |
GET | /runs | Recent runs with per-profile progress |
GET | /runs/{id} | One run |
POST | /runs/{id}/cancel | Cancel a run |
POST | /cookie-robot | Warm up cookies by visiting sites like a person |
Scheduler
GET | /tasks | Scheduled tasks |
POST | /tasks | Create a task ("every 15m", "daily 09:30", "weekly mon 09:30", "once 2026-10-20T09:30") |
PUT | /tasks/{id} | Update a task |
DELETE | /tasks/{id} | Delete a task |
POST | /tasks/{id}/run | Run a task now |
Webhooks
GET | /webhooks | Webhooks (secrets hidden) |
POST | /webhooks | Add a webhook; the signing secret is returned once |
GET | /webhooks/deliveries | Recent delivery attempts |
DELETE | /webhooks/{id} | Delete a webhook |
POST | /webhooks/{id}/test | Send a test delivery |
Synchronizer
GET | /synchronizer | Synchronizer status |
POST | /synchronizer/start | Mirror leader input to followers |
POST | /synchronizer/stop | Stop mirroring |
POST | /synchronizer/arrange | Tile or cascade profile windows |