AgentQL Tools
The agentql/tools
module provides utility methods to help with data extraction and web automation.
- Use remote browser Create a remote browser session for browser automation.
Use remote browser
The following example demonstrates how to use the createBrowserSession
method to create a remote browser session:
import { wrap } from 'agentql';
import { createBrowserSession, UserAgentPreset } from 'agentql/tools';
import { chromium } from 'playwright';
async function main() {
const session = await createBrowserSession(UserAgentPreset.WINDOWS);
const browser = await chromium.connectOverCDP(session.cdpUrl);
const page = await wrap(await browser.newPage());
// Use AgentQL as normal
await page.goto('https://example.com');
// Get streaming URL to view the page
console.log(`View at: ${session.getPageStreamingUrl(0)}`);
await browser.close();
}
main().catch(console.error);
Methods
createBrowserSession
Creates a new remote browser session that provides a Chrome DevTools Protocol (CDP) URL for connecting to a remote browser instance and streaming URLs for real-time page viewing.
Remote browser sessions allow you to run browser automation on remote infrastructure while maintaining the familiar AgentQL API. See the Remote Browser Guide for complete usage examples.
Usage
const session = await createBrowserSession(UserAgentPreset.MACOS);
Arguments
-
uaPreset
UserAgentPreset (optional)User agent preset to simulate different operating systems. Can be
UserAgentPreset.WINDOWS
,UserAgentPreset.MACOS
, orUserAgentPreset.LINUX
.
Returns
-
Object containing CDP URL and methods for streaming page access.
Throws
APIKeyError
: If API key isn't set or invalidError
: If session creation fails
Types
BrowserSession
Represents an allocated remote browser session with CDP access and streaming capabilities.
Properties
-
cdpUrl
stringChrome DevTools Protocol URL for connecting to the remote browser.
Methods
-
getPageStreamingUrl(pageNum)
→ stringReturns a streaming URL for viewing a specific page in real-time.
Arguments:
pageNum
number: Page number (0-indexed)
UserAgentPreset
Enum for user agent presets to simulate different operating systems:
UserAgentPreset.WINDOWS
: Windows user agent and browser characteristicsUserAgentPreset.MACOS
: macOS user agent and browser characteristicsUserAgentPreset.LINUX
: Linux user agent and browser characteristics