Airbrowser API
Project description
airbrowser-client
Undetectable Chrome-in-Docker for developers and agents (REST + MCP)
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0
- Package version: 1.1.8
- Generator version: 7.19.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.9+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/ifokeev/airbrowser-mcp.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/ifokeev/airbrowser-mcp.git)
Then import the package:
import airbrowser_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import airbrowser_client
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import airbrowser_client
from airbrowser_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airbrowser_client.Configuration(
host = "/api/v1"
)
# Enter a context with an instance of the API client
with airbrowser_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = airbrowser_client.BrowserApi(api_client)
browser_id = 'browser_id_example' # str | Unique browser identifier
payload = airbrowser_client.CheckElementRequest() # CheckElementRequest |
try:
# Check if element exists or is visible
api_response = api_instance.check_element(browser_id, payload)
print("The response of BrowserApi->check_element:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling BrowserApi->check_element: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to /api/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| BrowserApi | check_element | POST /browser/{browser_id}/check_element | Check if element exists or is visible |
| BrowserApi | click | POST /browser/{browser_id}/click | Click element |
| BrowserApi | close_all_browsers | POST /browser/close_all | Close all active browser instances |
| BrowserApi | close_browser | POST /browser/{browser_id}/close | Close a browser instance |
| BrowserApi | console_logs | POST /browser/{browser_id}/console | Get or clear console logs |
| BrowserApi | create_browser | POST /browser/create | Create a new browser instance |
| BrowserApi | delete_browser | DELETE /browser/{browser_id} | Close and remove a browser instance |
| BrowserApi | detect_coordinates | POST /browser/{browser_id}/detect_coordinates | Detect element coordinates using AI vision |
| BrowserApi | dialog | POST /browser/{browser_id}/dialog | Manage browser dialogs: get, accept, or dismiss |
| BrowserApi | emulate | POST /browser/{browser_id}/emulate | Manage device emulation: set, clear, or list_devices |
| BrowserApi | execute_script | POST /browser/{browser_id}/execute | Execute JavaScript |
| BrowserApi | fill_form | POST /browser/{browser_id}/fill_form | Fill multiple form fields |
| BrowserApi | get_browser | GET /browser/{browser_id} | Get browser instance details |
| BrowserApi | get_browser_status | GET /browser/{browser_id}/status | Get browser status |
| BrowserApi | get_content | GET /browser/{browser_id}/content | Get page HTML content |
| BrowserApi | get_element_data | POST /browser/{browser_id}/element_data | Get element text, attribute, or property |
| BrowserApi | get_pool_status | GET /browser/pool/status | Get browser pool status |
| BrowserApi | get_url | GET /browser/{browser_id}/url | Get current page URL |
| BrowserApi | gui_click | POST /browser/{browser_id}/gui_click | Click using selector or screen coordinates |
| BrowserApi | history | POST /browser/{browser_id}/history | Execute history action: back, forward, or refresh |
| BrowserApi | list_browsers | GET /browser/list | List all active browser instances |
| BrowserApi | mouse | POST /browser/{browser_id}/mouse | Mouse action: hover or drag |
| BrowserApi | navigate_browser | POST /browser/{browser_id}/navigate | Navigate to a URL |
| BrowserApi | network_logs | POST /browser/{browser_id}/network | Get or clear network logs |
| BrowserApi | performance | POST /browser/{browser_id}/performance | Manage performance: start_trace, stop_trace, metrics, or analyze |
| BrowserApi | press_keys | POST /browser/{browser_id}/press_keys | Press keys on an element |
| BrowserApi | resize | POST /browser/{browser_id}/resize | Resize viewport |
| BrowserApi | scroll | POST /browser/{browser_id}/scroll | Scroll to element/coordinates (absolute) or by delta (relative) |
| BrowserApi | select | POST /browser/{browser_id}/select | Select dropdown: select option or get options |
| BrowserApi | tabs | POST /browser/{browser_id}/tabs | Manage browser tabs: list, new, switch, close, or current |
| BrowserApi | take_screenshot | POST /browser/{browser_id}/screenshot | Take a screenshot |
| BrowserApi | take_snapshot | POST /browser/{browser_id}/snapshot | Take DOM/accessibility snapshot |
| BrowserApi | type_text | POST /browser/{browser_id}/type | Type text into an element |
| BrowserApi | upload_file | POST /browser/{browser_id}/upload_file | Upload a file |
| BrowserApi | wait_element | POST /browser/{browser_id}/wait_element | Wait for element to become visible or hidden |
| BrowserApi | what_is_visible | GET /browser/{browser_id}/what_is_visible | Analyze visible page content using AI |
| HealthApi | health_check | GET /health/ | Check the health status of the browser pool |
| HealthApi | prometheus_metrics | GET /health/metrics | Get Prometheus-style metrics for monitoring |
| PoolApi | scale_pool | POST /pool/scale | Scale the browser pool to a new maximum size |
| PoolApi | shutdown_server | POST /pool/shutdown | Gracefully shutdown the browser pool server |
| ProfilesApi | create_profile | POST /profiles/ | Create a new browser profile |
| ProfilesApi | delete_profile | DELETE /profiles/{profile_name} | Delete a browser profile |
| ProfilesApi | get_profile | GET /profiles/{profile_name} | Get profile information |
| ProfilesApi | list_profiles | GET /profiles/ | List all browser profiles |
Documentation For Models
- ActionResult
- AttributeResponse
- BaseResponse
- BrowserConfig
- BrowserCreated
- BrowserCreationData
- BrowserInfoResponse
- BrowserList
- BrowserListData
- CheckElementRequest
- ClickRequest
- CombinedDialogRequest
- CombinedEmulateRequest
- CombinedGuiClickRequest
- CombinedScrollRequest
- ConsoleLogsRequest
- ContentData
- ContentResponse
- CreateProfileRequest
- DetectCoordinatesRequest
- DetectCoordinatesResult
- ElementDataRequest
- ErrorResponse
- ExecuteData
- ExecuteRequest
- ExecuteResponse
- FillFormRequest
- FormField
- HealthStatus
- HistoryRequest
- LogsResponse
- MouseRequest
- NavigateRequest
- NetworkLogsRequest
- PerformanceRequest
- PoolScaled
- PoolStatusResponse
- PressKeysRequest
- ProfileInfo
- ProfileListData
- ProfileListResponse
- ProfileResponse
- ResizeRequest
- ScaleData
- ScalePool
- ScreenshotData
- ScreenshotResponse
- SelectRequest
- SnapshotRequest
- SuccessResponse
- TabsRequest
- TypeRequest
- UploadFileRequest
- UrlData
- UrlResponse
- WaitElementRequest
- WhatIsVisibleResult
Documentation For Authorization
Endpoints do not require authorization.
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file airbrowser_client-1.1.8.tar.gz.
File metadata
- Download URL: airbrowser_client-1.1.8.tar.gz
- Upload date:
- Size: 55.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
56edc32205cae67864bd8e219476538851a647a017abdb8ca068155d9fa7c266
|
|
| MD5 |
c3f5dff4e7c2a414e9f0352772254ce6
|
|
| BLAKE2b-256 |
14d7e3a6e0a3317a6392623b0387be9c7bc36613fb473eb50b8487c0bfcb3c33
|
File details
Details for the file airbrowser_client-1.1.8-py3-none-any.whl.
File metadata
- Download URL: airbrowser_client-1.1.8-py3-none-any.whl
- Upload date:
- Size: 119.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6b8475135a5c622599efba51958ef95048df1386723ce35795472fdf0edf0dd9
|
|
| MD5 |
02c76369e66da5236ad89a0824bfdc8d
|
|
| BLAKE2b-256 |
e44705c7345a598d94201cec35ab54b8f6e213661cd307714d97eaab17f6f6fb
|