Puppeteer Page

All Page methods available when using the Puppeteer driver.

Access via runtime.page after launching a Puppeteer runtime.

POST /v1/workspaces/{workspaceId}/execute

1
{
2
  "runtime": "my-browser",
3
  "steps": [
4
    {
5
      "call": "page.goto",
6
      "args": ["https://example.com"]
7
    }
8
  ]
9
}

Navigation

goto(url, options?)

Navigate to a URL.

1
await runtime.page.goto('...');

Returns PuppeteerHTTPResponse \| null — The main resource response, or null if navigating to about:blank.

Upstream docs

reload(options?)

Reload the page.

1
await runtime.page.reload();

Returns PuppeteerHTTPResponse \| null

Upstream docs

goBack(options?)

Navigate back in history.

1
await runtime.page.goBack();

Returns PuppeteerHTTPResponse \| null

Upstream docs

goForward(options?)

Navigate forward in history.

1
await runtime.page.goForward();

Returns PuppeteerHTTPResponse \| null

Upstream docs

waitForNavigation(options?)

Wait for navigation to complete.

1
await runtime.page.waitForNavigation();

Returns PuppeteerHTTPResponse \| null

Upstream docs

Page Info

title()

Get the page title.

1
await runtime.page.title();

Returns string

Upstream docs

url()

Get the current URL.

1
await runtime.page.url();

Returns string

Upstream docs

content()

Get the full HTML content.

1
await runtime.page.content();

Returns string

Upstream docs

setContent(html, options?)

Set the page content.

1
await runtime.page.setContent('...');

Upstream docs

setViewport(viewport)

Set the viewport size. Pass null to reset to default.

1
await runtime.page.setViewport(/* viewport */);

Upstream docs

viewport()

Get the current viewport.

1
await runtime.page.viewport();

Returns PuppeteerViewport \| null

Upstream docs

Actions

click(selector, options?)

Click on an element matching the selector.

1
await runtime.page.click('...');

Upstream docs

type(selector, text, options?)

Type text into an element.

1
await runtime.page.type('...', '...');

Upstream docs

focus(selector)

Focus on an element.

1
await runtime.page.focus('...');

Upstream docs

hover(selector)

Hover over an element.

1
await runtime.page.hover('...');

Upstream docs

select(selector, …values)

Select options in a <select> element.

1
await runtime.page.select('...', /* values */);

Returns string[]

Upstream docs

tap(selector)

Tap on an element (for touch devices).

1
await runtime.page.tap('...');

Upstream docs

Queries

$(selector)

Query for a single element.

1
await runtime.page.$('...');

Returns RemotePuppeteerElementHandle \| null

Upstream docs

$$(selector)

Query for all matching elements.

1
await runtime.page.$$('...');

Returns RemotePuppeteerElementHandle[]

Upstream docs

$x(expression)

Evaluate XPath expression.

1
await runtime.page.$x('...');

Returns RemotePuppeteerElementHandle[]

Upstream docs

locator(selector)

Create a locator for the given selector.

1
runtime.page.locator('...');

Returns RemotePuppeteerLocator

Upstream docs

Content

textContent(selector)

Get the text content of an element matching the selector.

1
await runtime.page.textContent('...');

Returns string \| null

innerHTML(selector)

Get the inner HTML of an element matching the selector.

1
await runtime.page.innerHTML('...');

Returns string

State Checks

isJavaScriptEnabled()

Check if JavaScript is enabled.

1
await runtime.page.isJavaScriptEnabled();

Returns boolean

Upstream docs

isDragInterceptionEnabled()

Check if drag interception is enabled.

1
runtime.page.isDragInterceptionEnabled();

Returns boolean

Upstream docs

isServiceWorkerBypassed()

Check if service worker bypass is enabled.

1
await runtime.page.isServiceWorkerBypassed();

Returns boolean

Upstream docs

Waiting

waitForSelector(selector, options?)

Wait for a selector to appear in the DOM.

1
await runtime.page.waitForSelector('...');

Returns RemotePuppeteerElementHandle \| null

Upstream docs

waitForTimeout(milliseconds)

Wait for a timeout.

1
await runtime.page.waitForTimeout(0);

Upstream docs

waitForFunction(pageFunction, options?, …args)

Wait for a function to return true.

1
await runtime.page.waitForFunction('...');

Upstream docs

waitForNetworkIdle(options?)

Wait for network to be idle.

1
await runtime.page.waitForNetworkIdle();

Upstream docs

waitForFrame(urlOrPredicate, options?)

Wait for a frame to appear.

1
await runtime.page.waitForFrame('...');

Returns RemotePuppeteerFrame

Upstream docs

waitForFileChooser(options?)

Wait for a file chooser to appear.

1
await runtime.page.waitForFileChooser();

Returns RemotePuppeteerFileChooser

Upstream docs

waitForRequest(urlOrPredicate, options?)

Wait for a specific request.

1
await runtime.page.waitForRequest('...');

Returns PuppeteerHTTPRequest

Upstream docs

waitForResponse(urlOrPredicate, options?)

Wait for a specific response.

1
await runtime.page.waitForResponse('...');

Returns PuppeteerHTTPResponse

Upstream docs

waitForDevicePrompt(options?)

Wait for a device prompt (e.g., Bluetooth, USB).

1
await runtime.page.waitForDevicePrompt();

Returns { devices: Array<{ name: string; id: string }>; select: (deviceId: string) => Promise<void>; cancel: () => Promise<void> }

Upstream docs

Screenshots & PDF

screenshot(options?)

Take a screenshot (returns base64 string or Buffer).

1
await runtime.page.screenshot();

Returns string \| Buffer

Upstream docs

pdf(options?)

Generate a PDF (returns base64 string or Buffer).

1
await runtime.page.pdf();

Returns string \| Buffer

Upstream docs

Evaluation

evaluate(pageFunction, …args)

Evaluate JavaScript in the page context.

1
await runtime.page.evaluate('...');

Returns T

Upstream docs

$eval(selector, pageFunction, …args)

Evaluate JavaScript on a selected element.

1
await runtime.page.$eval('...', '...');

Returns T

Upstream docs

$$eval(selector, pageFunction, …args)

Evaluate JavaScript on all matching elements.

1
await runtime.page.$$eval('...', '...');

Returns T

Upstream docs

evaluateHandle(pageFunction, …args)

Evaluate handle (returns a JSHandle).

1
await runtime.page.evaluateHandle('...');

Returns unknown

Upstream docs

evaluateOnNewDocument(pageFunction, …args)

Add a script to evaluate when a new document is created.

1
await runtime.page.evaluateOnNewDocument('...');

Returns { identifier: string }

Upstream docs

Cookies

cookies(…urls)

Get all cookies.

1
await runtime.page.cookies();

Returns PuppeteerCookie[]

Upstream docs

setCookie(…cookies)

Set cookies.

1
await runtime.page.setCookie(/* PuppeteerCookie[] */);

Upstream docs

deleteCookie(…cookies)

Delete cookies.

1
await runtime.page.deleteCookie(/* PuppeteerCookie[] */);

Upstream docs

Lifecycle

bringToFront()

Bring page to front.

1
await runtime.page.bringToFront();

Upstream docs

close()

Close the page.

1
await runtime.page.close();

Upstream docs

Other

emulateMediaType(type?)

Emulate media type.

1
await runtime.page.emulateMediaType();

Upstream docs

emulateMediaFeatures(features?)

Emulate media features.

1
await runtime.page.emulateMediaFeatures();

Upstream docs

emulateTimezone(timezoneId?)

Emulate timezone.

1
await runtime.page.emulateTimezone();

Upstream docs

emulateVisionDeficiency(type?)

Emulate vision deficiency.

1
await runtime.page.emulateVisionDeficiency();

Upstream docs

setGeolocation(geolocation)

Set geolocation.

1
await runtime.page.setGeolocation(/* PuppeteerGeolocation */);

Upstream docs

setUserAgent(userAgent)

Set user agent.

1
await runtime.page.setUserAgent('...');

Upstream docs

setExtraHTTPHeaders(headers)

Set extra HTTP headers.

1
await runtime.page.setExtraHTTPHeaders(/* Record<string, string> */);

Upstream docs

createCDPSession()

Create a CDP session.

1
await runtime.page.createCDPSession();

Returns { sessionId: string }

Upstream docs

sendCDP(method, params?)

Send a CDP command directly.

1
await runtime.page.sendCDP('...');

Returns T

metrics()

Get metrics.

1
await runtime.page.metrics();

Returns Record<string, number>

Upstream docs

setJavaScriptEnabled(enabled)

Set JavaScript enabled/disabled.

1
await runtime.page.setJavaScriptEnabled(true);

Upstream docs

setCacheEnabled(enabled)

Set cache enabled/disabled.

1
await runtime.page.setCacheEnabled(true);

Upstream docs

setOfflineMode(enabled)

Set offline mode.

1
await runtime.page.setOfflineMode(true);

Upstream docs

emulateNetworkConditions(conditions)

Emulate network conditions.

1
await runtime.page.emulateNetworkConditions(/* conditions */);

Upstream docs

addScriptTag(options)

Add script tag.

1
await runtime.page.addScriptTag(/* { url?: string; path?: string; content?: string; type?: string } */);

Returns PuppeteerSerializedElement

Upstream docs

addStyleTag(options)

Add style tag.

1
await runtime.page.addStyleTag(/* { url?: string; path?: string; content?: string } */);

Returns PuppeteerSerializedElement

Upstream docs

setRequestInterception(enabled)

Set request interception enabled/disabled.

1
await runtime.page.setRequestInterception(true);

Upstream docs

authenticate(credentials)

Authenticate with HTTP auth.

1
await runtime.page.authenticate(/* credentials */);

Upstream docs

mainFrame()

Get the main frame.

1
runtime.page.mainFrame();

Returns RemotePuppeteerFrame

Upstream docs

frames()

Get all frames.

1
await runtime.page.frames();

Returns RemotePuppeteerFrame[]

Upstream docs

setDefaultNavigationTimeout(timeout)

Set the default navigation timeout.

1
await runtime.page.setDefaultNavigationTimeout(0);

Upstream docs

setDefaultTimeout(timeout)

Set the default timeout.

1
await runtime.page.setDefaultTimeout(0);

Upstream docs

getDefaultNavigationTimeout()

Get the default navigation timeout.

1
runtime.page.getDefaultNavigationTimeout();

Returns number

getDefaultTimeout()

Get the default timeout.

1
runtime.page.getDefaultTimeout();

Returns number

setBypassCSP(enabled)

Toggle bypassing Content-Security-Policy.

1
await runtime.page.setBypassCSP(true);

Upstream docs

removeScriptToEvaluateOnNewDocument(identifier)

Remove an injected script.

1
await runtime.page.removeScriptToEvaluateOnNewDocument('...');

Upstream docs

removeExposedFunction(name)

Remove an exposed function.

1
await runtime.page.removeExposedFunction('...');

Upstream docs

emulate(device)

Emulate a device (viewport + user agent).

1
await runtime.page.emulate(/* PuppeteerDevice */);

Upstream docs

emulateCPUThrottling(factor)

Emulate CPU throttling.

1
await runtime.page.emulateCPUThrottling(/* factor */);

Upstream docs

emulateIdleState(overrides?)

Emulate idle state.

1
await runtime.page.emulateIdleState();

Upstream docs

setBypassServiceWorker(bypass)

Set service worker bypass.

1
await runtime.page.setBypassServiceWorker(true);

Upstream docs

setDragInterception(enabled)

Set drag interception.

1
await runtime.page.setDragInterception(true);

Upstream docs

target()

Get the target for this page.

1
await runtime.page.target();

Returns PuppeteerTarget

Upstream docs

workers()

Get all web workers for this page.

1
await runtime.page.workers();

Returns PuppeteerWebWorker[]

Upstream docs

windowId()

Get the window ID.

1
await runtime.page.windowId();

Returns number

resize(options)

Resize the page.

1
await runtime.page.resize(/* { width: number; height: number } */);

queryObjects(prototypeHandle)

Query all objects of a given prototype.

1
await runtime.page.queryObjects(/* RemotePuppeteerElementHandle */);

Returns RemotePuppeteerElementHandle

Upstream docs

openDevTools(options?)

Open DevTools. Only works in headful mode.

1
await runtime.page.openDevTools();

Upstream docs

Mouse

mouse.click(x, y, options?)

Click at specific coordinates.

1
await runtime.page.mouse.click(0, 0);

mouse.move(x, y, options?)

Move mouse to specific coordinates.

1
await runtime.page.mouse.move(0, 0);

mouse.down(options?)

Press mouse button down.

1
await runtime.page.mouse.down();

mouse.up(options?)

Release mouse button.

1
await runtime.page.mouse.up();

mouse.wheel(options?)

Scroll mouse wheel.

1
await runtime.page.mouse.wheel();

mouse.drag(start, target)

Dispatches a drag event.

1
await runtime.page.mouse.drag(/* PuppeteerPoint */, /* PuppeteerPoint */);

Returns PuppeteerDragData

mouse.dragAndDrop(start, target, options?)

Perform a drag and drop operation.

1
await runtime.page.mouse.dragAndDrop(/* PuppeteerPoint */, /* PuppeteerPoint */);

mouse.dragEnter(target, data)

Dispatches a dragenter event.

1
await runtime.page.mouse.dragEnter(/* PuppeteerPoint */, /* PuppeteerDragData */);

mouse.dragOver(target, data)

Dispatches a dragover event.

1
await runtime.page.mouse.dragOver(/* PuppeteerPoint */, /* PuppeteerDragData */);

mouse.drop(target, data)

Performs a dragenter, dragover, and drop in sequence.

1
await runtime.page.mouse.drop(/* PuppeteerPoint */, /* PuppeteerDragData */);

mouse.reset()

Resets the mouse to the default state.

1
await runtime.page.mouse.reset();

Keyboard

keyboard.down(key, options?)

Dispatches a keydown event.

1
await runtime.page.keyboard.down(/* PuppeteerKeyInput */);

Upstream docs

keyboard.up(key)

Dispatches a keyup event.

1
await runtime.page.keyboard.up(/* PuppeteerKeyInput */);

Upstream docs

keyboard.press(key, options?)

Shortcut for Keyboard.down and Keyboard.up.

1
await runtime.page.keyboard.press(/* PuppeteerKeyInput */);

Upstream docs

keyboard.sendCharacter(char)

Dispatches a keypress and input event. This does not send a keydown or keyup event.

1
await runtime.page.keyboard.sendCharacter('...');

Upstream docs

keyboard.type(text, options?)

Sends a keydown, keypress/input, and keyup event for each character in the text.

1
await runtime.page.keyboard.type('...');

Upstream docs

Touchscreen

touchscreen.tap(x, y)

Dispatches a touchstart and touchend event (simulates a tap).

1
await runtime.page.touchscreen.tap(0, 0);

Upstream docs

touchscreen.touchStart(x, y)

Dispatches a touchstart event.

1
Performing a swipe gesture:
2
```ts
3
const touch = await page.touchscreen.touchStart(100, 100);
4
await touch.move(200, 100);
5
await touch.move(300, 100);
6
await touch.end();

| Parameter | Type | Required | Description |
|---|---|---|---|
| `x` | `number` | Yes | — |
| `y` | `number` | Yes | — |
**Returns** `TouchHandle`
— A TouchHandle for controlling this touch point.
[Upstream docs](https://pptr.dev/api/puppeteer.touchscreen.touchstart)
---
### touchscreen.touchMove(x, y)
Dispatches a `touchmove` event on the active touch.
<Note>
Note: Not every `touchMove` call results in a `touchmove` event being emitted,
depending on the browser's optimizations.
For more precise control over individual touches, use `touchStart()` which returns
a TouchHandle with its own `move()` method.
</Note>
```ts
await runtime.page.touchscreen.touchMove(0, 0);

Upstream docs

touchscreen.touchEnd()

Dispatches a touchend event.

1
await runtime.page.touchscreen.touchEnd();

Upstream docs