View as Markdown
Anchor Browser icon

Anchor Browser ACTION

Start Browser

Allocates a new browser session for the user, with optional configurations for ad-blocking, captcha solving, proxy usage, and idle timeout. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Anchor Browser account once, then configure and run Start Browser from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "anchor_browser-start-browser",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    anchor_browser: { authProvisionId: "apn_xxxxxxx" },
    adblockConfigActive: true,
    adblockConfigPopupBlockingActive: true,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Start Browser inputs
Property Type Description
adblockConfigActive Adblock Configuration - Active boolean
Whether adblock configuration is active
Required
adblockConfigPopupBlockingActive Adblock Configuration - Popup Blocking Active boolean
Whether popup blocking is active
Required
captchaConfigActive Captcha Configuration - Active boolean
Whether captcha configuration is active
Required
headless Headless boolean
Whether browser should be headless or headfull.
Required
proxyConfigType Proxy Configuration - Type string
The type of proxy configuration to use. Eg. anchor_residential.
Optional
proxyConfigActive Proxy Configuration - Active boolean
Whether proxy configuration is active
Optional
recordingActive Recording - Active boolean
Whether recording is active
Optional
profileName Profile Name string
The name of the profile to use for the browser session.
Required Dynamic
profilePersist Profile - Persist boolean
Whether the profile should persist after the session ends.
Required
viewportWidth Viewport - Width integer
The width of the viewport
Required
viewportHeight Viewport - Height integer
The height of the viewport
Required
timeout Timeout string
Maximum amount of time (in minutes) for the browser to run, before terminating. Defaults to -1, which disables the global timeout mechanism.
Optional
idleTimeout Idle Timeout string
The amount of time (in minutes) the session waits for new connections after all others are closed before stopping. Defaults to 1. Setting it to -1 let the browser session continue forever [CAUTION - Keep track of long living sessions and manually kill them].
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
anchor_browser-start-browser
Version
0.0.2
App
Anchor Browser
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes