Can I use Browserless as a CLI?

Yes. KosmoKrator exposes a Browserless CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Browserless through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Browserless tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Browserless credentials stored?

Browserless credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Browserless MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

rendering

Browserless Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Browserless KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.browserless.*. Use lua_read_doc("integrations.browserless") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Browserless workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.browserless.post_chrome_content({block_ads = true, launch = "example_launch", profile = "example_profile", timeout = 1, tracking_id = "example_tracking_id", body = "example_body"}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("browserless"))' --json
kosmo integrations:lua --eval 'print(docs.read("browserless.post_chrome_content"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local browserless = app.integrations.browserless
local result = browserless.post_chrome_content({block_ads = true, launch = "example_launch", profile = "example_profile", timeout = 1, tracking_id = "example_tracking_id", body = "example_body"})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.browserless, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.browserless.default.* or app.integrations.browserless.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Browserless, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Browserless Integration

Namespace: browserless

This integration exposes Browserless OpenAPI operations as endpoint-specific tools. It was generated from the official Browserless Redoc/OpenAPI page at https://docs.browserless.io/open-api. Browserless authenticates with a token query parameter; tools do not expose that token because the service injects it from host credentials.

JSON request bodies are passed through body. JavaScript function/download endpoints use a code string and send it as application/javascript. Wildcard routes expose path_suffix for the dynamic portion of the URL.

Coverage

Official paths: 67
Official operations: 74
Read operations: 33
Write operations: 41

Examples

local version = browserless.browserless_get_json_version({})
local screenshot = browserless.browserless_post_screenshot({
  body = { url = "https://example.test" }
})
local fn = browserless.browserless_post_chrome_function({
  code = "module.exports = async ({ page }) => await page.title();"
})

Common Tools

browserless_post_chrome_content - POST /chrome/content
browserless_post_chrome_download - POST /chrome/download
browserless_post_chrome_function - POST /chrome/function
browserless_put_json_new - PUT /json/new
browserless_get_json_protocol - GET /json/protocol
browserless_get_json_version - GET /json/version
browserless_post_chrome_pdf - POST /chrome/pdf
browserless_post_chrome_performance - POST /chrome/performance
browserless_post_chrome_scrape - POST /chrome/scrape
browserless_post_chrome_screenshot - POST /chrome/screenshot
browserless_post_chromium_content - POST /chromium/content
browserless_post_chromium_download - POST /chromium/download
browserless_post_chromium_function - POST /chromium/function
browserless_post_chromium_performance - POST /chromium/performance
browserless_post_chromium_scrape - POST /chromium/scrape
browserless_post_edge_content - POST /edge/content
browserless_post_edge_download - POST /edge/download
browserless_post_edge_function - POST /edge/function
browserless_post_edge_pdf - POST /edge/pdf
browserless_post_edge_performance - POST /edge/performance
browserless_post_edge_scrape - POST /edge/scrape
browserless_post_edge_screenshot - POST /edge/screenshot
browserless_get_active - GET /active
browserless_get_kill_id - GET /kill/+([0-9a-zA-Z-_])
browserless_get_meta - GET /meta
browserless_get_root - GET /
browserless_get_devtools_browser_wildcard - GET /devtools/browser/*
browserless_get_chrome - GET /chrome
browserless_get_function_connect_wildcard - GET /function/connect/*
browserless_get_devtools_page_wildcard - GET /devtools/page/*
browserless_get_chrome_playwright - GET /chrome/playwright
browserless_get_chromium - GET /chromium
browserless_get_chromium_playwright - GET /chromium/playwright
browserless_get_edge - GET /edge
browserless_get_edge_playwright - GET /edge/playwright
browserless_get_firefox_playwright - GET /firefox/playwright
browserless_get_webkit_playwright - GET /webkit/playwright
browserless_delete_browser_wildcard - DELETE /browser/*
browserless_post_chrome_export - POST /chrome/export
browserless_post_chrome_unblock - POST /chrome/unblock

All examples use fake URLs and safe placeholder values. Configure API tokens through the host credential resolver, not in Lua source.

Raw agent markdown

# Browserless Integration

Namespace: `browserless`

This integration exposes Browserless OpenAPI operations as endpoint-specific tools. It was generated from the official Browserless Redoc/OpenAPI page at `https://docs.browserless.io/open-api`. Browserless authenticates with a `token` query parameter; tools do not expose that token because the service injects it from host credentials.

JSON request bodies are passed through `body`. JavaScript function/download endpoints use a `code` string and send it as `application/javascript`. Wildcard routes expose `path_suffix` for the dynamic portion of the URL.

## Coverage

- Official paths: 67
- Official operations: 74
- Read operations: 33
- Write operations: 41

## Examples

```lua
local version = browserless.browserless_get_json_version({})
local screenshot = browserless.browserless_post_screenshot({
  body = { url = "https://example.test" }
})
local fn = browserless.browserless_post_chrome_function({
  code = "module.exports = async ({ page }) => await page.title();"
})
```

## Common Tools

- `browserless_post_chrome_content` - POST /chrome/content
- `browserless_post_chrome_download` - POST /chrome/download
- `browserless_post_chrome_function` - POST /chrome/function
- `browserless_put_json_new` - PUT /json/new
- `browserless_get_json_protocol` - GET /json/protocol
- `browserless_get_json_version` - GET /json/version
- `browserless_post_chrome_pdf` - POST /chrome/pdf
- `browserless_post_chrome_performance` - POST /chrome/performance
- `browserless_post_chrome_scrape` - POST /chrome/scrape
- `browserless_post_chrome_screenshot` - POST /chrome/screenshot
- `browserless_post_chromium_content` - POST /chromium/content
- `browserless_post_chromium_download` - POST /chromium/download
- `browserless_post_chromium_function` - POST /chromium/function
- `browserless_post_chromium_performance` - POST /chromium/performance
- `browserless_post_chromium_scrape` - POST /chromium/scrape
- `browserless_post_edge_content` - POST /edge/content
- `browserless_post_edge_download` - POST /edge/download
- `browserless_post_edge_function` - POST /edge/function
- `browserless_post_edge_pdf` - POST /edge/pdf
- `browserless_post_edge_performance` - POST /edge/performance
- `browserless_post_edge_scrape` - POST /edge/scrape
- `browserless_post_edge_screenshot` - POST /edge/screenshot
- `browserless_get_active` - GET /active
- `browserless_get_kill_id` - GET /kill/+([0-9a-zA-Z-_])
- `browserless_get_meta` - GET /meta
- `browserless_get_root` - GET /
- `browserless_get_devtools_browser_wildcard` - GET /devtools/browser/*
- `browserless_get_chrome` - GET /chrome
- `browserless_get_function_connect_wildcard` - GET /function/connect/*
- `browserless_get_devtools_page_wildcard` - GET /devtools/page/*
- `browserless_get_chrome_playwright` - GET /chrome/playwright
- `browserless_get_chromium` - GET /chromium
- `browserless_get_chromium_playwright` - GET /chromium/playwright
- `browserless_get_edge` - GET /edge
- `browserless_get_edge_playwright` - GET /edge/playwright
- `browserless_get_firefox_playwright` - GET /firefox/playwright
- `browserless_get_webkit_playwright` - GET /webkit/playwright
- `browserless_delete_browser_wildcard` - DELETE /browser/*
- `browserless_post_chrome_export` - POST /chrome/export
- `browserless_post_chrome_unblock` - POST /chrome/unblock

All examples use fake URLs and safe placeholder values. Configure API tokens through the host credential resolver, not in Lua source.

Metadata-derived Lua example

local result = app.integrations.browserless.post_chrome_content({block_ads = true, launch = "example_launch", profile = "example_profile", timeout = 1, tracking_id = "example_tracking_id", body = "example_body"})
print(result)

Functions

post_chrome_content Read

/chrome/content Official Browserless endpoint: POST /chrome/content.

Lua path: app.integrations.browserless.post_chrome_content
Full name: browserless.browserless_post_chrome_content

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	launch
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_chrome_download Read

/chrome/download Official Browserless endpoint: POST /chrome/download.

Lua path: app.integrations.browserless.post_chrome_download
Full name: browserless.browserless_post_chrome_download

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`code`	string	no	JavaScript source body sent as application/javascript.

post_chrome_function Read

/chrome/function Official Browserless endpoint: POST /chrome/function.

Lua path: app.integrations.browserless.post_chrome_function
Full name: browserless.browserless_post_chrome_function

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`code`	string	no	JavaScript source body sent as application/javascript.

put_json_new Read

/json/new Official Browserless endpoint: PUT /json/new.

Lua path: app.integrations.browserless.put_json_new
Full name: browserless.browserless_put_json_new

Parameter	Type	Required	Description
No parameters.

get_json_protocol Read

/json/protocol Official Browserless endpoint: GET /json/protocol.

Lua path: app.integrations.browserless.get_json_protocol
Full name: browserless.browserless_get_json_protocol

Parameter	Type	Required	Description
No parameters.

get_json_version Read

/json/version Official Browserless endpoint: GET /json/version.

Lua path: app.integrations.browserless.get_json_version
Full name: browserless.browserless_get_json_version

Parameter	Type	Required	Description
No parameters.

post_chrome_pdf Read

/chrome/pdf Official Browserless endpoint: POST /chrome/pdf.

Lua path: app.integrations.browserless.post_chrome_pdf
Full name: browserless.browserless_post_chrome_pdf

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_chrome_performance Read

/chrome/performance Official Browserless endpoint: POST /chrome/performance.

Lua path: app.integrations.browserless.post_chrome_performance
Full name: browserless.browserless_post_chrome_performance

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_chrome_scrape Read

/chrome/scrape Official Browserless endpoint: POST /chrome/scrape.

Lua path: app.integrations.browserless.post_chrome_scrape
Full name: browserless.browserless_post_chrome_scrape

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	launch
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_chrome_screenshot Read

/chrome/screenshot Official Browserless endpoint: POST /chrome/screenshot.

Lua path: app.integrations.browserless.post_chrome_screenshot
Full name: browserless.browserless_post_chrome_screenshot

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_chromium_content Read

/chromium/content Official Browserless endpoint: POST /chromium/content.

Lua path: app.integrations.browserless.post_chromium_content
Full name: browserless.browserless_post_chromium_content

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	launch
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_chromium_download Read

/chromium/download Official Browserless endpoint: POST /chromium/download.

Lua path: app.integrations.browserless.post_chromium_download
Full name: browserless.browserless_post_chromium_download

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`code`	string	no	JavaScript source body sent as application/javascript.

post_chromium_function Read

/chromium/function Official Browserless endpoint: POST /chromium/function.

Lua path: app.integrations.browserless.post_chromium_function
Full name: browserless.browserless_post_chromium_function

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`code`	string	no	JavaScript source body sent as application/javascript.

post_chromium_performance Read

/chromium/performance Official Browserless endpoint: POST /chromium/performance.

Lua path: app.integrations.browserless.post_chromium_performance
Full name: browserless.browserless_post_chromium_performance

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_chromium_scrape Read

/chromium/scrape Official Browserless endpoint: POST /chromium/scrape.

Lua path: app.integrations.browserless.post_chromium_scrape
Full name: browserless.browserless_post_chromium_scrape

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	launch
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_edge_content Read

/edge/content Official Browserless endpoint: POST /edge/content.

Lua path: app.integrations.browserless.post_edge_content
Full name: browserless.browserless_post_edge_content

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	launch
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_edge_download Read

/edge/download Official Browserless endpoint: POST /edge/download.

Lua path: app.integrations.browserless.post_edge_download
Full name: browserless.browserless_post_edge_download

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`code`	string	no	JavaScript source body sent as application/javascript.

post_edge_function Read

/edge/function Official Browserless endpoint: POST /edge/function.

Lua path: app.integrations.browserless.post_edge_function
Full name: browserless.browserless_post_edge_function

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`code`	string	no	JavaScript source body sent as application/javascript.

post_edge_pdf Read

/edge/pdf Official Browserless endpoint: POST /edge/pdf.

Lua path: app.integrations.browserless.post_edge_pdf
Full name: browserless.browserless_post_edge_pdf

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_edge_performance Read

/edge/performance Official Browserless endpoint: POST /edge/performance.

Lua path: app.integrations.browserless.post_edge_performance
Full name: browserless.browserless_post_edge_performance

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_edge_scrape Read

/edge/scrape Official Browserless endpoint: POST /edge/scrape.

Lua path: app.integrations.browserless.post_edge_scrape
Full name: browserless.browserless_post_edge_scrape

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	launch
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_edge_screenshot Read

/edge/screenshot Official Browserless endpoint: POST /edge/screenshot.

Lua path: app.integrations.browserless.post_edge_screenshot
Full name: browserless.browserless_post_edge_screenshot

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

get_active Read

/active Official Browserless endpoint: GET /active.

Lua path: app.integrations.browserless.get_active
Full name: browserless.browserless_get_active

Parameter	Type	Required	Description
No parameters.

get_kill_id Read

/kill/+([0-9a-zA-Z-_]) Official Browserless endpoint: GET /kill/+([0-9a-zA-Z-_]).

Lua path: app.integrations.browserless.get_kill_id
Full name: browserless.browserless_get_kill_id

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`browser_id`	string	no	browserId
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_meta Read

/meta Official Browserless endpoint: GET /meta.

Lua path: app.integrations.browserless.get_meta
Full name: browserless.browserless_get_meta

Parameter	Type	Required	Description
No parameters.

get_root Read

/ Official Browserless endpoint: GET /.

Lua path: app.integrations.browserless.get_root
Full name: browserless.browserless_get_root

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`integrations`	string	no	integrations
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`record`	boolean	no	record
`replay`	boolean	no	replay
`solve_captchas`	boolean	no	solveCaptchas
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_devtools_wildcard Read

/devtools/browser/* Official Browserless endpoint: GET /devtools/browser/*.

Lua path: app.integrations.browserless.get_devtools_wildcard
Full name: browserless.browserless_get_devtools_browser_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_chrome Read

/chrome Official Browserless endpoint: GET /chrome.

Lua path: app.integrations.browserless.get_chrome
Full name: browserless.browserless_get_chrome

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`integrations`	string	no	integrations
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`record`	boolean	no	record
`replay`	boolean	no	replay
`solve_captchas`	boolean	no	solveCaptchas
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_function_connect_wildcard Read

/function/connect/* Official Browserless endpoint: GET /function/connect/*.

Lua path: app.integrations.browserless.get_function_connect_wildcard
Full name: browserless.browserless_get_function_connect_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_devtools_page_wildcard Read

/devtools/page/* Official Browserless endpoint: GET /devtools/page/*.

Lua path: app.integrations.browserless.get_devtools_page_wildcard
Full name: browserless.browserless_get_devtools_page_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_chrome_playwright Read

/chrome/playwright Official Browserless endpoint: GET /chrome/playwright.

Lua path: app.integrations.browserless.get_chrome_playwright
Full name: browserless.browserless_get_chrome_playwright

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_chromium Read

/chromium Official Browserless endpoint: GET /chromium.

Lua path: app.integrations.browserless.get_chromium
Full name: browserless.browserless_get_chromium

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_chromium_playwright Read

/chromium/playwright Official Browserless endpoint: GET /chromium/playwright.

Lua path: app.integrations.browserless.get_chromium_playwright
Full name: browserless.browserless_get_chromium_playwright

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_edge Read

/edge Official Browserless endpoint: GET /edge.

Lua path: app.integrations.browserless.get_edge
Full name: browserless.browserless_get_edge

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`integrations`	string	no	integrations
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`record`	boolean	no	record
`replay`	boolean	no	replay
`solve_captchas`	boolean	no	solveCaptchas
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_edge_playwright Read

/edge/playwright Official Browserless endpoint: GET /edge/playwright.

Lua path: app.integrations.browserless.get_edge_playwright
Full name: browserless.browserless_get_edge_playwright

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_firefox_playwright Read

/firefox/playwright Official Browserless endpoint: GET /firefox/playwright.

Lua path: app.integrations.browserless.get_firefox_playwright
Full name: browserless.browserless_get_firefox_playwright

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	object	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_webkit_playwright Read

/webkit/playwright Official Browserless endpoint: GET /webkit/playwright.

Lua path: app.integrations.browserless.get_webkit_playwright
Full name: browserless.browserless_get_webkit_playwright

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

delete_wildcard Write

/browser/* Official Browserless endpoint: DELETE /browser/*.

Lua path: app.integrations.browserless.delete_wildcard
Full name: browserless.browserless_delete_browser_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.

post_chrome_export Read

/chrome/export Official Browserless endpoint: POST /chrome/export.

Lua path: app.integrations.browserless.post_chrome_export
Full name: browserless.browserless_post_chrome_export

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_chrome_unblock Read

/chrome/unblock Official Browserless endpoint: POST /chrome/unblock.

Lua path: app.integrations.browserless.post_chrome_unblock
Full name: browserless.browserless_post_chrome_unblock

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_chromium_export Read

/chromium/export Official Browserless endpoint: POST /chromium/export.

Lua path: app.integrations.browserless.post_chromium_export
Full name: browserless.browserless_post_chromium_export

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_unblock Read

/unblock Official Browserless endpoint: POST /unblock.

Lua path: app.integrations.browserless.post_unblock
Full name: browserless.browserless_post_unblock

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

get_proxy_cities Read

/proxy/cities Official Browserless endpoint: GET /proxy/cities.

Lua path: app.integrations.browserless.get_proxy_cities
Full name: browserless.browserless_get_proxy_cities

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`country`	string	no	Optional two-letter country code to filter cities by country (e.g., 'US', 'GB', 'DE').
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

post_map Read

/map Official Browserless endpoint: POST /map.

Lua path: app.integrations.browserless.post_map
Full name: browserless.browserless_post_map

Parameter	Type	Required	Description
`timeout`	number	no	Request timeout in milliseconds
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_pdf Read

/pdf Official Browserless endpoint: POST /pdf.

Lua path: app.integrations.browserless.post_pdf
Full name: browserless.browserless_post_pdf

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_screenshot Read

/screenshot Official Browserless endpoint: POST /screenshot.

Lua path: app.integrations.browserless.post_screenshot
Full name: browserless.browserless_post_screenshot

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_search Read

/search Official Browserless endpoint: POST /search.

Lua path: app.integrations.browserless.post_search
Full name: browserless.browserless_post_search

Parameter	Type	Required	Description
`timeout`	number	no	The timeout for the search operation in milliseconds.
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_session Read

/session Official Browserless endpoint: POST /session.

Lua path: app.integrations.browserless.post_session
Full name: browserless.browserless_post_session

Parameter	Type	Required	Description
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

delete_session_wildcard Write

/session/* Official Browserless endpoint: DELETE /session/*.

Lua path: app.integrations.browserless.delete_session_wildcard
Full name: browserless.browserless_delete_session_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`force`	boolean	no	Whether to force the deletion of the session even if it has active connections. Defaults to false.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

post_smart_scrape Read

/smart-scrape Official Browserless endpoint: POST /smart-scrape.

Lua path: app.integrations.browserless.post_smart_scrape
Full name: browserless.browserless_post_smart_scrape

Parameter	Type	Required	Description
`profile`	string	no	Optional name of an authentication profile to hydrate into the browser before scraping. The profile's cookies, localStorage, and IndexedDB entries are loaded into the session before navigation. Forces the browser strategy.
`timeout`	number	no	The timeout for the scrape operation in milliseconds
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_stealth_bqloptional_path Read

/stealth/bql?(/*) Official Browserless endpoint: POST /stealth/bql?(/*).

Lua path: app.integrations.browserless.post_stealth_bqloptional_path
Full name: browserless.browserless_post_stealth_bqloptional_path

Parameter	Type	Required	Description
`path_suffix`	string	no	Optional Browserless path suffix for this route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`block_consent_modals`	boolean	no	Whether to automatically block cookie consent modals and popups.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`humanlike`	boolean	no	Whether to enable human-like behavior for interactions. When true, actions like typing and clicking will have randomized delays.
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`replay`	boolean	no	Whether to enable session recording for replay. When true, the session will be recorded and can be replayed later.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

get_stealth_bqloptional_path Read

/stealth/bql?(/*) Official Browserless endpoint: GET /stealth/bql?(/*).

Lua path: app.integrations.browserless.get_stealth_bqloptional_path
Full name: browserless.browserless_get_stealth_bqloptional_path

Parameter	Type	Required	Description
`path_suffix`	string	no	Optional Browserless path suffix for this route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`block_consent_modals`	boolean	no	blockConsentModals
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`humanlike`	boolean	no	humanlike
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`replay`	boolean	no	replay
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

post_chrome_bqloptional_path Read

/chrome/bql?(/*) Official Browserless endpoint: POST /chrome/bql?(/*).

Lua path: app.integrations.browserless.post_chrome_bqloptional_path
Full name: browserless.browserless_post_chrome_bqloptional_path

Parameter	Type	Required	Description
`path_suffix`	string	no	Optional Browserless path suffix for this route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`block_consent_modals`	boolean	no	Whether to automatically block cookie consent modals and popups.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`humanlike`	boolean	no	Whether to enable human-like behavior for interactions. When true, actions like typing and clicking will have randomized delays.
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`replay`	boolean	no	Whether to enable session recording for replay. When true, the session will be recorded and can be replayed later.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

get_chrome_bqloptional_path Read

/chrome/bql?(/*) Official Browserless endpoint: GET /chrome/bql?(/*).

Lua path: app.integrations.browserless.get_chrome_bqloptional_path
Full name: browserless.browserless_get_chrome_bqloptional_path

Parameter	Type	Required	Description
`path_suffix`	string	no	Optional Browserless path suffix for this route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`block_consent_modals`	boolean	no	blockConsentModals
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`humanlike`	boolean	no	humanlike
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`replay`	boolean	no	replay
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

post_chromium_bqloptional_path Read

/chromium/bql?(/*) Official Browserless endpoint: POST /chromium/bql?(/*).

Lua path: app.integrations.browserless.post_chromium_bqloptional_path
Full name: browserless.browserless_post_chromium_bqloptional_path

Parameter	Type	Required	Description
`path_suffix`	string	no	Optional Browserless path suffix for this route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`block_consent_modals`	boolean	no	Whether to automatically block cookie consent modals and popups.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`humanlike`	boolean	no	Whether to enable human-like behavior for interactions. When true, actions like typing and clicking will have randomized delays.
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`replay`	boolean	no	Whether to enable session recording for replay. When true, the session will be recorded and can be replayed later.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

get_chromium_bqloptional_path Read

/chromium/bql?(/*) Official Browserless endpoint: GET /chromium/bql?(/*).

Lua path: app.integrations.browserless.get_chromium_bqloptional_path
Full name: browserless.browserless_get_chromium_bqloptional_path

Parameter	Type	Required	Description
`path_suffix`	string	no	Optional Browserless path suffix for this route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`block_consent_modals`	boolean	no	blockConsentModals
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`humanlike`	boolean	no	humanlike
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`replay`	boolean	no	replay
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

post_session_bql_wildcard Read

/session/bql/* Official Browserless endpoint: POST /session/bql/*.

Lua path: app.integrations.browserless.post_session_bql_wildcard
Full name: browserless.browserless_post_session_bql_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`replay`	boolean	no	replay
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

delete_crawl_wildcard Write

/crawl/* Official Browserless endpoint: DELETE /crawl/*.

Lua path: app.integrations.browserless.delete_crawl_wildcard
Full name: browserless.browserless_delete_crawl_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.

get_crawl_wildcard Read

/crawl/* Official Browserless endpoint: GET /crawl/*.

Lua path: app.integrations.browserless.get_crawl_wildcard
Full name: browserless.browserless_get_crawl_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.
`skip`	number	no	The number of pages to skip for pagination.

get_crawl Read

/crawl Official Browserless endpoint: GET /crawl.

Lua path: app.integrations.browserless.get_crawl
Full name: browserless.browserless_get_crawl

Parameter	Type	Required	Description
`cursor`	string	no	Cursor for fetching the next page of results.
`limit`	number	no	Maximum number of crawls to return per page (1–100, default 20).
`status`	string	no	Filter crawls by status: in-progress, completed, failed, or cancelled.

post_crawl Read

/crawl Official Browserless endpoint: POST /crawl.

Lua path: app.integrations.browserless.post_crawl
Full name: browserless.browserless_post_crawl

Parameter	Type	Required	Description
`profile`	string	no	Optional name of an authentication profile to hydrate into the browser before each page is scraped. The profile's cookies, localStorage, and IndexedDB entries are loaded into the session before navigation. Forces the browser strategy for every page.
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

post_profile Read

/profile Official Browserless endpoint: POST /profile.

Lua path: app.integrations.browserless.post_profile
Full name: browserless.browserless_post_profile

Parameter	Type	Required	Description
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

delete_profile_wildcard Write

/profile/* Official Browserless endpoint: DELETE /profile/*.

Lua path: app.integrations.browserless.delete_profile_wildcard
Full name: browserless.browserless_delete_profile_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.

get_profile_wildcard Read

/profile/* Official Browserless endpoint: GET /profile/*.

Lua path: app.integrations.browserless.get_profile_wildcard
Full name: browserless.browserless_get_profile_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.

put_profile_wildcard Read

/profile/* Official Browserless endpoint: PUT /profile/*.

Lua path: app.integrations.browserless.put_profile_wildcard
Full name: browserless.browserless_put_profile_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.
`body`	object	no	JSON request body matching the Browserless OpenAPI schema.

get_profiles Read

/profiles Official Browserless endpoint: GET /profiles.

Lua path: app.integrations.browserless.get_profiles
Full name: browserless.browserless_get_profiles

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`limit`	number	no	Maximum number of profiles to return (1–1000). Defaults to 100.
`offset`	number	no	Number of profiles to skip for pagination. Defaults to 0.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_stealth Read

/stealth Official Browserless endpoint: GET /stealth.

Lua path: app.integrations.browserless.get_stealth
Full name: browserless.browserless_get_stealth

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`integrations`	string	no	integrations
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`record`	boolean	no	record
`replay`	boolean	no	replay
`solve_captchas`	boolean	no	solveCaptchas
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_chrome_live_wildcard Read

/chrome/live/* Official Browserless endpoint: GET /chrome/live/*.

Lua path: app.integrations.browserless.get_chrome_live_wildcard
Full name: browserless.browserless_get_chrome_live_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.

get_chrome_stealth Read

/chrome/stealth Official Browserless endpoint: GET /chrome/stealth.

Lua path: app.integrations.browserless.get_chrome_stealth
Full name: browserless.browserless_get_chrome_stealth

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`integrations`	string	no	integrations
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`record`	boolean	no	record
`replay`	boolean	no	replay
`solve_captchas`	boolean	no	solveCaptchas
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_live_wildcard Read

/live/* Official Browserless endpoint: GET /live/*.

Lua path: app.integrations.browserless.get_live_wildcard
Full name: browserless.browserless_get_live_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.

get_chromium_stealth Read

/chromium/stealth Official Browserless endpoint: GET /chromium/stealth.

Lua path: app.integrations.browserless.get_chromium_stealth
Full name: browserless.browserless_get_chromium_stealth

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`integrations`	string	no	integrations
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`record`	boolean	no	record
`replay`	boolean	no	replay
`solve_captchas`	boolean	no	solveCaptchas
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_reconnect_wildcard Read

/reconnect/* Official Browserless endpoint: GET /reconnect/*.

Lua path: app.integrations.browserless.get_reconnect_wildcard
Full name: browserless.browserless_get_reconnect_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`integrations`	string	no	integrations
`launch`	string	no	Launch options, which can be either an object of puppeteer.launch options or playwright.launchServer options, depending on the API. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`replay`	boolean	no	replay
`solve_captchas`	boolean	no	solveCaptchas
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier

get_session_connect_wildcard Read

/session/connect/* Official Browserless endpoint: GET /session/connect/*.

Lua path: app.integrations.browserless.get_session_connect_wildcard
Full name: browserless.browserless_get_session_connect_wildcard

Parameter	Type	Required	Description
`path_suffix`	string	yes	Dynamic Browserless path suffix for this wildcard route.
`launch`	string	no	launch
`replay`	boolean	no	replay
`timeout`	number	no	timeout

get_chromium_agent Read

/chromium/agent Official Browserless endpoint: GET /chromium/agent.

Lua path: app.integrations.browserless.get_chromium_agent
Full name: browserless.browserless_get_chromium_agent

Parameter	Type	Required	Description
`block_ads`	boolean	no	Whether or nor to load ad-blocking extensions for the session. This currently uses uBlock-Lite and may cause certain sites to not load properly.
`block_consent_modals`	boolean	no	Whether to automatically block cookie consent modals and popups.
`external_proxy_server`	string	no	External proxy server URL for user-provided proxies. Format: http(s)://[username:password@]host:port When set, routes requests through this proxy instead of built-in residential proxies.
`humanlike`	boolean	no	Whether to enable human-like behavior for interactions. When true, actions like typing and clicking will have randomized delays.
`launch`	string	no	Launch options for the browser, either as a JSON object or a JSON string. Includes options like `headless`, `args`, `defaultViewport`, etc. Must be either JSON object, or a base64-encoded JSON object.
`profile`	string	no	Name of an authenticated profile to hydrate into the browser at launch. The profile's cookies, localStorage and IndexedDB are injected via CDP before your code runs. No-op in builds without a profile subsystem.
`proxy`	string	no	The type of proxy to use, currently just 'residential' is supported
`proxy_city`	string	no	The city to use for the proxy. Available cities: https://production-sfo.browserless.io/proxy/cities?token=YOUR_TOKEN Documentation: https://docs.browserless.io/baas/features/proxies#built-in-residential-proxy
`proxy_country`	string	no	A two-letter country code for the proxy configuration. Supported codes: US, GB, FR, DE, etc. Full list: https://docs.browserless.io/bql-schema/types/enums/country-type
`proxy_locale_match`	string	no	Sets the browser's language to match the proxy's geographic location. Recommended when using proxyCountry to ensure websites render content, currency, and formatting in the local language. Default is English (en-US).
`proxy_preset`	string	no	A preset code for website-specific proxy routing. Maps to specific proxy vendors internally for optimal access to certain websites. Format: "px_<identifier>" (e.g., "px_gov01", "px_amazon01")
`proxy_state`	string	no	The state or province to use for the proxy, whitespace must be replaced with underscores
`proxy_sticky`	string	no	Whether or not to use the same IP for all requests, defaults to true
`replay`	boolean	no	Whether to enable session recording for replay. When true, the session will be recorded and can be replayed later.
`timeout`	number	no	Override the system-level timeout for this request. Accepts a value in milliseconds.
`tracking_id`	string	no	Custom session identifier