> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Browserless

The Browserless connector lets your AI agent act in each user's Browserless account. Each user connects their own Browserless API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 36 tools.

**Authentication:** API Key
**Categories:** Developer Tools, Automation
**Tools:** 36: 20 read, 9 write, 7 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=BROWSERLESS)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Browserless connection

   In **AgentKit > Connections**, create a Browserless connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'browserless'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Browserless:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'browserless_agent_runs_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "browserless"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Browserless:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="browserless_agent_runs_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Browserless credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'browserless_agent_run_get',
  toolInput: {
    run_id: '<run_id>',
  },
  connector: 'browserless',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="browserless_agent_run_get",
    tool_input={
        "run_id": "<run_id>",
    },
    connection_name="browserless",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `browserless_agent_run_get`

Get Agent Run · Read-only

Get one agent run: its status, the latest result and step rationales, and the full turn transcript.
Returns status (for example running, succeeded, failed or needs_human), the structured result and the transcript.
Use this to poll a run started by browserless_agent_run_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `run_id` (`string`, required): Agent run ID returned by browserless_agent_run_create or browserless_agent_runs_list. Example: ar_5d2e9f1c8b3a.

Example input: `{"run_id":"<run_id>"}`

### `browserless_agent_runs_list`

List Agent Runs · Read-only

List your Browserless agent runs, newest first, with a short preview of each.
Returns run summaries with id, status and preview, plus a cursor for the next page.
Use this to find a run id. Use browserless_agent_run_get for the full result.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Pagination cursor: the nextCursor value from the previous page. Example: eyJpZCI6ImNfN2YzYSJ9.
- `limit` (`integer`, optional): Maximum runs to return. Example: 20.
- `status` (`string`, optional): Only return jobs with this status, for example running, completed, failed or cancelled. Example: completed.

Example input: `{}`

### `browserless_batch_scrape_get`

Get Batch Scrape · Read-only

Get the progress of a batch scrape job and a page of its results.
Returns status, counters and per-page results with content URLs, plus a next link that pages with skip.
Use this to poll a job started by browserless_batch_scrape_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `batch_id` (`string`, required): Batch scrape job ID returned by browserless_batch_scrape_create. Example: b_19c4e8a2f760.
- `skip` (`integer`, optional): Number of page results to skip, for paging through results. Use the next link from the previous response. Example: 0.

Example input: `{"batch_id":"<batch_id>"}`

### `browserless_browser_pages_list`

List Browser Tabs · Read-only

List the open tabs of a running Browserless browser.
Returns each tab's targetId, URL and title, plus a view-only live URL per tab when mint is true.
Use this to pick a target_id for browserless_live_url_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `browser_id` (`string`, required): ID of a running browser, for example the session or browser ID returned by browserless_session_create. Example: 9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210.
- `mint` (`boolean`, optional): Also create a view-only live URL for each tab. Example: false.

Example input: `{"browser_id":"<browser_id>"}`

### `browserless_content`

Get Rendered HTML · Read-only

Load a URL (or raw HTML) in a headless Chromium browser, run its JavaScript and return the fully rendered HTML.
Returns the page's HTML as text, not JSON.
Use this when you need the exact DOM. Use browserless_smart_scrape for clean markdown.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `best_attempt` (`boolean`, optional): Carry on when a wait (navigation, selector, event) fails or times out instead of returning an error. Example: true.
- `block_ads` (`boolean`, optional): Block ads and trackers while the page loads. Example: true.
- `cookies` (`array`, optional): Cookies to set before loading the page. Each needs name, value and a domain or url. Example: [{"name": "session", "value": "abc123", "domain": "example.com"}]
- `extra_http_headers` (`object`, optional): Extra HTTP headers sent with every request the page makes, as name-value pairs. Example: {"Accept-Language": "en-US"}
- `goto_options` (`object`, optional): Navigation options: waitUntil (load, domcontentloaded, networkidle0 or networkidle2), timeout in milliseconds and referer. Example: {"waitUntil": "networkidle2", "timeout": 30000}
- `html` (`string`, optional): Raw HTML to render instead of loading a URL. Send url or html. Example: <html><body><h1>Hello</h1></body></html>.
- `proxy` (`string`, optional): Route the browser through Browserless's built-in proxy network. residential is best against bot detection; datacenter is cheaper. Uses proxy units on your plan. Example: residential. One of: `residential`, `datacenter`.
- `proxy_country` (`string`, optional): Two-letter country code for the proxy exit, used together with proxy. Example: us.
- `reject_resource_types` (`array`, optional): Resource types to block, for example image, media, font or stylesheet, to speed up loading. Example: ["image", "media", "font"]
- `set_javascript_enabled` (`boolean`, optional): Run the page's JavaScript. Defaults to true. Example: true.
- `timeout` (`integer`, optional): Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.
- `url` (`string`, optional): Page URL to load (http or https). Send url or html. Example: https://example.com.
- `wait_for_selector` (`object`, optional): Wait for a CSS selector before continuing: selector, plus optional timeout (ms), visible and hidden. Example: {"selector": "#results", "timeout": 10000}
- `wait_for_timeout` (`integer`, optional): Extra milliseconds to wait after the page loads. Example: 1000.

Example input: `{}`

### `browserless_crawl_get`

Get Crawl · Read-only

Get the status of one crawl job and a page of its scraped results.
Returns status, progress counters, per-page metadata with content URLs, and a next link that pages with skip.
Use this to poll a crawl started by browserless_crawl_create.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `crawl_id` (`string`, required): Crawl job ID returned by browserless_crawl_create or browserless_crawls_list. Example: c_7f3a2b91e4d5.
- `skip` (`integer`, optional): Number of page results to skip, for paging through results. Use the next link from the previous response. Example: 0.

Example input: `{"crawl_id":"<crawl_id>"}`

### `browserless_crawls_list`

List Crawls · Read-only

List the crawl jobs in your Browserless account, newest first.
Returns crawl summaries with id, status, progress counters and timestamps, plus nextCursor.
Use this to find a crawl id. Use browserless_crawl_get for its pages.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `cursor` (`string`, optional): Pagination cursor: the nextCursor value from the previous page. Example: eyJpZCI6ImNfN2YzYSJ9.
- `limit` (`integer`, optional): Maximum crawls to return. Example: 20.
- `status` (`string`, optional): Only return jobs with this status, for example running, completed, failed or cancelled. Example: completed.

Example input: `{}`

### `browserless_live_url_get`

Get Live URL Status · Read-only

Get the status of a live URL and, once finished, how it ended (for example the viewer clicked Done).
Returns the live URL status and completion reason.
Use this to wait for a person to finish a step in a live URL.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `browser_id` (`string`, required): ID of a running browser, for example the session or browser ID returned by browserless_session_create. Example: 9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210.
- `live_id` (`string`, required): Live URL ID returned by browserless_live_url_create. Example: lv_3e8d1a6f.

Example input: `{"browser_id":"<browser_id>","live_id":"<live_id>"}`

### `browserless_map`

Map Site URLs · Read-only

Discover the URLs of a website from its sitemap and on-page links, optionally ranked by relevance to a search phrase.
Returns the list of discovered links.
Use this to see what pages a site has before scraping. Use browserless_crawl_create to scrape every page.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): Base URL of the site to map. Example: https://example.com.
- `ignore_query_parameters` (`boolean`, optional): Drop URLs that differ only by query parameters. Defaults to true. Example: true.
- `include_subdomains` (`boolean`, optional): Include URLs on subdomains. Defaults to true. Example: false.
- `limit` (`integer`, optional): Maximum links to return, up to 5000 (the default). Example: 500.
- `search` (`string`, optional): Phrase used to order the URLs by relevance. Example: pricing.
- `sitemap` (`string`, optional): Sitemap handling: include (default) uses the sitemap and page links, only uses just the sitemap, skip ignores it. Example: include. One of: `include`, `only`, `skip`.

Example input: `{"url":"<url>"}`

### `browserless_meta_get`

Get Version Info · Read-only

Get the versions of the Browserless platform and its browsers.
Returns the core API version and browser versions.
Use this to check the connection works.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `browserless_performance`

Run Lighthouse Audit · Read-only

Run a Google Lighthouse audit on a URL in a headless browser.
Returns the Lighthouse report with scores for performance, accessibility, best practices, SEO and PWA, plus audit details.
Use this to check a page's speed and quality.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): URL to audit. Example: https://example.com.
- `block_ads` (`boolean`, optional): Block ads and trackers while the page loads. Example: true.
- `budgets` (`array`, optional): Lighthouse performance budgets. Example: [{"path": "/*", "resourceSizes": [{"resourceType": "script", "budget": 300}]}]
- `config` (`object`, optional): Lighthouse config, for example to run only some categories. Example: {"extends": "lighthouse:default", "settings": {"onlyCategories": ["performance"]}}
- `proxy` (`string`, optional): Route the browser through Browserless's built-in proxy network. residential is best against bot detection; datacenter is cheaper. Uses proxy units on your plan. Example: residential. One of: `residential`, `datacenter`.
- `proxy_country` (`string`, optional): Two-letter country code for the proxy exit, used together with proxy. Example: us.
- `timeout` (`integer`, optional): Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.

Example input: `{"url":"<url>"}`

### `browserless_profile_get`

Get Profile · Read-only

Get the metadata of one saved authentication profile by name.
Returns the profile's name, sites and timestamps; 404 when it does not exist.
Use this to check a profile before using it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `profile_name` (`string`, required): Name of a saved authentication profile, from browserless_profiles_list. Example: github-login.

Example input: `{"profile_name":"<profile_name>"}`

### `browserless_profiles_list`

List Profiles · Read-only

List the saved authentication profiles (captured logins: cookies, localStorage, IndexedDB) for your token.
Returns profile names with their metadata, or an empty array.
Use this to find a profile name for sessions, agent runs and live URLs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Profiles to return, default 100, maximum 1000. Example: 100.
- `offset` (`integer`, optional): Profiles to skip for paging. Defaults to 0. Example: 0.

Example input: `{}`

### `browserless_proxy_cities_list`

List Proxy Cities · Read-only

List the cities available for city-level proxy targeting, grouped by country.
Returns country codes with their city lists.
Use this when choosing a proxy city. City proxying must be enabled on your plan.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `country` (`string`, optional): Only list cities in this two-letter country code. Example: US.

Example input: `{}`

### `browserless_scrape`

Scrape Page Elements · Read-only

Load a page in a headless Chromium browser and extract text, HTML and attributes for a list of CSS selectors.
Returns data: one entry per selector with each matching element's text, html, attributes and position.
Use this when you know the selectors. Use browserless_smart_scrape for whole-page markdown or JSON, browserless_content for raw HTML.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `elements` (`array`, required): CSS selectors to extract. Each object needs selector and can take timeout in milliseconds. Example: [{"selector": "h1"}, {"selector": "a.price", "timeout": 5000}]
- `best_attempt` (`boolean`, optional): Carry on when a wait (navigation, selector, event) fails or times out instead of returning an error. Example: true.
- `block_ads` (`boolean`, optional): Block ads and trackers while the page loads. Example: true.
- `cookies` (`array`, optional): Cookies to set before loading the page. Each needs name, value and a domain or url. Example: [{"name": "session", "value": "abc123", "domain": "example.com"}]
- `extra_http_headers` (`object`, optional): Extra HTTP headers sent with every request the page makes, as name-value pairs. Example: {"Accept-Language": "en-US"}
- `goto_options` (`object`, optional): Navigation options: waitUntil (load, domcontentloaded, networkidle0 or networkidle2), timeout in milliseconds and referer. Example: {"waitUntil": "networkidle2", "timeout": 30000}
- `html` (`string`, optional): Raw HTML to render instead of loading a URL. Send url or html. Example: <html><body><h1>Hello</h1></body></html>.
- `proxy` (`string`, optional): Route the browser through Browserless's built-in proxy network. residential is best against bot detection; datacenter is cheaper. Uses proxy units on your plan. Example: residential. One of: `residential`, `datacenter`.
- `proxy_country` (`string`, optional): Two-letter country code for the proxy exit, used together with proxy. Example: us.
- `reject_resource_types` (`array`, optional): Resource types to block, for example image, media, font or stylesheet, to speed up loading. Example: ["image", "media", "font"]
- `timeout` (`integer`, optional): Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.
- `url` (`string`, optional): Page URL to load (http or https). Send url or html. Example: https://example.com.
- `wait_for_selector` (`object`, optional): Wait for a CSS selector before continuing: selector, plus optional timeout (ms), visible and hidden. Example: {"selector": "#results", "timeout": 10000}
- `wait_for_timeout` (`integer`, optional): Extra milliseconds to wait after the page loads. Example: 1000.

Example input: `{"elements":[{"selector":"h1"},{"selector":"a.price","timeout":5000}]}`

### `browserless_scrapers_list`

List Predefined Scrapers · Read-only

List the predefined scrapers and their APIs (for example Zillow listings or Google search results), with each API's output schema.
Returns the bundle version and the scrapers with their APIs and schemas.
Use this to find scraper and api names for browserless_scraper_run.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `browserless_search`

Search the Web · Read-only

Search the web for a query and optionally scrape each result page into markdown, HTML or links.
Returns results grouped by source (web, news, images) with title, URL and description, plus scraped content when scrape_options is set.
Use this to find pages on a topic. Use browserless_smart_scrape to read a page you already have.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `query` (`string`, required): The search query. Example: best open source vector databases 2026.
- `categories` (`array`, optional): Restrict results to these categories: github, research or pdf. Example: ["research"]
- `country` (`string`, optional): Two-letter country code for geo-targeted results. Example: us.
- `lang` (`string`, optional): Language code for results. Defaults to en. Example: en.
- `limit` (`integer`, optional): Maximum results per source. Defaults to 10 and is capped by your plan. Example: 10.
- `location` (`string`, optional): City or region to narrow results, used with country. Example: San Francisco.
- `scrape_options` (`object`, optional): Set this to scrape every result page: formats (html, links, markdown, screenshot), onlyMainContent, includeTags, excludeTags. Example: {"formats": ["markdown"], "onlyMainContent": true}
- `sources` (`array`, optional): Sources to search: web, news, images. Defaults to web. Example: ["web", "news"]
- `tbs` (`string`, optional): Time filter: day, week, month, year, or Google syntax qdr:d, qdr:w, qdr:m, qdr:y. Example: week. One of: `day`, `week`, `month`, `year`, `qdr:d`, `qdr:w`, `qdr:m`, `qdr:y`.

Example input: `{"query":"<query>"}`

### `browserless_skills_get`

Get Site Skills · Read-only

Get the browser-automation skills Browserless knows for a site: tuned, site-specific recipes an agent can follow.
Returns the skills for the domain, or an empty array.
Use this before automating a well-known site.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `site_domain` (`string`, required): Site domain to look up. Example: linkedin.com.
- `task` (`string`, optional): Narrow the result to one skill slug. Example: search-jobs.

Example input: `{"site_domain":"<site_domain>"}`

### `browserless_smart_scrape`

Smart Scrape Page · Read-only

Scrape any URL with Browserless's cascading strategies (plain HTTP first, then proxies and a full browser when needed) and return LLM-ready content.
Returns the page content in the requested formats (markdown, html, rawText, links, json, screenshot as base64) with the strategy used and metadata.
Use this as the default way to read a page. Use browserless_scrape for exact CSS selectors, browserless_batch_scrape_create for many URLs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): URL to scrape (http or https). Example: https://example.com.
- `actions` (`array`, optional): Up to 20 browser actions to run before capture. Each has a type: wait (milliseconds or selector), click (selector), write (selector and text), scroll, scrape or executeJavascript (script). Example: [{"type": "click", "selector": "#load-more"}, {"type": "wait", "milliseconds": 1000}]
- `exclude_tags` (`array`, optional): CSS selectors to remove from HTML-based outputs. Example: ["nav", "footer"]
- `formats` (`array`, optional): Output formats to return: markdown, html, rawText, links, json, screenshot or pdf (screenshot and pdf come back base64 and force a browser). Example: ["markdown", "links"]
- `headers` (`object`, optional): Custom request headers sent to the target site (auth, cookie and forwarding headers are removed). Example: {"Accept-Language": "en-US"}
- `include_tags` (`array`, optional): CSS selectors to keep in HTML-based outputs. Cannot be combined with exclude_tags or only_main_content. Example: ["article", ".content"]
- `json_options` (`object`, optional): Structured extraction settings, used when formats includes json: a JSON Schema in schema and/or an instruction in prompt. Example: {"prompt": "Extract the product name and price", "schema": {"type": "object", "properties": {"name": {"type": "string"}, "price": {"type": "string"}}}}
- `location` (`object`, optional): Geo-targeting: country as a two-letter code. Forces a proxy exit from that country. Example: {"country": "de"}
- `max_age` (`integer`, optional): Reuse a cached result younger than this many milliseconds (up to 48 hours) and cache this one. 0 disables the cache. Example: 3600000.
- `only_main_content` (`boolean`, optional): Keep only the main article content and drop navigation, headers, footers and sidebars. Defaults to true. Example: true.
- `proxy` (`string`, optional): Proxy network for the scrape. Browserless defaults to residential. Example: residential. One of: `residential`, `datacenter`.
- `wait_for` (`integer`, optional): Milliseconds to wait after load, 0 to 30000. A positive value forces a browser. Example: 2000.

Example input: `{"url":"<url>"}`

### `browserless_unblock`

Unblock Page · Read-only

Load a page that blocks bots, passing CAPTCHAs and bot detection, and return what you ask for.
Returns the page content (HTML), cookies, a base64 screenshot and, when requested, a browserWSEndpoint to reconnect to the unblocked browser.
Use this when browserless_smart_scrape is blocked. Turn off the outputs you don't need to save time.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `url` (`string`, required): URL of the blocked page. Example: https://example.com.
- `best_attempt` (`boolean`, optional): Carry on when a wait (navigation, selector, event) fails or times out instead of returning an error. Example: true.
- `block_ads` (`boolean`, optional): Block ads and trackers while the page loads. Example: true.
- `browser_ws_endpoint` (`boolean`, optional): Keep the browser alive and return a browserWSEndpoint to reconnect with Puppeteer. Defaults to false. Example: false.
- `content` (`boolean`, optional): Return the page HTML. Defaults to true. Example: true.
- `cookies` (`boolean`, optional): Return the site's cookies. Defaults to true. Example: true.
- `goto_options` (`object`, optional): Navigation options: waitUntil (load, domcontentloaded, networkidle0 or networkidle2), timeout in milliseconds and referer. Example: {"waitUntil": "networkidle2", "timeout": 30000}
- `proxy` (`string`, optional): Route the browser through Browserless's built-in proxy network. residential is best against bot detection; datacenter is cheaper. Uses proxy units on your plan. Example: residential. One of: `residential`, `datacenter`.
- `proxy_country` (`string`, optional): Two-letter country code for the proxy exit, used together with proxy. Example: us.
- `screenshot` (`boolean`, optional): Return a full-page screenshot as base64. Defaults to true. Example: false.
- `solve_captchas` (`boolean`, optional): Try to solve CAPTCHAs on the page. Example: true.
- `timeout` (`integer`, optional): Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.
- `ttl` (`integer`, optional): Milliseconds to keep the browser alive for reconnection, up to 30000, when browser_ws_endpoint is true. Example: 30000.
- `wait_for_selector` (`object`, optional): Wait for a CSS selector before continuing: selector, plus optional timeout (ms), visible and hidden. Example: {"selector": "#results", "timeout": 10000}
- `wait_for_timeout` (`integer`, optional): Extra milliseconds to wait after the page loads. Example: 1000.

Example input: `{"url":"<url>"}`

### `browserless_agent_run_create`

Start Agent Run · Write

Start an asynchronous run of Browserless's managed AI agent, which drives a real browser to complete a natural-language task.
Returns the run id and status.
Poll browserless_agent_run_get for the structured result. Use browserless_smart_scrape when you only need a page's content.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `query` (`string`, required): The task for the agent in plain language, at least 10 characters. Example: Find the current price of the Pro plan on https://example.com/pricing.
- `allowed_domains` (`array`, optional): Domains the agent may navigate to. Example: ["example.com"]
- `formats` (`array`, optional): Captures of the final tab to return: html, links, markdown, screenshot. Example: ["markdown"]
- `max_steps` (`integer`, optional): Soft cap on browser actions. Defaults to 60, hard cap 90. Example: 40.
- `on_human_needed` (`string`, optional): What to do when a login or MFA needs a person: fail (default) or pause. Example: fail. One of: `fail`, `pause`.
- `profile` (`string`, optional): Name of a saved authentication profile to start from. Example: github-login.
- `replay` (`boolean`, optional): Record a session replay viewable in the dashboard. Example: false.
- `response_schema` (`object`, optional): JSON Schema the agent's final answer should follow (best effort). Example: {"type": "object", "properties": {"price": {"type": "string"}}}
- `solve_captchas` (`boolean`, optional): Ask the agent to solve CAPTCHAs. Example: true.
- `start_url` (`string`, optional): First URL the agent opens. Example: https://example.com/pricing.
- `stealth` (`boolean`, optional): Ask the agent to use stealth mode against bot detection. Example: true.
- `timeout` (`integer`, optional): Per-turn timeout in milliseconds, 10000 to 900000. Example: 300000.
- `webhook` (`object`, optional): Webhook for terminal states and human handoffs: url plus optional events (succeeded, failed, needs_human). Example: {"url": "https://your-server.com/hooks/agent", "events": ["succeeded", "failed"]}

Example input: `{"query":"<query>"}`

### `browserless_batch_scrape_create`

Start Batch Scrape · Write

Start an asynchronous job that scrapes a list of URLs.
Returns the batch job id and status URL.
Poll browserless_batch_scrape_get for results. Use browserless_smart_scrape for a single URL.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `urls` (`array`, required): Public http or https URLs to scrape. The maximum count depends on your plan. Example: ["https://example.com", "https://example.org"]
- `exclude_tags` (`array`, optional): CSS selectors to remove. Example: ["nav", "footer"]
- `formats` (`array`, optional): Output formats for each page: html, markdown and rawText. Browserless defaults to markdown. Example: ["markdown"]
- `headers` (`object`, optional): Custom HTTP headers for page requests. Example: {"Accept-Language": "en-US"}
- `ignore_invalid_urls` (`boolean`, optional): Skip and report invalid URLs instead of failing the job. Example: true.
- `include_tags` (`array`, optional): CSS selectors to keep. Example: ["article"]
- `only_main_content` (`boolean`, optional): Keep only the main content of each page. Example: true.
- `proxy` (`string`, optional): Proxy network for the job. Example: residential. One of: `residential`, `datacenter`.
- `timeout` (`integer`, optional): Navigation timeout per page in milliseconds. Example: 30000.
- `wait_for` (`integer`, optional): Milliseconds to wait after each page loads. Example: 1000.
- `webhook` (`object`, optional): Webhook for job events: url plus optional events. Example: {"url": "https://your-server.com/hooks/batch"}

Example input: `{"urls":["https://example.com","https://example.org"]}`

### `browserless_bql_run`

Run BrowserQL Query · Write

Run a BrowserQL (GraphQL) query that drives a cloud browser: navigate, click, type, solve CAPTCHAs and extract data in one request.
Returns data with one entry per mutation in the query, or errors.
Use this for scripted browsing without code. Write queries in the BrowserQL editor and paste them here.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `query` (`string`, required): BrowserQL query, for example a mutation that goes to a page and reads text. Example: mutation Example { goto(url: "https://example.com", waitUntil: firstMeaningfulPaint) { status } title { title } }
- `block_consent_modals` (`boolean`, optional): Block cookie consent pop-ups. Example: true.
- `humanlike` (`boolean`, optional): Add human-like mouse movement and typing delays. Example: true.
- `operation_name` (`string`, optional): Which operation to run when the query holds several. Example: Example.
- `proxy` (`string`, optional): Route the browser through Browserless's built-in proxy network. residential is best against bot detection; datacenter is cheaper. Uses proxy units on your plan. Example: residential. One of: `residential`, `datacenter`.
- `proxy_country` (`string`, optional): Two-letter country code for the proxy exit, used together with proxy. Example: us.
- `replay` (`boolean`, optional): Record a session replay you can watch in the Browserless dashboard. Example: false.
- `timeout` (`integer`, optional): Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.
- `variables` (`object`, optional): Values for variables used in the query. Example: {"url": "https://example.com"}

Example input: `{"query":"<query>"}`

### `browserless_crawl_create`

Start Crawl · Write

Start an asynchronous crawl that follows links from a URL and scrapes every page it finds.
Returns the crawl id and a status URL.
Poll browserless_crawl_get for progress and page results. Use browserless_map to list URLs without scraping.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `url` (`string`, required): Root URL to crawl. Example: https://example.com.
- `allow_external_links` (`boolean`, optional): Follow links to other domains. Example: false.
- `allow_subdomains` (`boolean`, optional): Follow links to subdomains of the root URL. Example: true.
- `delay` (`integer`, optional): Milliseconds to wait between requests. Example: 500.
- `exclude_paths` (`array`, optional): Regex patterns for URL paths to skip. Example: ["^/tag/.*"]
- `include_paths` (`array`, optional): Regex patterns; only URL paths that match are crawled. Example: ["^/blog/.*"]
- `limit` (`integer`, optional): Maximum pages to crawl, capped by your plan. Example: 100.
- `max_depth` (`integer`, optional): Maximum link depth from the root URL. Example: 3.
- `max_retries` (`integer`, optional): Retries per failed page. Example: 2.
- `scrape_options` (`object`, optional): How each page is scraped: formats (html, markdown, rawText; default markdown), onlyMainContent, includeTags, excludeTags, waitFor, headers. Example: {"formats": ["markdown"], "onlyMainContent": true}
- `sitemap` (`string`, optional): Sitemap strategy: auto, force or skip. Example: auto. One of: `auto`, `force`, `skip`.
- `webhook` (`object`, optional): Webhook for crawl events: url (HTTPS) and events (completed, failed, page). Example: {"url": "https://your-server.com/hooks/crawl", "events": ["completed"]}

Example input: `{"url":"<url>"}`

### `browserless_function_run`

Run Puppeteer Function · Write

Run your own Puppeteer code in a fresh Browserless browser page and return what it returns.
Returns the function's return value with its content type: JSON for objects, text, or base64-free binary for buffers.
Use this for multi-step automation the other tools can't do. The code must export a default async function ({ page, context }).

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `code` (`string`, required): ES module code whose default export is an async function receiving { page, context } (page is a Puppeteer Page). Return { data, type } or a plain value. Example: export default async function ({ page, context }) { await page.goto(context.url); return { data: { title: await page.title() }, type: 'application/json' }; }
- `block_ads` (`boolean`, optional): Block ads and trackers while the page loads. Example: true.
- `context` (`object`, optional): Values passed to your function as context. Example: {"url": "https://example.com"}
- `proxy` (`string`, optional): Route the browser through Browserless's built-in proxy network. residential is best against bot detection; datacenter is cheaper. Uses proxy units on your plan. Example: residential. One of: `residential`, `datacenter`.
- `proxy_country` (`string`, optional): Two-letter country code for the proxy exit, used together with proxy. Example: us.
- `timeout` (`integer`, optional): Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.

Example input: `{"code":"<code>"}`

### `browserless_live_url_create`

Create Live URL · Write

Create a shareable live URL that streams a running browser so a person can watch it, or act in it when interactable is true (for example to log in or solve MFA).
Returns the live URL and its id.
Use this for human-in-the-loop steps. Check it with browserless_live_url_get and close it with browserless_live_url_close.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `browser_id` (`string`, required): ID of a running browser, for example the session or browser ID returned by browserless_session_create. Example: 9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210.
- `done_label` (`string`, optional): Label of the Done button, at most 40 characters. Example: I'm signed in.
- `instructions` (`string`, optional): Plain-text instructions shown to the viewer. Example: Please log in with your company account, then click Done.
- `instructions_title` (`string`, optional): Title of the instructions card, at most 80 characters. Example: Sign in required.
- `interactable` (`boolean`, optional): Let the viewer click and type. Defaults to false (view only). Example: true.
- `mode` (`string`, optional): tab stays on one tab; follow jumps to new tabs and pop-ups. Example: follow. One of: `follow`, `tab`.
- `resizable` (`boolean`, optional): Let the viewer resize the browser. Example: false.
- `show_timer` (`boolean`, optional): Show a countdown with a warning in the last 60 seconds. Example: true.
- `target_id` (`string`, optional): Tab to show, from browserless_browser_pages_list. Defaults to the focused tab. Example: E3B0C44298FC1C149AFBF4C8996FB924.
- `timeout` (`integer`, optional): Link lifetime in milliseconds, at most 15 minutes and the remaining session time. Example: 600000.

Example input: `{"browser_id":"<browser_id>"}`

### `browserless_profile_rename`

Rename Profile · Write

Rename a saved authentication profile. The new name must be unused.
Returns the updated profile.
Use this to tidy profile names.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, required): New name for the profile. Example: github-login-prod.
- `profile_name` (`string`, required): Name of a saved authentication profile, from browserless_profiles_list. Example: github-login.

Example input: `{"name":"<name>","profile_name":"<profile_name>"}`

### `browserless_scraper_run`

Run Predefined Scraper · Write

Run one API of a predefined scraper and get structured data.
Returns ok with data validated against the API's schema, or ok false with a typed error (blocked, not-found, invalid-input and so on) with HTTP 200.
Use browserless_scrapers_list first to see the scrapers, their APIs and inputs.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `api` (`string`, required): API of that scraper, as listed by browserless_scrapers_list. Example: property.
- `scraper` (`string`, required): Scraper name as listed by browserless_scrapers_list, an organisation slug (not a hostname). Example: zillow.
- `params` (`object`, optional): API-specific parameters; values must be strings, numbers or booleans. Example: {"zpid": "12345"}
- `proxy` (`string`, optional): Route the browser through Browserless's built-in proxy network. residential is best against bot detection; datacenter is cheaper. Uses proxy units on your plan. Example: residential. One of: `residential`, `datacenter`.
- `proxy_country` (`string`, optional): Two-letter country code for the proxy exit, used together with proxy. Example: us.
- `url` (`string`, optional): Target URL, for APIs that take one. Example: https://www.zillow.com/homedetails/12345_zpid/.

Example input: `{"api":"<api>","scraper":"<scraper>"}`

### `browserless_session_create`

Create Browser Session · Write

Create a persistent Browserless browser session with a fixed lifetime that can be reconnected to.
Returns the session id, WebSocket connect URL, BrowserQL URL, stop URL and related links.
Use this to keep a browser alive across steps, for example with browserless_live_url_create. End it with browserless_session_delete.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `ttl` (`integer`, required): Session lifetime in milliseconds; the browser is terminated when it ends. Hosted Cloud treats 0 as your plan's maximum. Example: 300000.
- `block_ads` (`boolean`, optional): Enable ad blocking. Example: true.
- `browser` (`string`, optional): Browser type: chromium (default), chrome, or stealth (Brave with anti-detection). Example: chromium. One of: `chrome`, `chromium`, `stealth`.
- `headless` (`boolean`, optional): Run headless. Defaults to true; ignored in stealth mode. Example: true.
- `label` (`string`, optional): Your own label for the session. Example: checkout-test.
- `process_keep_alive` (`integer`, optional): Milliseconds to keep the browser process alive after a connection closes, so a quick reconnect finds it. Example: 60000.
- `profile` (`string`, optional): Saved authentication profile whose cookies and storage are loaded first. Example: github-login.
- `proxy` (`object`, optional): Proxy settings for the session, for example type and country. Example: {"type": "residential", "country": "us"}
- `replay` (`boolean`, optional): Record the session for replay. Example: false.
- `stealth` (`boolean`, optional): Enable advanced stealth mode. Example: false.
- `url` (`string`, optional): The page you plan to automate. Some sites need special handling, which this enables. Example: https://example.com.

Example input: `{"ttl":300000}`

### `browserless_agent_run_cancel`

Cancel or Delete Agent Run · Destructive

Cancel an active agent run (including one waiting for a human), or delete a finished one.
Returns the result of the cancellation or deletion.
Use this to stop a run or remove its record.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `run_id` (`string`, required): Agent run ID returned by browserless_agent_run_create or browserless_agent_runs_list. Example: ar_5d2e9f1c8b3a.

Example input: `{"run_id":"<run_id>"}`

### `browserless_batch_scrape_cancel`

Cancel Batch Scrape · Destructive

Cancel a batch scrape job. Completed pages stay available; a finished job returns 409.
Returns the cancellation result.
Use this to stop a batch job you no longer need.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `batch_id` (`string`, required): Batch scrape job ID returned by browserless_batch_scrape_create. Example: b_19c4e8a2f760.

Example input: `{"batch_id":"<batch_id>"}`

### `browserless_crawl_cancel`

Cancel Crawl · Destructive

Cancel a running crawl job. Pages already scraped stay available; a finished crawl returns 409.
Returns the cancellation result.
Use this to stop a crawl you no longer need.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `crawl_id` (`string`, required): Crawl job ID returned by browserless_crawl_create or browserless_crawls_list. Example: c_7f3a2b91e4d5.

Example input: `{"crawl_id":"<crawl_id>"}`

### `browserless_live_url_close`

Close Live URL · Destructive

Close an active live URL so it can no longer be viewed. The browser keeps running.
Returns no content (204) on success.
Use this after the person is done or to revoke access.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `browser_id` (`string`, required): ID of a running browser, for example the session or browser ID returned by browserless_session_create. Example: 9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210.
- `live_id` (`string`, required): Live URL ID returned by browserless_live_url_create. Example: lv_3e8d1a6f.

Example input: `{"browser_id":"<browser_id>","live_id":"<live_id>"}`

### `browserless_profile_delete`

Delete Profile · Destructive

Permanently delete a saved authentication profile and its captured state.
Returns the deletion result.
Use browserless_profile_sites_remove instead to drop only some sites.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `profile_name` (`string`, required): Name of a saved authentication profile, from browserless_profiles_list. Example: github-login.

Example input: `{"profile_name":"<profile_name>"}`

### `browserless_profile_sites_remove`

Remove Profile Sites · Destructive

Remove some sites, with their cookies, localStorage and IndexedDB, from a saved profile while keeping the rest.
Returns the updated profile result.
Use this to log a profile out of specific sites. Use browserless_profile_delete to delete the whole profile.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `domains` (`array`, required): Exact sites to remove; subdomains are not included. Example: ["github.com"]
- `name` (`string`, required): Name of the profile to change. Example: github-login.

Example input: `{"domains":["github.com"],"name":"<name>"}`

### `browserless_session_delete`

Delete Browser Session · Destructive

Delete a Browserless session and its data.
Returns the deletion result.
Use this to end a session created by browserless_session_create. Set force to end it even while connections are active.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `session_id` (`string`, required): Session ID returned by browserless_session_create. Example: 9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210.
- `force` (`boolean`, optional): Delete even if the session has active connections, closing them. Example: true.

Example input: `{"session_id":"<session_id>"}`

## Related

Other Developer Tools connectors ([all 200](/agentkit/connectors/?category=developer-tools)):

- [GitHub](/agentkit/connectors/github/): Scalekit connector, OAuth, 217 tools
- [Datadog](/agentkit/connectors/datadog/): Scalekit connector, API key, 105 tools
- [Linear](/agentkit/connectors/linear/): Scalekit connector, OAuth, 64 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
