Spaces:
No application file
No application file
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,10 +1,60 @@
|
|
|
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
colorTo: purple
|
| 6 |
sdk: docker
|
| 7 |
pinned: false
|
|
|
|
| 8 |
---
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# README.md header for Hugging Face Spaces
|
| 2 |
---
|
| 3 |
+
title: Browser Automation API
|
| 4 |
+
emoji: 🌐
|
| 5 |
+
colorFrom: blue
|
| 6 |
colorTo: purple
|
| 7 |
sdk: docker
|
| 8 |
pinned: false
|
| 9 |
+
license: mit
|
| 10 |
---
|
| 11 |
|
| 12 |
+
# Browser Automation API
|
| 13 |
+
|
| 14 |
+
A browser automation API server that provides REST endpoints for controlling web browsers programmatically. Similar to browser-use but hosted as a service.
|
| 15 |
+
|
| 16 |
+
## Features
|
| 17 |
+
|
| 18 |
+
- Create and manage browser sessions
|
| 19 |
+
- Navigate to websites
|
| 20 |
+
- Click elements
|
| 21 |
+
- Type text into forms
|
| 22 |
+
- Take screenshots
|
| 23 |
+
- Execute JavaScript
|
| 24 |
+
- Get page information
|
| 25 |
+
|
| 26 |
+
## API Endpoints
|
| 27 |
+
|
| 28 |
+
- `POST /session/create` - Create a new browser session
|
| 29 |
+
- `DELETE /session/{session_id}` - Close a browser session
|
| 30 |
+
- `POST /session/{session_id}/navigate` - Navigate to a URL
|
| 31 |
+
- `POST /session/{session_id}/click` - Click an element
|
| 32 |
+
- `POST /session/{session_id}/type` - Type text into an element
|
| 33 |
+
- `GET /session/{session_id}/screenshot` - Take a screenshot
|
| 34 |
+
- `GET /session/{session_id}/page-info` - Get page information
|
| 35 |
+
- `GET /session/{session_id}/execute-js` - Execute JavaScript
|
| 36 |
+
|
| 37 |
+
## Usage
|
| 38 |
+
|
| 39 |
+
1. Create a session: `POST /session/create`
|
| 40 |
+
2. Navigate to a page: `POST /session/{session_id}/navigate`
|
| 41 |
+
3. Interact with elements using CSS selectors, XPath, etc.
|
| 42 |
+
4. Take screenshots or get page info as needed
|
| 43 |
+
5. Close the session when done
|
| 44 |
+
|
| 45 |
+
## Example
|
| 46 |
+
|
| 47 |
+
```python
|
| 48 |
+
import requests
|
| 49 |
+
|
| 50 |
+
# Create session
|
| 51 |
+
response = requests.post("https://your-space-url/session/create")
|
| 52 |
+
session_id = response.json()["session_id"]
|
| 53 |
+
|
| 54 |
+
# Navigate
|
| 55 |
+
requests.post(f"https://your-space-url/session/{session_id}/navigate",
|
| 56 |
+
json={"url": "https://example.com"})
|
| 57 |
+
|
| 58 |
+
# Take screenshot
|
| 59 |
+
screenshot = requests.get(f"https://your-space-url/session/{session_id}/screenshot")
|
| 60 |
+
```
|