Analytics & Data

Browseai

Learn how to use Browseai with Composio

Overview

SLUG: BROWSEAI

Description

Browse.ai allows you to turn any website into an API using its advanced web automation and data extraction tools, enabling easy monitoring and data retrieval from websites.

Authentication Details

full
stringDefaults to https://api.browse.ai/v2/Required
generic_api_key
stringRequired

Connecting to Browseai

Create an auth config

Use the dashboard to create an auth config for the Browseai toolkit. This allows you to connect multiple Browseai accounts to Composio for agents to use.

1

Select App

Navigate to the Browseai toolkit page and click “Setup Integration”.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Integration”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5browseai_auth_config_id = "ac_YOUR_BROWSEAI_CONFIG_ID" # Auth config ID created above
6user_id = "0000-0000-0000"  # UUID from database/app
7
8composio = Composio()
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11    # Replace this with a method to retrieve an API key from the user.
12    # Or supply your own.
13    user_api_key = input("[!] Enter API key")
14
15    connection_request = composio.connected_accounts.initiate(
16        user_id=user_id,
17        auth_config_id=auth_config_id,
18        config={"auth_scheme": "API_KEY", "val": user_api_key}
19    )
20
21    # API Key authentication is immediate - no redirect needed
22    print(f"Successfully connected Browseai for user {user_id}")
23    print(f"Connection status: {connection_request.status}")
24    
25    return connection_request.id
26
27
28connection_id = authenticate_toolkit(user_id, browseai_auth_config_id)
29
30# You can verify the connection using:
31connected_account = composio.connected_accounts.get(connection_id)
32print(f"Connected account: {connected_account}")

Tools

Executing tools

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["BROWSEAI"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Bulk Run Tasks

Description

This action allows users to bulk run up to 50,000 tasks using a specified robot. it provides a post endpoint at /v2/robots/{robotid}/bulk-tasks and supports parameters such as robot id (required), title (required), and input parameters (required). this bulk operation is essential for large-scale data extraction.

Action Parameters

input_parameters
arrayRequired
robot_id
stringRequired
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Monitor

Description

This tool creates a new monitor for a specific robot in browse ai. it allows you to configure a monitor with a schedule (frequency and interval) for automatic execution, along with optional custom name and input parameters, enabling automated tracking of website changes.

Action Parameters

input_parameters
objectRequired
name
stringRequired
notify_on_screenshot_change
booleanRequired
notify_on_text_change
booleanRequired
robot_id
stringRequired
schedule
string
screenshot_notification_threshold
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Webhook

Description

This tool creates a new webhook for a browseai robot. webhooks are used to receive notifications when tasks are completed or data changes are detected. the webhook will be called with the task details when specific events occur. it is useful for: - setting up automated notifications for task completion - receiving real-time updates when changes are detected - integrating browseai with your own systems - automating workflows based on robot task results the webhook can be configured to trigger on different events: - task.completed: when a task is successfully completed - task.failed: when a task fails - changes.detected: when changes are detected during monitoring

Action Parameters

description
string
events
arrayDefaults to ['task.completed']
is_active
booleanDefaults to True
robot_id
stringRequired
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a specific monitor

Description

This tool allows users to delete a specific monitor from their browse ai account. it uses the delete method and requires a valid monitor id.

Action Parameters

monitor_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a specific task

Description

This tool allows you to delete a specific task in browseai by its task id. it is used for cleaning up completed or failed tasks, managing resources, and maintaining your task list.

Action Parameters

robot_id
stringRequired
task_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Robots List

Description

This tool retrieves a list of all robots under your account in browse ai. each robot represents an automated task that can be trained to perform various web operations like opening webpages, logging in, clicking buttons, filling forms, extracting data, and monitoring changes. it is useful for: - getting an overview of all your automated tasks - checking the status of your robots - retrieving robot ids for use with other api endpoints - monitoring when robots were last updated or created

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Robot Tasks

Description

This tool retrieves all tasks associated with a specific robot in browse ai. it provides a paginated list of tasks with their details including status, input parameters, captured data, screenshots, and lists. it is useful for: - monitoring task execution status - retrieving captured data and screenshots - analyzing task execution history - debugging robot performance

Action Parameters

limit
integer
offset
integer
robot_id
stringRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Task Details

Description

This tool retrieves detailed information about a specific task in browse ai by its task id. it returns comprehensive details including the task's status, execution results, associated metadata, timestamps, and configuration. it complements existing tools by providing an in-depth view of individual task execution, including metadata and error details if applicable.

Action Parameters

task_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Run Robot

Description

This tool allows you to trigger the execution of a browseai robot on demand. the tool will run a specified robot with the provided parameters and return the task details. it requires a robot id and optional input parameters (such as url, search term, or other parameters) to configure the robot's execution. it is useful for: - starting robot executions programmatically - automating data collection tasks - triggering robots with custom parameters - integrating robot execution in workflows

Action Parameters

input_parameters
object
robot_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired