Skip to content

Commit ca0becd

Browse files
committed
add docs
1 parent 5846b53 commit ca0becd

File tree

2 files changed

+134
-1
lines changed

2 files changed

+134
-1
lines changed

docs/tools/community.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ description: 'AgentStack tools from community contributors'
1010

1111
[//]: # (- [Browserbase](/tools/tool/browserbase))
1212
- [Firecrawl](/tools/tool/firecrawl)
13+
- [Hyperbrowser](/tools/tool/hyperbrowser)
1314

1415
## Search
1516
- [Perplexity](/tools/tool/perplexity)
@@ -43,4 +44,4 @@ description: 'AgentStack tools from community contributors'
4344
>
4445
Default tools in AgentStack
4546
</Card>
46-
</CardGroup>
47+
</CardGroup>

docs/tools/tool/hyperbrowser.mdx

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
---
2+
title: Hyperbrowser
3+
description: AI-powered web browser automation and content extraction
4+
icon: browser
5+
---
6+
7+
## Description
8+
9+
Hyperbrowser enables your agents to interact with the web through powerful browser automation. This tool allows agents to extract content from webpages, crawl entire sites, extract structured data, and perform sophisticated browser automation tasks using multiple AI agent options.
10+
11+
## Example
12+
13+
Add the Hyperbrowser tool with
14+
15+
```bash
16+
agentstack tools add hyperbrowser
17+
```
18+
19+
Set up your environment variables:
20+
21+
```env
22+
HYPERBROWSER_API_KEY=your_api_key_here
23+
```
24+
25+
## Features
26+
27+
### Web Scraping
28+
29+
Extract content from individual webpages in various formats:
30+
31+
```python
32+
from agentstack._tools.hyperbrowser import scrape_webpage
33+
34+
result = scrape_webpage(
35+
url="https://example.com",
36+
use_proxy=True,
37+
formats=["markdown"] # Options: markdown, html, links, screenshot
38+
)
39+
```
40+
41+
### Website Crawling
42+
43+
Crawl entire websites and collect content from multiple pages:
44+
45+
```python
46+
from agentstack._tools.hyperbrowser import crawl_website
47+
48+
result = crawl_website(
49+
starting_url="https://example.com",
50+
max_pages=10,
51+
include_pattern=["/blog/*"],
52+
exclude_pattern=["/admin/*"],
53+
use_proxy=True
54+
)
55+
```
56+
57+
### Structured Data Extraction
58+
59+
Extract data in structured format based on a schema and prompt:
60+
61+
```python
62+
from agentstack._tools.hyperbrowser import extract_data_from_webpages
63+
64+
result = extract_data_from_webpages(
65+
urls=["https://example.com/product"],
66+
schema="{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"price\":{\"type\":\"string\"}}}",
67+
prompt="Extract the product name and price from this page",
68+
system_prompt="You are an expert at extracting product information",
69+
use_proxy=True
70+
)
71+
```
72+
73+
### Browser Use Agent
74+
75+
Run a fast, efficient browser automation agent for explicit instructions:
76+
77+
```python
78+
from agentstack._tools.hyperbrowser import run_browser_use_agent
79+
80+
result = run_browser_use_agent(
81+
task="Go to example.com and click on the first link",
82+
max_steps=10,
83+
use_vision=False,
84+
use_vision_for_planner=False,
85+
use_proxy=True
86+
)
87+
```
88+
89+
### Claude Computer Use Agent
90+
91+
Leverage Claude's advanced reasoning capabilities for complex web tasks:
92+
93+
```python
94+
from agentstack._tools.hyperbrowser import run_claude_computer_use_agent
95+
96+
result = run_claude_computer_use_agent(
97+
task="Research the top 3 AI frameworks and summarize their features",
98+
max_steps=20,
99+
use_vision=True,
100+
use_vision_for_planner=True,
101+
use_proxy=True
102+
)
103+
```
104+
105+
### OpenAI Computer Use Agent
106+
107+
Utilize OpenAI's balanced performance for general-purpose browser automation:
108+
109+
```python
110+
from agentstack._tools.hyperbrowser import run_openai_cua_agent
111+
112+
result = run_openai_cua_agent(
113+
task="Find the latest news on AI development",
114+
max_steps=15,
115+
use_vision=True,
116+
use_vision_for_planner=False,
117+
use_proxy=True
118+
)
119+
```
120+
121+
## Available Functions
122+
123+
The Hyperbrowser tool provides the following core functions:
124+
125+
- `scrape_webpage()`: Extract content from a single webpage in various formats
126+
- `crawl_website()`: Collect content from multiple pages across a website
127+
- `extract_data_from_webpages()`: Extract structured data from webpages based on a schema
128+
- `run_browser_use_agent()`: Fast, lightweight agent for explicit browser automation tasks
129+
- `run_claude_computer_use_agent()`: Claude-powered agent for complex reasoning tasks
130+
- `run_openai_cua_agent()`: OpenAI-powered agent for general-purpose browser automation
131+
132+
For detailed function parameters and usage, refer to the function docstrings in your IDE or the [Hyperbrowser documentation](https://docs.hyperbrowser.ai/).

0 commit comments

Comments
 (0)