Create a browser (Beta)

Beta: create a browser sandbox, which runs one persistent Chrome that other sandboxes attach to. Logins made in it persist across restarts. It keeps its memory when it stops and is never deleted automatically.

POST /api/v2/sandboxes/browsers

Error

A valid request URL is required to generate request examples

201

{
  "attachments": [
    {
      "act_url": "<string>",
      "api_cdp_url": "<string>",
      "cdp_url": "<string>",
      "clients": [
        "<string>"
      ],
      "controller": "agent",
      "created_at": "<string>",
      "height": 123,
      "id": "<string>",
      "links_expire_at": "2023-11-07T05:31:56Z",
      "localhost_alias": "<string>",
      "name": "<string>",
      "reason": "<string>",
      "sandbox": "<string>",
      "tabs": [
        {
          "id": "<string>",
          "title": "<string>",
          "url": "<string>"
        }
      ],
      "unrestricted": true,
      "view_url": "<string>",
      "width": 123
    }
  ],
  "hidpi": true,
  "id": "<string>",
  "name": "<string>",
  "status": "<string>"
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Body

application/json

hidpi · boolean

HiDPI renders pages at twice the resolution, so the live view is sharp on HiDPI screens, at four times the pixels for the browser to render and stream. Off by default, and fixed once the browser is created.

idle_ttl_seconds · integer

IdleTTLSeconds stops the browser after this long without use. A stopped browser resumes with its memory on the next connection. Defaults to the sandbox default; 0 disables the idle stop.

Required range: x >= 0

mem_bytes · integer

name · string

Name of the browser sandbox. Generated when omitted, as "browser-" followed by the browser's ID.

vcpus · integer

VCPUs and MemBytes size the browser sandbox, as for any sandbox. With neither set, a browser gets 2 vCPUs and 8 GiB.

Response

201

application/json

Created

attachments · object[]

Attachments are listed only while the browser is running.

Show child attributes

hidpi · boolean

HiDPI reports whether pages render at twice the resolution. It is reported only while the browser is running.

id · string

name · string

status · string