View as Markdown
Browserbase icon

Browserbase ACTION

Create Session

Creates a new browser session with specified settings. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Browserbase account once, then configure and run Create Session 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: "browserbase-create-session",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    browserbase: { authProvisionId: "apn_xxxxxxx" },
    projectId: "Project ID",
    extensionId: "Extension ID",
  },
})

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.

Create Session inputs
Property Type Description
projectId Project ID string
The ID of the project
Required Dynamic
extensionId Extension ID string
The uploaded Extension ID
Optional
browserSettings Browser Settings object
An object with the settings for the session. See the documentation for more details.
Optional
timeout Timeout integer
Duration in seconds after which the session will automatically end.
Optional
keepAlive Keep Alive boolean
Set to true to keep the session alive even after disconnections.
Optional
proxies Proxies string[]
An array of objects with proxy configuration. See the documentation for more details.
Optional
region Region string
The region where the session should run.
Optional
userMetadata User Metadata object
Arbitrary user metadata to attach to the session. To learn more about user metadata, see User Metadata.
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
browserbase-create-session
Version
0.0.2
App
Browserbase
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes