Skip to main content
Server path: /browser-automation | Type: Embedded | PCID required: No

Tools

ToolDescription
browser-automation_operator_runStart a browser automation task using natural language. Returns sessionId, collectionId, logFileName.
BROWSER AUTOMATION PATTERN: Put run + poll loop + file saving in ONE node function. Do NOT create separate nodes. Call capability_details for ‘browser-automation’ to get the full workflow code pattern. | | browser-automation_operator_run_continue | Check status of a running Browser Operator task. Call in a loop after browser-automation_operator_run until status is “completed” or “failed”. Returns current status and log content. Poll every 3-5 seconds. | | browser-automation_playwright_run | Run Playwright code in a remote cloud browser. Returns sessionId, collectionId, logFileName. BROWSER AUTOMATION PATTERN: Put run + poll loop + file saving in ONE node function. Do NOT create separate nodes. Call capability_details for ‘browser-automation’ to get the full workflow code pattern. | | browser-automation_playwright_run_continue | Check status of a running Playwright task. Call in a loop after browser-automation_playwright_run until status is “completed” or “failed”. Poll every 3-5 seconds. | | browser-automation_logins_list | List saved browser login contexts. These are pre-authenticated browser sessions that can be reused for automation tasks. Use the context ID with useContextService parameter in browser-automation_operator_run or browser-automation_playwright_run. |

browser-automation_operator_run

Start a browser automation task using natural language. Returns sessionId, collectionId, logFileName. BROWSER AUTOMATION PATTERN: Put run + poll loop + file saving in ONE node function. Do NOT create separate nodes. Call capability_details for ‘browser-automation’ to get the full workflow code pattern. Parameters:
ParameterTypeRequiredDefaultDescription
taskstringYesREQUIRED: Natural language description of the browser task. Write as a SINGLE LINE without line breaks. Be SPECIFIC - include: (1) Starting URL, (2) What action to take (click, fill, extract, navigate, download), (3) Which elements (button text, field labels), (4) Sample data to use for form filling, (5) What NOT to do if needed. GOOD EXAMPLES: “Navigate to https://example.com/contact, fill out the contact form with name=John Doe, email=john@example.com, message=Test inquiry, then submit the form” or “Go to https://example.com/products, scroll through all pages, extract product name, price, and description for each product, save as products.json”. BAD EXAMPLES: “Register on the site” (too vague), “Get the data” (what data? from where?).
modelstringNo"google/gemini-3-flash-preview"AI model for browser automation. Default: ‘google/gemini-3-flash-preview’. Use ‘google/gemini-2.5-pro’ for complex tasks.
agentModestringNo"hybrid"Agent interaction mode. ‘dom’: DOM-based tools using CSS selectors (works with any model). ‘hybrid’: Coordinate-based + DOM tools (DEFAULT, visual interactions). ‘cua’: Computer Use Agent mode (CUA-specific models only).
maxStepsnumberNo30Maximum actions the agent can take. Default: 30. Increase for complex multi-page tasks.
systemPromptstringNoRole/context for the agent (e.g., “You are a helpful assistant filling out medical forms”).
cacheKeystringYesREQUIRED: Cache identifier string. Generate a unique random 8-character alphanumeric string, e.g. “a1b2c3d4” or “xK9mP2qL”. Must be a hardcoded string literal, NOT a runtime variable. IMPORTANT: Generate a NEW unique value every time you update the code.
disableCachebooleanNofalseWhether to bypass caching. Default: false (caching ON). Set to true to force fresh execution.
cacheDurationDaysnumberNo7Cache expiration in days. Default: 7. Use 30 for stable sites, 1 for frequently changing sites.
regionstringNo"us-west-2"Server region for browser execution. Default: us-west-2 (Oregon). Options: us-east-1 (Virginia), eu-central-1 (Frankfurt), ap-southeast-1 (Singapore).
proxiesbooleanNofalseEnable residential proxies. Default: false. Set to true for sites that block datacenter IPs.
viewportWidthnumberNo1288Browser viewport width in pixels. Default: 1288.
viewportHeightnumberNo711Browser viewport height in pixels. Default: 711.
advancedStealthbooleanNofalseEnable advanced anti-detection. Default: false. Set to true for bot-protected sites.
blockAdsbooleanNotrueBlock ads for faster page loads. Default: true.
solveCaptchasbooleanNotrueAuto-solve CAPTCHAs when encountered. Default: true.
recordSessionbooleanNotrueEnable session recording for replay/debugging. Default: true.
filesToUploadobject[]NoFiles to upload to browser before execution. Just say “upload filename” in task - the agent will handle file input clicking. Files must be publicly accessible URLs.
collectionIdstringNoFilestorage collection ID to save output files (extracted data, screenshots, downloads). If not provided, uses default collection.
useContextServicestringNoSaved login context ID (from browser_logins_list) to use pre-authenticated session. NOTE: Cookie injection not yet fully implemented - include login steps in task if authentication is needed.

browser-automation_operator_run_continue

Check status of a running Browser Operator task. Call in a loop after browser-automation_operator_run until status is “completed” or “failed”. Returns current status and log content. Poll every 3-5 seconds. Parameters:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesRequired: The sessionId returned by browser-automation_operator_run
logFileNamestringNoThe logFileName returned by browser-automation_operator_run. Enables live log streaming.
collectionIdstringNoThe collectionId returned by browser-automation_operator_run. Required with logFileName for log content.

browser-automation_playwright_run

Run Playwright code in a remote cloud browser. Returns sessionId, collectionId, logFileName. BROWSER AUTOMATION PATTERN: Put run + poll loop + file saving in ONE node function. Do NOT create separate nodes. Call capability_details for ‘browser-automation’ to get the full workflow code pattern. Parameters:
ParameterTypeRequiredDefaultDescription
codestringYesREQUIRED: Playwright JavaScript code. The page variable is pre-configured.
TO SAVE RESULTS - return this structure: { writeToCollection: true, fileName: ‘data.json’, fileContent: JSON.stringify(yourData, null, 2) } MULTIPLE FILES: { writeToCollection: true, files: [{ fileName: ‘a.json’, fileContent: ’…’ }, { fileName: ‘b.png’, fileContent: buffer, contentType: ‘image/png’ }] } EXAMPLE - Get page HTML (most reliable for unfamiliar sites): await page.goto(‘https://example.com’); const html = await page.content(); return { writeToCollection: true, fileName: ‘page.html’, fileContent: html }; EXAMPLE - Extract data with selectors: const items = await page.evaluate(() => Array.from(document.querySelectorAll(‘.item’)).map(el => ({ name: el.textContent }))); return { writeToCollection: true, fileName: ‘items.json’, fileContent: JSON.stringify(items, null, 2) }; EXAMPLE - Screenshot: const buffer = await page.screenshot({ fullPage: true }); return { writeToCollection: true, fileName: ‘screenshot.png’, fileContent: buffer, contentType: ‘image/png’ }; BROWSER DOWNLOADS: Files downloaded by clicking links are automatically captured and saved. No special return value needed. | | bindingData | object | No | — | Object with key-value pairs to inject into Playwright code. MUST be an object like { url: “https://…” }, NEVER a string. Access variables directly by name in code. | | buildId | string | No | — | For predictable file naming. Files become: {buildId}-filename.json. Recommended: “playwright-{timestamp}” or descriptive like “scrape-products”. | | collectionId | string | No | — | Filestorage collection ID to save output files. Default: MultimediaArtifact collection. | | useContextService | string | No | — | Saved login context ID (from browser_logins_list) for pre-authenticated sessions. |

browser-automation_playwright_run_continue

Check status of a running Playwright task. Call in a loop after browser-automation_playwright_run until status is “completed” or “failed”. Poll every 3-5 seconds. Parameters:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesRequired: The sessionId returned by browser-automation_playwright_run

browser-automation_logins_list

List saved browser login contexts. These are pre-authenticated browser sessions that can be reused for automation tasks. Use the context ID with useContextService parameter in browser-automation_operator_run or browser-automation_playwright_run. Parameters: None