AIBrowserAPI / README.md
simoncck's picture
Update README.md
89ac98b verified
|
raw
history blame
1.88 kB

title: AIBrowserAPI emoji: πŸ“Š colorFrom: red colorTo: purple sdk: docker pinned: false

Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

README.md header for Hugging Face Spaces


title: Browser Automation API emoji: 🌐 colorFrom: blue colorTo: purple sdk: docker pinned: false license: mit

Browser Automation API

A browser automation API server that provides REST endpoints for controlling web browsers programmatically. Similar to browser-use but hosted as a service.

Features

  • Create and manage browser sessions
  • Navigate to websites
  • Click elements
  • Type text into forms
  • Take screenshots
  • Execute JavaScript
  • Get page information

API Endpoints

  • POST /session/create - Create a new browser session
  • DELETE /session/{session_id} - Close a browser session
  • POST /session/{session_id}/navigate - Navigate to a URL
  • POST /session/{session_id}/click - Click an element
  • POST /session/{session_id}/type - Type text into an element
  • GET /session/{session_id}/screenshot - Take a screenshot
  • GET /session/{session_id}/page-info - Get page information
  • GET /session/{session_id}/execute-js - Execute JavaScript

Usage

  1. Create a session: POST /session/create
  2. Navigate to a page: POST /session/{session_id}/navigate
  3. Interact with elements using CSS selectors, XPath, etc.
  4. Take screenshots or get page info as needed
  5. Close the session when done

Example

import requests

# Create session
response = requests.post("https://your-space-url/session/create")
session_id = response.json()["session_id"]

# Navigate
requests.post(f"https://your-space-url/session/{session_id}/navigate", 
              json={"url": "https://example.com"})

# Take screenshot
screenshot = requests.get(f"https://your-space-url/session/{session_id}/screenshot")