Local API
The local API lets scripts on your computer create, launch and stop profiles. Available from the Base plan.
Enable
- Settings → Automation → Enable API.
- The default address is http://127.0.0.1:47125. You can change the Port (1024–65535).
- Copy the Token. New issues a new token and revokes the old one.
Routes
- GET /v1/profiles — list
- POST /v1/profiles — create
- GET /v1/profiles/{id} — a single profile
- POST /v1/profiles/{id}/start — launch; the response contains port and ws_endpoint for connecting
- POST /v1/profiles/{id}/stop — stop
- DELETE /v1/profiles/{id} — move to Trash
- POST /v1/sync — window synchronizer
Authorization
Header Authorization: Bearer <token>. The API listens on this computer only (127.0.0.1).
Possible errors
Invalid token. You can find it in Settings, under “Automation”.
Why: The request has no token, or the token is outdated.
What to do: Copy the current token from Automation.
Port N is used by another program. Choose a different port.
Why: Another application is already listening on this port.
What to do: Set a different Port and enable the API again.
The profile is already open from the app without DevTools. Stop it and launch it through the API.
Why: A profile launched with the button in the app doesn't open a DevTools port.
What to do: Stop the profile and launch it with a /start request.
The profile isn't running.
Why: You can only stop or connect to a running profile.
What to do: Launch it with /start first.
The local API (automation) is available on the Base plan and above.
Why: It's a Base plan feature.
What to do: Upgrade to Base or higher.