BrowserAI icon

BrowserAI

Interact with the BrowserAI API

Overview

The node interacts with the BrowserAI API to manage and control tasks related to browser automation. Specifically, the Stop Task operation allows users to send a command to stop a running task identified by its session ID.

This operation is useful in scenarios where an automated browser task needs to be halted before completion, such as stopping a web scraping job or terminating an automation script that is no longer needed or behaving unexpectedly.

Example use case:
You have a long-running browser automation task collecting data from a website. If you detect an issue or want to cancel the task early, you can use this node's Stop Task operation to send a stop command to the BrowserAI service, effectively halting the task execution.

Properties

Name Meaning
Session ID The unique identifier of the task session you want to stop.
Command The command to send to the task; currently only "Stop" is supported to halt the task.

Output

  • The output JSON contains the response from the BrowserAI API after sending the stop command.
  • This typically includes confirmation or status information about the stop request.
  • The node does not output binary data for this operation.

Dependencies

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

Troubleshooting

  • Common issues:

    • Missing or invalid Session ID will cause the API call to fail.
    • Incorrect or missing API key credential will result in authentication errors.
    • Network connectivity problems may prevent reaching the BrowserAI API endpoint.
  • Error messages:

    • "Unsupported operation": Occurs if an unsupported operation name is used.
    • API errors returned from BrowserAI (e.g., 401 Unauthorized) indicate credential or permission issues.
    • "Country is required to build geoLocation." is unrelated to Stop Task but may appear if other operations are misconfigured.
  • Resolutions:

    • Ensure the Session ID corresponds to an active task.
    • Verify the API key credential is correctly set up and has proper permissions.
    • Check network access to https://browser.ai/api/v1/.

Links and References

Discussion