Skip to main content
POST
Start a previously saved cloud browser profile by its id. The endpoint blocks until the browser reaches running state and then returns 200 with the full runtime object, including connectUrl, so you can open the interactive session immediately. A successful 200 response means billing has begun: credits are consumed at one credit per started minute from this moment until you call POST /cloud-browsers/{id}/stop.
string (UUID)
required
The persistent profile identifier returned by POST /cloud-browsers (create) or GET /cloud-browsers (list). This is distinct from the runtime sessionId.
object
required
Required on every x-api-key start. You must supply a valid top-level proxy on each start request even if a proxy was saved in the profile’s browserSettings. A saved proxy, a managed countryCode, or a previous run’s proxy cannot satisfy this requirement.Supply either the server form or the split protocol + host + port form:
  • server — full URL: http://proxy.example.com:8080 or socks5://proxy.example.com:1080. Must include an explicit port (1–65535). Must not contain embedded credentials, path, query, or fragment. Cannot be combined with host.
  • protocol — http or socks5.
  • host — proxy hostname.
  • port — integer or numeric string from 1 to 65535.
Omit both username and password for an unauthenticated proxy, or supply both as non-empty strings. A proxy failure must never fall back to a direct connection. Start overrides affect this run only and do not update the saved profile.
string (UUID)
Required when authenticating with a session cookie or Authorization: Bearer. Select an active, unexpired API key that belongs to your account. When authenticating with x-api-key, the current key is selected automatically; if apiKeyId is also provided, it must match.
string
Available to session/Bearer callers only; not accepted with x-api-key. Use GLOBAL for a random popular region or a two-letter ISO code such as FR to prefer a trusted proxy in that region with dynamic fallback. An empty string is not a valid selection. Cannot be combined with proxy in the same request. This override affects this run only and does not update the saved profile.
array
Optional per-run cookie override. Takes precedence over any cookies saved in the profile for this run only, without updating the saved profile configuration.
object
Optional per-run fingerprint override, merged by field with saved settings for this run only. Supported fields: webRtc (forward | real | disabled), webGl / webGlImage / canvas / audioContext / clientRects / speechVoices / fonts / hardware (random | real), webGpu (random | real | disabled), doNotTrack (random | enabled | disabled). Legacy hardwareConcurrency and deviceMemory accept integers 1–64. Invalid or conflicting combinations return INVALID_FINGERPRINT_SETTINGS.

Response

boolean
Always true on success.
object
Runtime state at confirmation.
Billing runs at 1 credit per started minute from a successful 200 response until you confirm stop via POST /cloud-browsers/{id}/stop. Closing the viewer tab or losing the connection does not stop billing.