Skip to main content
POST
Create a browser session
The smallest request is {}. The response includes a signed connectUrl and an opaque settings.id; connect first, then navigate with Playwright or Puppeteer. The API does not accept startUrl.

Follow the Cloud Browser guide

Create, connect, navigate, reuse settings, and stop a browser safely.

Authorizations

X-Api-Key
string
header
required

Client API key for the authenticated account.

Body

application/json

Session-first browser request. Every field is optional; connect and navigate after creation.

settings
object
browser
object
storage
object
proxy
object
runtime
object
metadata
object

Response

Browser session started.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>
required
Available options:
running,
stopped,
timedOut,
failed
connectUrl
string | null
required
settings
object
required
runtime
object
required
createdAt
string
required
startedAt
string | null
required
expiresAt
string
required
endedAt
string | null
required
metadata
object