browseract-ai/browseract

⚠️ This repository has been deprecated

This repository is no longer maintained. It has been moved to a new location:

➡️ browser-act/browseract-api-examples

Please use the new repository for the latest code, bug fixes, and documentation.

This repository will remain available as a read-only archive.

---

BrowserAct API Demo Collection

AI Web Scraper & Automation - Any Site, No Code, Zero Limits, Reliable Data

This repository contains comprehensive API demo code for BrowserAct, an AI-powered web scraping and automation platform. The demos showcase how to integrate BrowserAct's AI-Workflow capabilities into your applications using multiple programming languages.

🚀 Quick Start

🎯 For New Users (Recommended)

Start with scenario-based examples that demonstrate complete workflows:

• Python: Scenarios-Python - Complete examples combining multiple APIs
  • scenario_1_run_and_wait.py - Run custom workflow and wait for completion
  • scenario_2_run_template_and_wait.py - Run template task and wait for completion (Best for beginners)
• Java: Scenarios-Java - Complete examples combining multiple APIs
  • Scenario1RunAndWait.java - Run custom workflow and wait for completion
  • Scenario2RunTemplateAndWait.java - Run template task and wait for completion
• Node.js: Scenarios-NodeJs - Complete examples combining multiple APIs
  • scenario1_runAndWait.js - Run custom workflow and wait for completion
  • scenario2_runTemplateAndWait.js - Run template task and wait for completion

📚 For API Reference

Choose your preferred language and explore individual API examples:

Language	Workflow API	Scenario Examples	Quick Start
Python	Workflow-Python	Scenarios-Python	python Scenarios-Python/scenario_1_run_and_wait.py
Java	Workflow-Java	Scenarios-Java	cd Scenarios-Java && mvn exec:java -Dexec.mainClass="com.browseract.scenarios.Scenario1RunAndWait"
Node.js	Workflow-NodeJs	Scenarios-NodeJs	node Scenarios-NodeJs/scenario1_runAndWait.js

📁 Project Structure

browseract-api-demos/
├── Workflow-Python/       # Python Workflow API demos
├── Workflow-Java/         # Java Workflow API demos
├── Workflow-NodeJs/       # Node.js Workflow API demos
├── Scenarios-Python/     # Python scenario-based examples (recommended for new users)
├── Scenarios-Java/        # Java scenario-based examples (recommended for new users)
├── Scenarios-NodeJs/      # Node.js scenario-based examples (recommended for new users)
├── .gitignore             # Git ignore rules
└── README.md              # This file

🎯 What is BrowserAct?

BrowserAct is an AI-powered web scraping and automation platform that provides two core capabilities:

🔄 AI-Workflow

• Predefined Templates: Use pre-built workflows for common scraping tasks
• Custom Workflows: Create your own automation sequences
• Batch Processing: Handle multiple URLs and data sources efficiently

📚 API Capabilities

Workflow API Endpoints

Endpoint	Method	Description
/v2/workflow/run-task	POST	Start a new workflow task
/v2/workflow/stop-task	PUT	Permanently terminate a task
/v2/workflow/get-task	GET	Get detailed task information
/v2/workflow/get-task-status	GET	Get task status only
/v2/workflow/list-tasks	GET	List all tasks
/v2/workflow/list-workflows	GET	List all workflows
/v2/workflow/get-workflow	GET	Get workflow details

🛠 Language Support

Python

• Version: Python 3.8+
• Dependencies: requests for HTTP requests
• Features: Simple, readable code with comprehensive error handling
• Best for: Quick prototyping and data science workflows

Java

• Version: Java 8+
• Build Tool: Maven
• Dependencies: Jackson for JSON processing, HttpURLConnection for HTTP requests
• Features: Enterprise-grade code with proper package structure
• Best for: Enterprise applications and microservices

Node.js

• Version: Node.js 14+
• Dependencies: Built-in https module
• Features: Lightweight, async-first approach
• Best for: Web applications and serverless functions

🔧 Configuration

Before running any examples, you'll need:

1. API Key: Get your API key from BrowserAct Integrations
2. Workflow ID (for Workflow API): Get your workflow ID from Workflow List

Update the configuration in each example file:

• Replace "app-abcdefghijklmn" with your actual API key
• Replace 1234567890 with your actual workflow ID

🔒 Security Best Practices

Important: The examples use placeholder API keys for demonstration purposes. In production:

1. Never hardcode API keys in your source code
2. Use environment variables or secure configuration files
3. Keep your API keys confidential and rotate them regularly

Environment Variable Examples

# Python
import os
authorization = os.getenv("BROWSERACT_API_KEY")

// Java
String authorization = System.getenv("BROWSERACT_API_KEY");

// Node.js
const authorization = process.env.BROWSERACT_API_KEY;

📖 Documentation

• API Documentation: BrowserAct API Docs
• Workflow API: Workflow API Reference

🤝 Support

• Discord Community: Join our Discord
• Email Support: [email protected]
• GitHub Issues: Report bugs or request features

📄 License

This demo code is provided as-is for educational and development purposes under the MIT License.

🌟 Features

• Multi-language Support: Python, Java, and Node.js implementations
• Complete API Coverage: All BrowserAct API endpoints included
• Production Ready: Enterprise-grade code with proper error handling
• Easy to Use: Simple examples that can be run immediately
• Well Documented: Comprehensive README files for each language
• Modern Standards: Follows best practices for each language

---

Ready to get started? Choose your language above and dive into the examples! 🚀

Visit BrowserAct to learn more about our AI-powered web scraping platform.