Overview
Welcome to the Browser Base integration guide for Julep! This integration allows you to manage browser sessions and perform various actions, enabling you to build workflows that require browser automation capabilities. Whether you’re testing web applications or automating web tasks, this guide will walk you through the setup and usage.Prerequisites
To use the Browserbase integration, you need an API key. You can obtain this key by signing up at Browserbase.
To use the Browserbase integration, you need a Project ID. You can obtain this ID by signing up at Browserbase.
How to Use the Integration
To get started with the Browserbase integration, follow these steps to configure and create a task:1
Configure Your API Key
Add your API key and project ID to the tools section of your task. This will allow Julep to authenticate requests to Browserbase on your behalf.
2
Create Task Definition
Use the following YAML configuration to define your browser automation task:
Browser Base Example
YAML Explanation
Basic Configuration
Basic Configuration
- name: A descriptive name for the task, in this case, “Browser Base Task”.
- tools: This section lists the tools or integrations being used. Here,
browserbase_tool
is defined as an integration tool.
Tool Configuration
Tool Configuration
- type: Specifies the type of tool, which is
integration
in this context. - integration: Details the provider and setup for the integration.
- provider: Indicates the service provider, which is
browserbase
for Browserbase. - method: Specifies the method to use, such as
create_session
,list_sessions
,get_session
,complete_session
,get_live_urls
, orinstall_extension_from_github
. Defaults tolist_sessions
if not specified. - setup: Contains configuration details.
- api_key:(Required) The API key. Can be found in Settings.
- project_id: (Required) The Project ID. Can be found in Settings.
- api_url: (optional) The API URL. Defaults to https://www.browserbase.com
- connect_url: (optional) The Connect URL. Defaults to wss://connect.browserbase.com
- provider: Indicates the service provider, which is
Workflow Configuration
Workflow Configuration
- main: Defines the main execution steps.
- tool: Refers to the tool defined earlier (
browserbase_tool
). - arguments: Specifies the input parameters for the tool, which vary depending on the method used.
create_session
- project_id: The Project ID. Can be found in Settings.
- extension_id: (optional) The installed Extension ID. See Install Extension from GitHub.
- browser_settings: (optional) Browser settings object.
- timeout: (optional) Duration in seconds after which the session will automatically end. Defaults to the Project’s defaultTimeout.
- keep_alive: (optional) Set to true to keep the session alive even after disconnections. This is available on the Startup plan only.
- proxies: (optional) Proxy configuration. Can be true for default proxy, or an array of proxy configurations.
list_sessions
- status: The status of the sessions to list (Available options: RUNNING, ERROR, TIMED_OUT, COMPLETED).
get_session
- id: The session ID.
complete_session
- id: The session ID.
get_live_urls
- id: The session ID.
install_extension_from_github
- repository_name: The GitHub repository name.
- ref: Ref to install from a branch or tag.
- tool: Refers to the tool defined earlier (
- Remember to replace
BROWSERBASE_API_KEY
andBROWSERBASE_PROJECT_ID
with your actual API key and project ID. - Customize the
arguments
based on the method you choose to use.
Conclusion
With the Browserbase integration, you can efficiently manage browser sessions and automate web tasks. This integration provides a robust solution for browser automation, enhancing your workflow’s capabilities and user experience.For more information, please refer to the Browserbase API documentation.