Browseai

Learn how to use Browseai with Composio

Overview

Enum

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

api_key
stringRequired
base_url
stringDefaults to https://api.browse.ai/v2/

Actions

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
object
error
successful
boolean

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
object
error
successful
boolean

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
object
error
successful
boolean

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
object
error
successful
boolean

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
object
error
successful
boolean

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
object
error
successful
boolean

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
array
error
successful
boolean

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
object
error
successful
boolean

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
object
error
successful
boolean