Skip to main content
Browserbase logo

​
Overview

Add Browserbase to any ModuleX agent or workflow. Cloud browser infrastructure for running and managing headless browser sessions via the Browserbase REST API (api.browserbase.com/v1).
Categories: Developer Tools & Infrastructure · Automation · Browser · Auth: API Key · Actions: 3

​
Authentication

​
API Key Authentication

Authenticate using your Browserbase API key
1

Step 1

Go to https://www.browserbase.com and sign in
2

Step 2

Navigate to Settings > API Keys
3

Step 3

Create a new API key or copy your existing one
4

Step 4

Paste the API key below

​
Required Credentials

FieldDescriptionRequiredFormat
Browserbase API KeyYour Browserbase API key from the settings pageYesbb_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Available Actions

​
Parameters

​
project_id
string
required
The ID of the Browserbase project

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "project_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Project Id"
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Created At"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateContextOutput",
  "type": "object"
}

​
Parameters

​
project_id
string
required
The ID of the Browserbase project
​
extension_id
string
The uploaded Extension ID to load in the session
​
browser_settings
object
Settings for the session (e.g. fingerprint, viewport). See Browserbase docs for schema.
​
timeout
integer
Duration in seconds after which the session will automatically end. Min: 60, Max: 21600.
​
keep_alive
boolean
Set to true to keep the session alive even after disconnections
​
proxies
array
Array of proxy configuration objects. Each element should have type and optional geolocation fields.
​
region
string
The region where the session should run. One of: us-west-2, us-east-1, eu-central-1, ap-southeast-1.
​
user_metadata
object
Arbitrary user metadata to attach to the session

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Id"
    },
    "project_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Project Id"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status"
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Created At"
    },
    "region": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Region"
    },
    "connect_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Connect Url"
    }
  },
  "required": [
    "success"
  ],
  "title": "CreateSessionOutput",
  "type": "object"
}

​
Response

{
  "$defs": {
    "ProjectSummary": {
      "additionalProperties": false,
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        }
      },
      "title": "ProjectSummary",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "projects": {
      "items": {
        "$ref": "#/$defs/ProjectSummary"
      },
      "title": "Projects",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListProjectsOutput",
  "type": "object"
}

​
Limits & Quotas

  • Rate limits are not publicly documented by Browserbase; contact their support for enterprise limits.
  • Session timeout range: 60–21600 seconds.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

Apify

Daytona

ServiceNow