Skip to main content
POST
The smallest request is {}. Add optional startUrl to open one or more pages at launch: supply absolute HTTP or HTTPS URLs in one string, separated by commas without spaces, up to 2,048 characters total. Omit startUrl when supplying settings.id.
For example, this request body opens two separate tabs:
Connect with the returned connectUrl to work with the opened tabs. Select the tab by URL and wait for the page content you need. If you omit startUrl, navigate with Playwright or Puppeteer after connecting.

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. Use startUrl to open pages at launch, or navigate after connecting. Do not combine startUrl with settings.id.

settings
object
browser
object
storage
object
proxy
object
runtime
object
startUrl
string<uri>

Optional start URL or comma-separated list of start URLs. Each URL opens in a separate tab when the browser launches. Use absolute HTTP or HTTPS URLs, separated by commas without spaces. Supply one string, not a JSON array. The 2,048-character limit applies to the complete string, including separators. Percent-encode commas inside a URL as %2C. Omit this field when supplying settings.id. Wait for the page content you need after connecting.

Maximum string length: 2048
Example:

"https://example.com/,https://example.org/"

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