BrowserAI icon

BrowserAI

Interact with the BrowserAI API
Join our community

Actions6

Overview

This node integrates with the BrowserAI API to manage and interact with tasks related to browser automation. It supports creating new tasks, creating saved tasks (templates), retrieving task metadata and results, stopping running tasks, and listing or fetching saved tasks by name.

The Create Task operation allows users to start a new automation task by specifying project details, geographic location, task type, and instructions for the automation actions. This is useful in scenarios such as web scraping, automated testing, or running scripted browser interactions tailored to specific locations or projects.

Practical example:
You want to automate data extraction from websites based on geographic parameters like country and city. Using this node, you can create a task that runs a crawler automation targeting a specific city, providing detailed instructions on what actions the browser should perform.

Properties

Name Meaning
Project The project identifier or name under which the task will be created.
Country The country part of the geographic location where the task should operate.
City The city part of the geographic location for the task.
Zipcode The postal code part of the geographic location for the task.
Task Type The type of task to create. Options: Crawler Automation, Script Automation.
Enable Inspection Boolean flag to enable or disable inspection mode during task execution.
Instructions A collection of instructions defining the actions the task should perform. Each instruction has an "Action" string describing a step.

Output

The node outputs an array of JSON objects, each representing the response from the BrowserAI API for the executed operation. For the Create Task operation, the output JSON contains details about the newly created task, including identifiers, status, and any relevant metadata returned by the API.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating requests to the BrowserAI API.
  • The node makes HTTP requests to https://browser.ai/api/v1/.
  • Proper configuration of the API key credential within n8n is necessary for successful operation.

Troubleshooting

  • Missing Country Error:
    If the Country property is not provided when creating a task, the node throws an error stating that "Country is required to build geoLocation." Ensure that the country field is filled in.

  • Unsupported Operation:
    If an unsupported operation is selected, the node will throw an error indicating the operation is not supported. Verify that the operation name matches one of the supported options.

  • Authentication Errors:
    If the API key is invalid or missing, requests will fail. Confirm that the API key credential is correctly set up and valid.

  • Invalid Instructions Format:
    Instructions must be provided as an array of objects each containing an "action" string. Incorrect formatting may cause the API request to fail.

Links and References

Discussion