Lifecycle states
A cloud browser moves through four states during its lifetime:startingandstoppingstill reserve your running allowance — they are not free slots.runningis the only state whereconnectUrlis present in the API response.stoppedreleases running allowance while the saved profile remains.
GET /cloud-browsers/:id to read the actual current state. Display runtime.status exactly as the API returns it; never infer or cache state locally.
Saved profiles vs. running sessions
Saving a profile is free in terms of running quota — a stopped profile occupies a saved profile slot but not a running slot. Only browsers instarting, running, or stopping state consume your concurrent running allowance.
Your plan’s allowances are returned on every GET /cloud-browsers call:
The Free plan allows saving one profile but cannot launch a browser. A paid plan is required to start a cloud browser runtime.
Opening the interactive viewer
When a cloud browser isrunning, the runtime.connectUrl field contains a URL you can open directly in your own browser to see and interact with the remote session in real time. This URL points to the live browser viewer and requires your profile owner’s session cookie — an API key alone does not grant viewer access.
Two ways to create and start
Option 1: Create then Start
Use this approach when you want to save a profile for later or when you need fine-grained control over when the browser starts.1
Create the profile
POST /cloud-browsers saves the profile configuration and returns an id. The browser is not started yet and consumes no running quota.2
Start the browser
POST /cloud-browsers/:id/start launches the saved profile. Pass your proxy on every start request — saved proxy settings do not replace the required top-level proxy field for API key callers.200 only once the browser reaches running.Option 2: Launch in one step
POST /cloud-browsers/launch creates the profile and starts the browser in a single request, waiting for running before returning 201. Use this when you want to open a browser immediately without a separate create step.
Proxy requirements
Proxy rules differ depending on how you authenticate:- API key (X-API-Key)
- Session / JWT Bearer
Every start request — including
/launch and /start — must include a valid top-level proxy object. Saved browserSettings.proxy, a previous run’s proxy, and countryCode cannot substitute for it.Credit billing
Cloud browsers are billed at 1 credit per started minute, rounded up, from the moment the browser successfully reachesrunning until stop is confirmed. A 202 stopping response means shutdown is still in progress — credits continue until runtime.status is stopped. Poll GET /cloud-browsers/:id with a bounded retry loop to confirm the stop.
Calling stop multiple times does not charge twice; repeated stops on an already-stopped profile return 200 with runtime.status: "stopped" at no cost.
API reference
List Cloud Browsers
List saved profiles and read your saved and running quotas.
Create Profile
Save a new browser profile without starting a runtime.
Launch
Create and start a browser in one request, waiting for running.
Start
Start a previously saved profile and wait for running confirmation.
Stop
Stop a running browser and release its running quota slot.