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.
- Tools
- 36
- What they doRead · write · destructive
- 20 · 9 · 720 read9 write7 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Browserless connection
In AgentKit > Connections, create a Browserless connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 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.actionsconst connector = 'browserless'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'browserless_agent_runs_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_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.actionsconnection_name = "browserless"identifier = "user_123"# Generate an authorization link for the userlink_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 callresult = actions.execute_tool(tool_input={},tool_name="browserless_agent_runs_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Browserless credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbrowserless_agent_run_getGet one agent run: its status, the latest result and step rationales, and the full turn transcript.Read-onlyGet Agent Run
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.
Inputs
run_idstringrequired- Agent run ID returned by browserless_agent_run_create or browserless_agent_runs_list. Example: ar_5d2e9f1c8b3a.
browserless_agent_runs_listList your Browserless agent runs, newest first, with a short preview of each.Read-onlyList Agent Runs
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.
Inputs
cursorstring- Pagination cursor: the nextCursor value from the previous page. Example: eyJpZCI6ImNfN2YzYSJ9.
limitinteger- Maximum runs to return. Example: 20.
statusstring- Only return jobs with this status, for example running, completed, failed or cancelled. Example: completed.
browserless_batch_scrape_getGet the progress of a batch scrape job and a page of its results.Read-onlyGet Batch Scrape
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.
Inputs
batch_idstringrequired- Batch scrape job ID returned by browserless_batch_scrape_create. Example: b_19c4e8a2f760.
skipinteger- Number of page results to skip, for paging through results. Use the next link from the previous response. Example: 0.
browserless_browser_pages_listList the open tabs of a running Browserless browser.Read-onlyList Browser Tabs
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.
Inputs
browser_idstringrequired- ID of a running browser, for example the session or browser ID returned by browserless_session_create. Example: 9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210.
mintboolean- Also create a view-only live URL for each tab. Example: false.
browserless_contentLoad a URL (or raw HTML) in a headless Chromium browser, run its JavaScript and return the fully rendered HTML.Read-onlyGet Rendered HTML
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.
Inputs
best_attemptboolean- Carry on when a wait (navigation, selector, event) fails or times out instead of returning an error. Example: true.
block_adsboolean- Block ads and trackers while the page loads. Example: true.
cookiesarray- 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_headersobject- Extra HTTP headers sent with every request the page makes, as name-value pairs. Example: {"Accept-Language": "en-US"}
goto_optionsobject- Navigation options: waitUntil (load, domcontentloaded, networkidle0 or networkidle2), timeout in milliseconds and referer. Example: {"waitUntil": "networkidle2", "timeout": 30000}
htmlstring- Raw HTML to render instead of loading a URL. Send url or html. Example: <html><body><h1>Hello</h1></body></html>.
proxystring- 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
residentialdatacenter proxy_countrystring- Two-letter country code for the proxy exit, used together with proxy. Example: us.
reject_resource_typesarray- Resource types to block, for example image, media, font or stylesheet, to speed up loading. Example: ["image", "media", "font"]
set_javascript_enabledboolean- Run the page's JavaScript. Defaults to true. Example: true.
timeoutinteger- Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.
urlstring- Page URL to load (http or https). Send url or html. Example: https://example.com.
wait_for_selectorobject- Wait for a CSS selector before continuing: selector, plus optional timeout (ms), visible and hidden. Example: {"selector": "#results", "timeout": 10000}
wait_for_timeoutinteger- Extra milliseconds to wait after the page loads. Example: 1000.
browserless_crawl_getGet the status of one crawl job and a page of its scraped results.Read-onlyGet Crawl
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.
Inputs
crawl_idstringrequired- Crawl job ID returned by browserless_crawl_create or browserless_crawls_list. Example: c_7f3a2b91e4d5.
skipinteger- Number of page results to skip, for paging through results. Use the next link from the previous response. Example: 0.
browserless_crawls_listList the crawl jobs in your Browserless account, newest first.Read-onlyList Crawls
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.
Inputs
cursorstring- Pagination cursor: the nextCursor value from the previous page. Example: eyJpZCI6ImNfN2YzYSJ9.
limitinteger- Maximum crawls to return. Example: 20.
statusstring- Only return jobs with this status, for example running, completed, failed or cancelled. Example: completed.
browserless_live_url_getGet the status of a live URL and, once finished, how it ended (for example the viewer clicked Done).Read-onlyGet Live URL Status
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.
Inputs
browser_idstringrequired- ID of a running browser, for example the session or browser ID returned by browserless_session_create. Example: 9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210.
live_idstringrequired- Live URL ID returned by browserless_live_url_create. Example: lv_3e8d1a6f.
browserless_mapDiscover the URLs of a website from its sitemap and on-page links, optionally ranked by relevance to a search phrase.Read-onlyMap Site URLs
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.
Inputs
urlstringrequired- Base URL of the site to map. Example: https://example.com.
ignore_query_parametersboolean- Drop URLs that differ only by query parameters. Defaults to true. Example: true.
include_subdomainsboolean- Include URLs on subdomains. Defaults to true. Example: false.
limitinteger- Maximum links to return, up to 5000 (the default). Example: 500.
searchstring- Phrase used to order the URLs by relevance. Example: pricing.
sitemapstring- Sitemap handling: include (default) uses the sitemap and page links, only uses just the sitemap, skip ignores it. Example: include.one of
includeonlyskip
browserless_meta_getGet the versions of the Browserless platform and its browsers.Read-onlyGet Version Info
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.
Inputs
This tool takes no inputs.
browserless_performanceRun a Google Lighthouse audit on a URL in a headless browser.Read-onlyRun Lighthouse Audit
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.
Inputs
urlstringrequired- URL to audit. Example: https://example.com.
block_adsboolean- Block ads and trackers while the page loads. Example: true.
budgetsarray- Lighthouse performance budgets. Example: [{"path": "/*", "resourceSizes": [{"resourceType": "script", "budget": 300}]}]
configobject- Lighthouse config, for example to run only some categories. Example: {"extends": "lighthouse:default", "settings": {"onlyCategories": ["performance"]}}
proxystring- 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
residentialdatacenter proxy_countrystring- Two-letter country code for the proxy exit, used together with proxy. Example: us.
timeoutinteger- Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.
browserless_profile_getGet the metadata of one saved authentication profile by name.Read-onlyGet Profile
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.
Inputs
profile_namestringrequired- Name of a saved authentication profile, from browserless_profiles_list. Example: github-login.
browserless_profiles_listList the saved authentication profiles (captured logins: cookies, localStorage, IndexedDB) for your token.Read-onlyList Profiles
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.
Inputs
limitinteger- Profiles to return, default 100, maximum 1000. Example: 100.
offsetinteger- Profiles to skip for paging. Defaults to 0. Example: 0.
browserless_proxy_cities_listList the cities available for city-level proxy targeting, grouped by country.Read-onlyList Proxy Cities
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.
Inputs
countrystring- Only list cities in this two-letter country code. Example: US.
browserless_scrapeLoad a page in a headless Chromium browser and extract text, HTML and attributes for a list of CSS selectors.Read-onlyScrape Page Elements
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.
Inputs
elementsarrayrequired- CSS selectors to extract. Each object needs selector and can take timeout in milliseconds. Example: [{"selector": "h1"}, {"selector": "a.price", "timeout": 5000}]
best_attemptboolean- Carry on when a wait (navigation, selector, event) fails or times out instead of returning an error. Example: true.
block_adsboolean- Block ads and trackers while the page loads. Example: true.
cookiesarray- 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_headersobject- Extra HTTP headers sent with every request the page makes, as name-value pairs. Example: {"Accept-Language": "en-US"}
goto_optionsobject- Navigation options: waitUntil (load, domcontentloaded, networkidle0 or networkidle2), timeout in milliseconds and referer. Example: {"waitUntil": "networkidle2", "timeout": 30000}
htmlstring- Raw HTML to render instead of loading a URL. Send url or html. Example: <html><body><h1>Hello</h1></body></html>.
proxystring- 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
residentialdatacenter proxy_countrystring- Two-letter country code for the proxy exit, used together with proxy. Example: us.
reject_resource_typesarray- Resource types to block, for example image, media, font or stylesheet, to speed up loading. Example: ["image", "media", "font"]
timeoutinteger- Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.
urlstring- Page URL to load (http or https). Send url or html. Example: https://example.com.
wait_for_selectorobject- Wait for a CSS selector before continuing: selector, plus optional timeout (ms), visible and hidden. Example: {"selector": "#results", "timeout": 10000}
wait_for_timeoutinteger- Extra milliseconds to wait after the page loads. Example: 1000.
browserless_scrapers_listList the predefined scrapers and their APIs (for example Zillow listings or Google search results), with each API's output schema.Read-onlyList Predefined Scrapers
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.
Inputs
This tool takes no inputs.
browserless_searchSearch the web for a query and optionally scrape each result page into markdown, HTML or links.Read-onlySearch the Web
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.
Inputs
querystringrequired- The search query. Example: best open source vector databases 2026.
categoriesarray- Restrict results to these categories: github, research or pdf. Example: ["research"]
countrystring- Two-letter country code for geo-targeted results. Example: us.
langstring- Language code for results. Defaults to en. Example: en.
limitinteger- Maximum results per source. Defaults to 10 and is capped by your plan. Example: 10.
locationstring- City or region to narrow results, used with country. Example: San Francisco.
scrape_optionsobject- Set this to scrape every result page: formats (html, links, markdown, screenshot), onlyMainContent, includeTags, excludeTags. Example: {"formats": ["markdown"], "onlyMainContent": true}
sourcesarray- Sources to search: web, news, images. Defaults to web. Example: ["web", "news"]
tbsstring- Time filter: day, week, month, year, or Google syntax qdr:d, qdr:w, qdr:m, qdr:y. Example: week.one of
dayweekmonthyearqdr:dqdr:wqdr:mqdr:y
browserless_skills_getGet the browser-automation skills Browserless knows for a site: tuned, site-specific recipes an agent can follow.Read-onlyGet Site Skills
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.
Inputs
site_domainstringrequired- Site domain to look up. Example: linkedin.com.
taskstring- Narrow the result to one skill slug. Example: search-jobs.
browserless_smart_scrapeScrape any URL with Browserless's cascading strategies (plain HTTP first, then proxies and a full browser when needed) and return LLM-ready content.Read-onlySmart Scrape Page
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.
Inputs
urlstringrequired- URL to scrape (http or https). Example: https://example.com.
actionsarray- 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_tagsarray- CSS selectors to remove from HTML-based outputs. Example: ["nav", "footer"]
formatsarray- 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"]
headersobject- Custom request headers sent to the target site (auth, cookie and forwarding headers are removed). Example: {"Accept-Language": "en-US"}
include_tagsarray- CSS selectors to keep in HTML-based outputs. Cannot be combined with exclude_tags or only_main_content. Example: ["article", ".content"]
json_optionsobject- 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"}}}}
locationobject- Geo-targeting: country as a two-letter code. Forces a proxy exit from that country. Example: {"country": "de"}
max_ageinteger- 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_contentboolean- Keep only the main article content and drop navigation, headers, footers and sidebars. Defaults to true. Example: true.
proxystring- Proxy network for the scrape. Browserless defaults to residential. Example: residential.one of
residentialdatacenter wait_forinteger- Milliseconds to wait after load, 0 to 30000. A positive value forces a browser. Example: 2000.
browserless_unblockLoad a page that blocks bots, passing CAPTCHAs and bot detection, and return what you ask for.Read-onlyUnblock Page
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.
Inputs
urlstringrequired- URL of the blocked page. Example: https://example.com.
best_attemptboolean- Carry on when a wait (navigation, selector, event) fails or times out instead of returning an error. Example: true.
block_adsboolean- Block ads and trackers while the page loads. Example: true.
browser_ws_endpointboolean- Keep the browser alive and return a browserWSEndpoint to reconnect with Puppeteer. Defaults to false. Example: false.
contentboolean- Return the page HTML. Defaults to true. Example: true.
cookiesboolean- Return the site's cookies. Defaults to true. Example: true.
goto_optionsobject- Navigation options: waitUntil (load, domcontentloaded, networkidle0 or networkidle2), timeout in milliseconds and referer. Example: {"waitUntil": "networkidle2", "timeout": 30000}
proxystring- 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
residentialdatacenter proxy_countrystring- Two-letter country code for the proxy exit, used together with proxy. Example: us.
screenshotboolean- Return a full-page screenshot as base64. Defaults to true. Example: false.
solve_captchasboolean- Try to solve CAPTCHAs on the page. Example: true.
timeoutinteger- Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.
ttlinteger- Milliseconds to keep the browser alive for reconnection, up to 30000, when browser_ws_endpoint is true. Example: 30000.
wait_for_selectorobject- Wait for a CSS selector before continuing: selector, plus optional timeout (ms), visible and hidden. Example: {"selector": "#results", "timeout": 10000}
wait_for_timeoutinteger- Extra milliseconds to wait after the page loads. Example: 1000.
browserless_agent_run_createStart an asynchronous run of Browserless's managed AI agent, which drives a real browser to complete a natural-language task.WriteStart Agent Run
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.
Inputs
querystringrequired- 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_domainsarray- Domains the agent may navigate to. Example: ["example.com"]
formatsarray- Captures of the final tab to return: html, links, markdown, screenshot. Example: ["markdown"]
max_stepsinteger- Soft cap on browser actions. Defaults to 60, hard cap 90. Example: 40.
on_human_neededstring- What to do when a login or MFA needs a person: fail (default) or pause. Example: fail.one of
failpause profilestring- Name of a saved authentication profile to start from. Example: github-login.
replayboolean- Record a session replay viewable in the dashboard. Example: false.
response_schemaobject- JSON Schema the agent's final answer should follow (best effort). Example: {"type": "object", "properties": {"price": {"type": "string"}}}
solve_captchasboolean- Ask the agent to solve CAPTCHAs. Example: true.
start_urlstring- First URL the agent opens. Example: https://example.com/pricing.
stealthboolean- Ask the agent to use stealth mode against bot detection. Example: true.
timeoutinteger- Per-turn timeout in milliseconds, 10000 to 900000. Example: 300000.
webhookobject- 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"]}
browserless_batch_scrape_createStart an asynchronous job that scrapes a list of URLs.WriteStart Batch Scrape
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.
Inputs
urlsarrayrequired- Public http or https URLs to scrape. The maximum count depends on your plan. Example: ["https://example.com", "https://example.org"]
exclude_tagsarray- CSS selectors to remove. Example: ["nav", "footer"]
formatsarray- Output formats for each page: html, markdown and rawText. Browserless defaults to markdown. Example: ["markdown"]
headersobject- Custom HTTP headers for page requests. Example: {"Accept-Language": "en-US"}
ignore_invalid_urlsboolean- Skip and report invalid URLs instead of failing the job. Example: true.
include_tagsarray- CSS selectors to keep. Example: ["article"]
only_main_contentboolean- Keep only the main content of each page. Example: true.
proxystring- Proxy network for the job. Example: residential.one of
residentialdatacenter timeoutinteger- Navigation timeout per page in milliseconds. Example: 30000.
wait_forinteger- Milliseconds to wait after each page loads. Example: 1000.
webhookobject- Webhook for job events: url plus optional events. Example: {"url": "https://your-server.com/hooks/batch"}
browserless_bql_runRun a BrowserQL (GraphQL) query that drives a cloud browser: navigate, click, type, solve CAPTCHAs and extract data in one request.WriteRun BrowserQL Query
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.
Inputs
querystringrequired- 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_modalsboolean- Block cookie consent pop-ups. Example: true.
humanlikeboolean- Add human-like mouse movement and typing delays. Example: true.
operation_namestring- Which operation to run when the query holds several. Example: Example.
proxystring- 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
residentialdatacenter proxy_countrystring- Two-letter country code for the proxy exit, used together with proxy. Example: us.
replayboolean- Record a session replay you can watch in the Browserless dashboard. Example: false.
timeoutinteger- Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.
variablesobject- Values for variables used in the query. Example: {"url": "https://example.com"}
browserless_crawl_createStart an asynchronous crawl that follows links from a URL and scrapes every page it finds.WriteStart Crawl
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.
Inputs
urlstringrequired- Root URL to crawl. Example: https://example.com.
allow_external_linksboolean- Follow links to other domains. Example: false.
allow_subdomainsboolean- Follow links to subdomains of the root URL. Example: true.
delayinteger- Milliseconds to wait between requests. Example: 500.
exclude_pathsarray- Regex patterns for URL paths to skip. Example: ["^/tag/.*"]
include_pathsarray- Regex patterns; only URL paths that match are crawled. Example: ["^/blog/.*"]
limitinteger- Maximum pages to crawl, capped by your plan. Example: 100.
max_depthinteger- Maximum link depth from the root URL. Example: 3.
max_retriesinteger- Retries per failed page. Example: 2.
scrape_optionsobject- How each page is scraped: formats (html, markdown, rawText; default markdown), onlyMainContent, includeTags, excludeTags, waitFor, headers. Example: {"formats": ["markdown"], "onlyMainContent": true}
sitemapstring- Sitemap strategy: auto, force or skip. Example: auto.one of
autoforceskip webhookobject- Webhook for crawl events: url (HTTPS) and events (completed, failed, page). Example: {"url": "https://your-server.com/hooks/crawl", "events": ["completed"]}
browserless_function_runRun your own Puppeteer code in a fresh Browserless browser page and return what it returns.WriteRun Puppeteer Function
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 }).
Inputs
codestringrequired- 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_adsboolean- Block ads and trackers while the page loads. Example: true.
contextobject- Values passed to your function as context. Example: {"url": "https://example.com"}
proxystring- 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
residentialdatacenter proxy_countrystring- Two-letter country code for the proxy exit, used together with proxy. Example: us.
timeoutinteger- Overall request timeout in milliseconds. Defaults to your plan's limit. Example: 60000.
browserless_live_url_createCreate 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).WriteCreate Live URL
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.
Inputs
browser_idstringrequired- ID of a running browser, for example the session or browser ID returned by browserless_session_create. Example: 9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210.
done_labelstring- Label of the Done button, at most 40 characters. Example: I'm signed in.
instructionsstring- Plain-text instructions shown to the viewer. Example: Please log in with your company account, then click Done.
instructions_titlestring- Title of the instructions card, at most 80 characters. Example: Sign in required.
interactableboolean- Let the viewer click and type. Defaults to false (view only). Example: true.
modestring- tab stays on one tab; follow jumps to new tabs and pop-ups. Example: follow.one of
followtab resizableboolean- Let the viewer resize the browser. Example: false.
show_timerboolean- Show a countdown with a warning in the last 60 seconds. Example: true.
target_idstring- Tab to show, from browserless_browser_pages_list. Defaults to the focused tab. Example: E3B0C44298FC1C149AFBF4C8996FB924.
timeoutinteger- Link lifetime in milliseconds, at most 15 minutes and the remaining session time. Example: 600000.
browserless_profile_renameRename a saved authentication profile.WriteRename Profile
Rename a saved authentication profile. The new name must be unused. Returns the updated profile. Use this to tidy profile names.
- Idempotent
Inputs
namestringrequired- New name for the profile. Example: github-login-prod.
profile_namestringrequired- Name of a saved authentication profile, from browserless_profiles_list. Example: github-login.
browserless_scraper_runRun one API of a predefined scraper and get structured data.WriteRun Predefined Scraper
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.
Inputs
apistringrequired- API of that scraper, as listed by browserless_scrapers_list. Example: property.
scraperstringrequired- Scraper name as listed by browserless_scrapers_list, an organisation slug (not a hostname). Example: zillow.
paramsobject- API-specific parameters; values must be strings, numbers or booleans. Example: {"zpid": "12345"}
proxystring- 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
residentialdatacenter proxy_countrystring- Two-letter country code for the proxy exit, used together with proxy. Example: us.
urlstring- Target URL, for APIs that take one. Example: https://www.zillow.com/homedetails/12345_zpid/.
browserless_session_createCreate a persistent Browserless browser session with a fixed lifetime that can be reconnected to.WriteCreate Browser Session
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.
Inputs
ttlintegerrequired- Session lifetime in milliseconds; the browser is terminated when it ends. Hosted Cloud treats 0 as your plan's maximum. Example: 300000.
block_adsboolean- Enable ad blocking. Example: true.
browserstring- Browser type: chromium (default), chrome, or stealth (Brave with anti-detection). Example: chromium.one of
chromechromiumstealth headlessboolean- Run headless. Defaults to true; ignored in stealth mode. Example: true.
labelstring- Your own label for the session. Example: checkout-test.
process_keep_aliveinteger- Milliseconds to keep the browser process alive after a connection closes, so a quick reconnect finds it. Example: 60000.
profilestring- Saved authentication profile whose cookies and storage are loaded first. Example: github-login.
proxyobject- Proxy settings for the session, for example type and country. Example: {"type": "residential", "country": "us"}
replayboolean- Record the session for replay. Example: false.
stealthboolean- Enable advanced stealth mode. Example: false.
urlstring- The page you plan to automate. Some sites need special handling, which this enables. Example: https://example.com.
browserless_agent_run_cancelCancel an active agent run (including one waiting for a human), or delete a finished one.DestructiveCancel or Delete Agent Run
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.
- Idempotent
Inputs
run_idstringrequired- Agent run ID returned by browserless_agent_run_create or browserless_agent_runs_list. Example: ar_5d2e9f1c8b3a.
browserless_batch_scrape_cancelCancel a batch scrape job.DestructiveCancel Batch Scrape
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.
- Idempotent
Inputs
batch_idstringrequired- Batch scrape job ID returned by browserless_batch_scrape_create. Example: b_19c4e8a2f760.
browserless_crawl_cancelCancel a running crawl job.DestructiveCancel Crawl
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.
- Idempotent
Inputs
crawl_idstringrequired- Crawl job ID returned by browserless_crawl_create or browserless_crawls_list. Example: c_7f3a2b91e4d5.
browserless_live_url_closeClose an active live URL so it can no longer be viewed.DestructiveClose Live URL
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.
- Idempotent
Inputs
browser_idstringrequired- ID of a running browser, for example the session or browser ID returned by browserless_session_create. Example: 9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210.
live_idstringrequired- Live URL ID returned by browserless_live_url_create. Example: lv_3e8d1a6f.
browserless_profile_deletePermanently delete a saved authentication profile and its captured state.DestructiveDelete Profile
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.
- Idempotent
Inputs
profile_namestringrequired- Name of a saved authentication profile, from browserless_profiles_list. Example: github-login.
browserless_profile_sites_removeRemove some sites, with their cookies, localStorage and IndexedDB, from a saved profile while keeping the rest.DestructiveRemove Profile Sites
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.
- Idempotent
Inputs
domainsarrayrequired- Exact sites to remove; subdomains are not included. Example: ["github.com"]
namestringrequired- Name of the profile to change. Example: github-login.
browserless_session_deleteDelete a Browserless session and its data.DestructiveDelete Browser Session
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.
- Idempotent
Inputs
session_idstringrequired- Session ID returned by browserless_session_create. Example: 9a8b7c6d-5e4f-3a2b-1c0d-ef9876543210.
forceboolean- Delete even if the session has active connections, closing them. Example: true.
No tools match.