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.15.0
- Generator version: 7.22.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)
payload = airbrowser_client.BrowsersRequest() # BrowsersRequest |
try:
# Admin: list all, get info, or close all browsers
api_response = api_instance.browsers(payload)
print("The response of BrowserApi->browsers:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling BrowserApi->browsers: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to /api/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| BrowserApi | browsers | POST /browser/browsers | Admin: list all, get info, or close all browsers |
| BrowserApi | check_element | GET /browser/{browser_id}/check_element | Check if element exists or is visible |
| BrowserApi | click | POST /browser/{browser_id}/click | Click element |
| BrowserApi | close_browser | DELETE /browser/{browser_id}/close_browser | Close browser instance |
| BrowserApi | console_logs | POST /browser/{browser_id}/console_logs | Console logs: get or clear |
| BrowserApi | cookies | POST /browser/{browser_id}/cookies | Manage browser cookies |
| BrowserApi | create_browser | POST /browser/create_browser | Create browser instance with optional persistent profile |
| BrowserApi | detect_coordinates | POST /browser/{browser_id}/detect_coordinates | Detect element coordinates using vision with optional smart targeting |
| BrowserApi | dialog | POST /browser/{browser_id}/dialog | Dialogs: get, accept, dismiss |
| BrowserApi | emulate | POST /browser/{browser_id}/emulate | Emulation: set, clear, list_devices |
| BrowserApi | execute_cdp | POST /browser/{browser_id}/execute_cdp | Execute a Chrome DevTools Protocol command |
| BrowserApi | execute_script | POST /browser/{browser_id}/execute_script | Execute JavaScript |
| BrowserApi | fill_form | POST /browser/{browser_id}/fill_form | Fill multiple form fields |
| BrowserApi | get_cdp_endpoint | GET /browser/{browser_id}/get_cdp_endpoint | Get Chrome DevTools Protocol WebSocket URL for direct CDP access |
| BrowserApi | get_content | GET /browser/{browser_id}/get_content | Get page HTML |
| BrowserApi | get_element_data | GET /browser/{browser_id}/get_element_data | Get element text, attribute, or property |
| BrowserApi | get_url | GET /browser/{browser_id}/get_url | Get current URL |
| BrowserApi | gui_click | POST /browser/{browser_id}/gui_click | GUI click by selector or coordinates with smart validation |
| BrowserApi | gui_click_xy | POST /browser/{browser_id}/gui_click_xy | MCP compatibility alias for coordinate-mode `gui_click` |
| BrowserApi | gui_hover_xy | POST /browser/{browser_id}/gui_hover_xy | GUI hover at coordinates |
| BrowserApi | gui_press_keys_xy | POST /browser/{browser_id}/gui_press_keys_xy | Press keys at coordinates (click to focus, then send keys) |
| BrowserApi | gui_type_xy | POST /browser/{browser_id}/gui_type_xy | GUI type at coordinates - clicks then types text |
| BrowserApi | history | POST /browser/{browser_id}/history | History: back, forward, or refresh |
| BrowserApi | mouse | POST /browser/{browser_id}/mouse | Mouse: hover or drag |
| BrowserApi | navigate_browser | POST /browser/{browser_id}/navigate | Navigate to URL |
| BrowserApi | network_logs | POST /browser/{browser_id}/network_logs | Network logs: get or clear |
| BrowserApi | performance | POST /browser/{browser_id}/performance | Performance: start_trace, stop_trace, metrics, analyze |
| BrowserApi | press_keys | POST /browser/{browser_id}/press_keys | Press keyboard keys |
| BrowserApi | resize | POST /browser/{browser_id}/resize | Resize viewport |
| BrowserApi | scroll | POST /browser/{browser_id}/scroll | Scroll to element/coords or by delta |
| BrowserApi | select | POST /browser/{browser_id}/select | Select dropdown: select option or get options |
| BrowserApi | snapshot | POST /browser/{browser_id}/snapshot | DOM or accessibility snapshot |
| BrowserApi | tabs | POST /browser/{browser_id}/tabs | Tabs: list, new, switch, close, current |
| BrowserApi | take_screenshot | POST /browser/{browser_id}/screenshot | Take screenshot |
| BrowserApi | type_text | POST /browser/{browser_id}/type | Type text into element |
| BrowserApi | upload_file | POST /browser/{browser_id}/upload_file | Upload file to input |
| BrowserApi | wait_element | POST /browser/{browser_id}/wait_element | Wait for element to be visible or hidden |
| BrowserApi | what_is_visible | POST /browser/{browser_id}/what_is_visible | AI page analysis - what's visible |
| 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
- BaseResponse
- BrowsersRequest
- ClickRequest
- ConsoleLogsRequest
- CookiesRequest
- CreateBrowserRequest
- CreateProfileRequest
- DetectCoordinatesData
- DetectCoordinatesRequest
- DetectCoordinatesResult
- DialogRequest
- EmulateRequest
- ErrorResponse
- ExecuteCdpRequest
- ExecuteScriptRequest
- FillFormRequest
- GenericResponse
- GuiClickData
- GuiClickRequest
- GuiClickResult
- GuiClickXYRequest
- GuiHoverXyRequest
- GuiPressKeysXyRequest
- GuiTypeXyRequest
- HealthStatus
- HistoryRequest
- MouseRequest
- NavigateBrowserRequest
- NetworkLogsRequest
- PerformanceRequest
- PoolScaled
- PressKeysRequest
- ProfileInfo
- ProfileListData
- ProfileListResponse
- ProfileResponse
- ResizeRequest
- ScaleData
- ScalePool
- ScrollRequest
- SelectRequest
- SnapshotRequest
- TabsRequest
- TakeScreenshotRequest
- TypeTextRequest
- UploadFileRequest
- WaitElementRequest
- WhatIsVisibleRequest
Documentation For Authorization
Endpoints do not require authorization.
Author
Metadata
Release files for airbrowser-client 1.15.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| airbrowser_client-1.15.0.tar.gz | 56.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| airbrowser_client-1.15.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 164.8 kB
Release files / airbrowser_client-1.15.0.tar.gz
| Download URL | airbrowser_client-1.15.0.tar.gz |
|---|---|
| Size | 56.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d9402517792837c733aa2227a49ac71aefcb42ef2aaf0fe53d1c07d83589c46
|
|
BLAKE2b-256 checksum How to use checksums |
1ccd66f5594fa3b5c758329b3cb905c8fca947692a814e12f059b06feed69187
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
Release files / airbrowser_client-1.15.0-py3-none-any.whl
| Download URL | airbrowser_client-1.15.0-py3-none-any.whl |
|---|---|
| Size | 108.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
806b39f083a98f48abfe0f8b1a3c29820aba9054c91888e5f30b724ceefb9587
|
|
BLAKE2b-256 checksum How to use checksums |
f5d683d514543838fe9788626c7c49124d6fa5ea5dd9c0b0cb36e6d93104b17e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|