Skip to main content
POST
/
browser_pools
/
{id_or_name}
/
acquire
Acquire a browser from the pool
curl --request POST \
  --url https://api.onkernel.com/browser_pools/{id_or_name}/acquire \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "acquire_timeout_seconds": 123
}'
{
  "created_at": "2023-11-07T05:31:56Z",
  "cdp_ws_url": "wss://api.onkernel.com/browser/cdp?jwt=eyJ0eXAi...",
  "browser_live_view_url": "https://api.onkernel.com/browser/remote?jwt=eyJ0eXAi...",
  "headless": false,
  "stealth": false,
  "session_id": "htzv5orfit78e1m2biiifpbv",
  "persistence": {
    "id": "my-awesome-browser-for-user-1234"
  },
  "timeout_seconds": 123,
  "profile": {
    "id": "<string>",
    "name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "last_used_at": "2023-11-07T05:31:56Z"
  },
  "proxy_id": "<string>",
  "viewport": {
    "width": 1280,
    "height": 800,
    "refresh_rate": 60
  },
  "kiosk_mode": false,
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id_or_name
string
required

Browser pool ID or name

Body

application/json

Request body for acquiring a browser from the pool.

​
acquire_timeout_seconds
integer

Maximum number of seconds to wait for a browser to be available. Defaults to the calculated time it would take to fill the pool at the currently configured fill rate.

Response

Browser acquired successfully

​
created_at
string<date-time>
required

When the browser session was created.

​
cdp_ws_url
string
required

Websocket URL for Chrome DevTools Protocol connections to the browser session

Example:

"wss://api.onkernel.com/browser/cdp?jwt=eyJ0eXAi..."

​
headless
boolean
required

Whether the browser session is running in headless mode.

Example:

false

​
stealth
boolean
required

Whether the browser session is running in stealth mode.

Example:

false

​
session_id
string
required

Unique identifier for the browser session

Example:

"htzv5orfit78e1m2biiifpbv"

​
timeout_seconds
integer
required

The number of seconds of inactivity before the browser session is terminated.

​
browser_live_view_url
string

Remote URL for live viewing the browser session. Only available for non-headless browsers.

Example:

"https://api.onkernel.com/browser/remote?jwt=eyJ0eXAi..."

​
persistence
object

Optional persistence configuration for the browser session.

​
profile
object

Browser profile metadata.

​
proxy_id
string

ID of the proxy associated with this browser session, if any.

​
viewport
object

Initial browser window size in pixels with optional refresh rate. If omitted, image defaults apply (commonly 1024x768@60). Only specific viewport configurations are supported. The server will reject unsupported combinations. Supported resolutions are: 2560x1440@10, 1920x1080@25, 1920x1200@25, 1440x900@25, 1024x768@60, 1200x800@60 If refresh_rate is not provided, it will be automatically determined from the width and height if they match a supported configuration exactly. Note: Higher resolutions may affect the responsiveness of live view browser

​
kiosk_mode
boolean

Whether the browser session is running in kiosk mode.

Example:

false

​
deleted_at
string<date-time>

When the browser session was soft-deleted. Only present for deleted sessions.