Skip to docs navigation

Browserless integration guide

Verified

How to connect Browserless to WEXTL and use its 39 actions in your workflows. About Browserless: Render pages to PDFs and screenshots, scrape sites and run crawls in cloud browsers.

  • 15 searches
  • 24 actions
  • Polling
  • Auth: API key

AI-assisted documentation12 min read

This documentation is compiled from our integration source code, internal specs for Browserless, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Browserless on WEXTL →
  • Browserless
  • WEXTL
  • Currents
  • Cortex
  • Adafruit
  • Azure Storage
  • Clerk
  • AssemblyAI
  • Cockpit
  • AWS Lambda
  • Bunny.net
  • Cloudflare
  • AWS Cognito
  • 0CodeKit
  • API Verve
  • Agenty
  • Better Stack
  • Apify
  • Bright Data
  • Crowdin
  • Browse AI
  • CloudConvert
  • BugBug
  • AWS S3
  • CircleCI
  • Alchemy
  • Buildkite
  • Contentful
  • Bitbucket
  • Bitwarden
  • Box
  • API TokenpasswordRequired

    In the account dashboard, open API Keys and copy the API token.[1]

  • RegionselectRequired

    The region your account uses.[1]

  • Custom Hosttext

    Only for a private Browserless deployment. Host name only: no https://, no path, no trailing slash. It must be reachable over https. Leave blank to use the Region.[1]

  1. Log in to your WEXTL account, add the Browserless node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Browserless account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Get a Batch Scrape

SearchProgress and output of one batch.
Input fields[3]
FieldType
Batch IDRequired
text
Skipnumber
Output fields[3]
FieldType
Statustext
Total Pagesnumber
Completed Pagesnumber
Failed Pagesnumber
Expiresdate
Next Page URLtext
Pagesarray
Statustext
Content URLtext
Metadatatext

Get a Crawl

SearchProgress and pages collected by one crawl.
Input fields[3]
FieldType
CrawlRequired
choice
Skipnumber
Output fields[3]
FieldType
Statustext
Total Pagesnumber
Completed Pagesnumber
Failed Pagesnumber
Expiresdate
Next Page URLtext
Pagesarray
Statustext
Content URLtext
Metadatatext

Get a Profile

SearchDetails of a saved profile.
Input fields[3]
FieldType
ProfileRequired
choice
Output fields[3]
FieldType
Profile IDtext
Nametext
Cookiesnumber
Originsnumber
Domain Autharray
Last Useddate
Createddate
Updateddate

Get a Profile State

SearchSession cookies and storage of a profile.
Input fields[3]
FieldType
ProfileRequired
choice
Output fields[3]
FieldType
Cookiesarray
Originsarray

Get an Agent Run

SearchProgress and outcome of an agent run.
Input fields[3]
FieldType
Agent RunRequired
choice
Max Response Size (bytes)number
Output fields[3]
FieldType
Run IDtext
Statustext
Human Requesttext
Resulttext
Errortext
Stepsarray
Actionsarray
HTMLtext
Markdowntext
Linksarray
Screenshot (Base64)text
Createddate
Completeddate
Expiresdate

Get Page Content

SearchRendered HTML of a URL.
Input fields[3]
FieldType
Page URLtext
HTMLtext
Wait for Selectortext
Wait (ms)number
Wait Untilchoice
Cookiesarray
Cookieobject
Extra Headersarray
Headerobject
HTTP Auth Usernametext
HTTP Auth Passwordsecret
Viewport Widthnumber
Viewport Heightnumber
Block Adsboolean
Block Cookie Bannersboolean
Best Attemptboolean
Proxychoice
Proxy Countrytext
Profilechoice
Timeout (ms)number
Max Response Size (bytes)number
Output fields[3]
FieldType
HTMLtext
Content Typetext

Get the Service Info

SearchBrowserless and browser version numbers.
Output fields[3]
FieldType
Versiontext
Chromiumtext
WebKittext
Firefoxtext
Playwrightarray
Puppeteerarray

List Agent Runs

SearchAI agent runs and their state.
Input fields[3]
FieldType
Statuschoice
Limitnumber
Output fields[3]
FieldType
Run IDtext
Statustext
Previewtext
Createddate

List Crawls

SearchWebsite crawls and their progress.
Input fields[3]
FieldType
Statuschoice
Limitnumber
Output fields[3]
FieldType
Crawl IDtext
URLtext
Statustext
Total Pagesnumber
Completed Pagesnumber
Createddate
Completeddate

List Profiles

SearchYour stored browser profiles.
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Profile IDtext
Nametext
Cookiesnumber
Originsnumber
Domain Autharray
Last Useddate
Createddate
Updateddate

List Proxy Cities

SearchPlaces offering city-level proxy routing.
Input fields[3]
FieldType
Countrytext
Output fields[3]
FieldType
Countriesarray
Total Countriesnumber
Total Citiesnumber

List Scrapers

SearchCatalogue of built-in scrapers.
Output fields[3]
FieldType
Versiontext
Scraperstext

List Site Skills

SearchSkills recorded for a website.
Input fields[3]
FieldType
DomainRequired
text
Tasktext
Output fields[3]
FieldType
IDtext
Domaintext
Tasktext
Titletext
Skill (Markdown)text
Versionnumber
Createddate
Updateddate

List Website URLs

SearchPage addresses found on a website.
Input fields[3]
FieldType
Site URLRequired
text
Searchtext
Limitnumber
Sitemapchoice
Include Subdomainsboolean
Ignore Query Parametersboolean
Proxychoice
Proxy Countrytext
Output fields[3]
FieldType
URLsarray
Countnumber

Search the Web

SearchSearch hits for one query.
Input fields[3]
FieldType
QueryRequired
text
Limitnumber
Sourceschoice
Categorieschoice
Countrytext
Languagetext
Locationtext
Time Rangechoice
Proxychoice
Scrape Results Aschoice
Output fields[3]
FieldType
Datatext
Web Resultsarray
News Resultsarray
Image Resultsarray
Total Resultsnumber

Audit Page Performance

ActionLighthouse scores for one web page.
Input fields[3]
FieldType
Page URLRequired
text
Categorieschoice
Budgetstext
Block Adsboolean
Proxychoice
Proxy Countrytext
Profilechoice
Timeout (ms)number
Max Response Size (bytes)number
Output fields[3]
FieldType
Lighthouse Reporttext

Cancel a Batch Scrape

ActionHalts a running multi-URL scrape.
Input fields[3]
FieldType
Batch IDRequired
text
Output fields[3]
FieldType
Batch IDtext
Cancelledboolean

Cancel a Crawl

ActionEnds a running site crawl.
Input fields[3]
FieldType
CrawlRequired
choice
Output fields[3]
FieldType
Crawl IDtext
Cancelledboolean

Cancel an Agent Run

ActionEnds or removes one AI browser agent run.
Input fields[3]
FieldType
Agent RunRequired
choice
Output fields[3]
FieldType
Run IDtext
Cancelledboolean

Create a PDF

ActionPDF file from a live page or raw markup.
Input fields[3]
FieldType
Page URLtext
HTMLtext
Paper Formatchoice
Landscapeboolean
Print Backgroundboolean
Scalenumber
Margin Toptext
Margin Righttext
Margin Bottomtext
Margin Lefttext
Page Rangestext
Show Header and Footerboolean
Header Templatetext
Footer Templatetext
File Nametext
Wait for Selectortext
Wait (ms)number
Wait Untilchoice
Cookiesarray
Cookieobject
Extra Headersarray
Headerobject

11other input fields

Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Create a Session

ActionLong-lived cloud browser with its own session ID.
Input fields[3]
FieldType
Time to Live (ms)Required
number
Browserchoice
Stealthboolean
Block Adsboolean
Headlessboolean
Record Replayboolean
Start URLtext
Labeltext
Profilechoice
Proxychoice
Proxy Countrytext
Proxy Citytext
Proxy Statetext
Sticky Proxyboolean
Output fields[3]
FieldType
Session IDtext
Time to Live (ms)number
Cloud Endpoint IDtext

Delete a Profile

ActionDeletes one saved browser profile.
Input fields[3]
FieldType
ProfileRequired
choice
Output fields[3]
FieldType
Nametext
Deletedboolean

Delete a Session

ActionCloses one persistent browser session.
Input fields[3]
FieldType
Session IDRequired
text
Forceboolean
Output fields[3]
FieldType
Session IDtext
Deletedboolean

Download Files

ActionFetches a file by scripting a browser click.
Input fields[3]
FieldType
CodeRequired
text
Contexttext
Block Adsboolean
Proxychoice
Proxy Countrytext
Profilechoice
Timeout (ms)number
Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Export a Page

ActionPage saved as a file or archive.
Input fields[3]
FieldType
Page URLRequired
text
Extra Headersarray
Headerobject
Include Resourcesboolean
Proxychoice
Proxy Countrytext
Profilechoice
Timeout (ms)number
File Nametext
Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Make an API Call

universalDirect Browserless REST API access for uncovered endpoints.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headerstext
Status Codenumber

Run a BrowserQL Query

ActionBrowserQL result from a cloud browser.
Input fields[3]
FieldType
QueryRequired
text
Variablestext
Operation Nametext
Stealth Routeboolean
Block Adsboolean
Proxychoice
Proxy Countrytext
Profilechoice
Timeout (ms)number
Output fields[3]
FieldType
Datatext
Errorsarray

Run a Function

ActionPuppeteer script output from the cloud.
Input fields[3]
FieldType
CodeRequired
text
Contexttext
Block Adsboolean
Proxychoice
Proxy Countrytext
Profilechoice
Timeout (ms)number
Max Response Size (bytes)number
Output fields[3]
FieldType
Resulttext
Content Typetext

Run a Scraper

ActionBuilt-in scraper output.
Input fields[3]
FieldType
ScraperRequired
text
APIRequired
text
Page URLtext
Parametersarray
Parameterobject
Output fields[3]
FieldType
OKboolean
Datatext

Scrape a Page

ActionPage content in the formats requested.
Input fields[3]
FieldType
Page URLRequired
text
Formatschoice
Only Main Contentboolean
JSON Optionstext
Include Tagsarray
Exclude Tagsarray
Proxychoice
Proxy Countrytext
Cache Max Age (ms)number
Timeout (ms)number
Max Response Size (bytes)number
Output fields[3]
FieldType
OKboolean
Status Codenumber
HTMLtext
Markdowntext
Raw Texttext
Linksarray
Screenshot (Base64)text
PDF (Base64)text
JSONtext
Summarytext
Metadatatext
Strategytext

Scrape Page Elements

ActionData extracted from chosen selectors.
Input fields[3]
FieldType
ElementsRequired
array
Elementobject
Page URLtext
HTMLtext
Wait for Selectortext
Wait (ms)number
Wait Untilchoice
Cookiesarray
Cookieobject
Extra Headersarray
Headerobject
HTTP Auth Usernametext
HTTP Auth Passwordsecret
Viewport Widthnumber
Viewport Heightnumber
Block Adsboolean
Block Cookie Bannersboolean
Best Attemptboolean
Proxychoice
Proxy Countrytext
Profilechoice
Timeout (ms)number
Output fields[3]
FieldType
Elementsarray
Selectortext
Resultsarray

Start a Batch Scrape

ActionAsynchronous scrape of a URL list.
Input fields[3]
FieldType
URLsRequired
array
Skip Invalid URLsboolean
Formatschoice
Only Main Contentboolean
Include Tagsarray
Exclude Tagsarray
Wait (ms)number
Page Timeout (ms)number
Proxychoice
Webhook URLtext
Profilechoice
Output fields[3]
FieldType
Batch IDtext
Status URLtext
Invalid URLsarray
Successboolean

Start a Crawl

ActionAsynchronous crawl of one website.
Input fields[3]
FieldType
Start URLRequired
text
Page Limitnumber
Max Depthnumber
Max Retriesnumber
Follow External Linksboolean
Follow Subdomainsboolean
Sitemapchoice
Include Pathsarray
Exclude Pathsarray
Delay (ms)number
Formatschoice
Only Main Contentboolean
Wait (ms)number
Webhook URLtext
Profilechoice
Output fields[3]
FieldType
Crawl IDtext
Status URLtext
Successboolean

Start an Agent Run

ActionKicks off an autonomous browsing task.
Input fields[3]
FieldType
TaskRequired
text
Start URLtext
Max Stepsnumber
Timeout (ms)number
When a Person Is Neededchoice
Response Schematext
Allowed Domainsarray
Proxychoice
Proxy Countrytext
Stealthboolean
Solve Captchasboolean
Record Replayboolean
Profilechoice
Capturechoice
Webhook URLtext
Output fields[3]
FieldType
Run IDtext
Statustext

Take a Screenshot

ActionImage of a page or a single element.
Input fields[3]
FieldType
Page URLtext
HTMLtext
Selectortext
Full Pageboolean
Image Typechoice
Qualitynumber
Transparent Backgroundboolean
Scroll Page Firstboolean
File Nametext
Wait for Selectortext
Wait (ms)number
Wait Untilchoice
Cookiesarray
Cookieobject
Extra Headersarray
Headerobject
HTTP Auth Usernametext
HTTP Auth Passwordsecret
Viewport Widthnumber
Viewport Heightnumber
Block Adsboolean
Block Cookie Bannersboolean

5other input fields

Output fields[3]
FieldType
Filefile
File Nametext
Size (Bytes)number
Content Typetext

Unblock a Page

ActionContent of a bot-protected page.
Input fields[3]
FieldType
Page URLRequired
text
Return Contentboolean
Return Screenshotboolean
Return Cookiesboolean
Keep Browser Openboolean
Keep-Alive Time (ms)number
Proxychoice
Proxy Countrytext
Timeout (ms)number
Max Response Size (bytes)number
Output fields[3]
FieldType
HTMLtext
Cookiesarray
Screenshot (Base64)text
Browser Endpointtext
Keep-Alive (ms)number
Captcha Solvedboolean

Update a Profile Name

ActionRenames a saved profile.
Input fields[3]
FieldType
ProfileRequired
choice
New NameRequired
text
Output fields[3]
FieldType
Profile IDtext
Nametext
Cookiesnumber
Originsnumber
Domain Autharray
Last Useddate
Createddate
Updateddate

Update a Profile State

ActionOverwrites saved cookies and storage.
Input fields[3]
FieldType
ProfileRequired
choice
StateRequired
text
Output fields[3]
FieldType
Profile IDtext
Nametext
Cookiesnumber
Originsnumber
Domain Autharray
Last Useddate
Createddate
Updateddate
Diagnosticstext

Upload a Profile

ActionNew profile built from exported state.
Input fields[3]
FieldType
NameRequired
text
StateRequired
text
Output fields[3]
FieldType
Profile IDtext
Nametext
Cookiesnumber
Originsnumber
Domain Autharray
Last Useddate
Createddate
Updateddate
Diagnosticstext

Look for Browserless templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Browserless Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Browserless.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 14, 2026 14:55

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.