Metadata-Version: 2.4
Name: airbrowser_client
Version: 1.2.4
Summary: Airbrowser API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/ifokeev/airbrowser-mcp
Keywords: OpenAPI,OpenAPI-Generator,Airbrowser API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# airbrowser-client
Undetectable Chrome-in-Docker for developers and agents (REST + MCP)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 1.2.4
- 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:

```sh
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:
```python
import airbrowser_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import airbrowser_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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**](docs/BrowserApi.md#check_element) | **POST** /browser/{browser_id}/check_element | Check if element exists or is visible
*BrowserApi* | [**click**](docs/BrowserApi.md#click) | **POST** /browser/{browser_id}/click | Click element
*BrowserApi* | [**close_all_browsers**](docs/BrowserApi.md#close_all_browsers) | **POST** /browser/close_all | Close all active browser instances
*BrowserApi* | [**close_browser**](docs/BrowserApi.md#close_browser) | **POST** /browser/{browser_id}/close | Close a browser instance
*BrowserApi* | [**console_logs**](docs/BrowserApi.md#console_logs) | **POST** /browser/{browser_id}/console | Get or clear console logs
*BrowserApi* | [**create_browser**](docs/BrowserApi.md#create_browser) | **POST** /browser/create | Create a new browser instance
*BrowserApi* | [**delete_browser**](docs/BrowserApi.md#delete_browser) | **DELETE** /browser/{browser_id} | Close and remove a browser instance
*BrowserApi* | [**detect_coordinates**](docs/BrowserApi.md#detect_coordinates) | **POST** /browser/{browser_id}/detect_coordinates | Detect element coordinates using AI vision
*BrowserApi* | [**dialog**](docs/BrowserApi.md#dialog) | **POST** /browser/{browser_id}/dialog | Manage browser dialogs: get, accept, or dismiss
*BrowserApi* | [**emulate**](docs/BrowserApi.md#emulate) | **POST** /browser/{browser_id}/emulate | Manage device emulation: set, clear, or list_devices
*BrowserApi* | [**execute_script**](docs/BrowserApi.md#execute_script) | **POST** /browser/{browser_id}/execute | Execute JavaScript
*BrowserApi* | [**fill_form**](docs/BrowserApi.md#fill_form) | **POST** /browser/{browser_id}/fill_form | Fill multiple form fields
*BrowserApi* | [**get_browser**](docs/BrowserApi.md#get_browser) | **GET** /browser/{browser_id} | Get browser instance details
*BrowserApi* | [**get_browser_status**](docs/BrowserApi.md#get_browser_status) | **GET** /browser/{browser_id}/status | Get browser status
*BrowserApi* | [**get_content**](docs/BrowserApi.md#get_content) | **GET** /browser/{browser_id}/content | Get page HTML content
*BrowserApi* | [**get_element_data**](docs/BrowserApi.md#get_element_data) | **POST** /browser/{browser_id}/element_data | Get element text, attribute, or property
*BrowserApi* | [**get_pool_status**](docs/BrowserApi.md#get_pool_status) | **GET** /browser/pool/status | Get browser pool status
*BrowserApi* | [**get_url**](docs/BrowserApi.md#get_url) | **GET** /browser/{browser_id}/url | Get current page URL
*BrowserApi* | [**gui_click**](docs/BrowserApi.md#gui_click) | **POST** /browser/{browser_id}/gui_click | Click using selector or screen coordinates
*BrowserApi* | [**history**](docs/BrowserApi.md#history) | **POST** /browser/{browser_id}/history | Execute history action: back, forward, or refresh
*BrowserApi* | [**list_browsers**](docs/BrowserApi.md#list_browsers) | **GET** /browser/list | List all active browser instances
*BrowserApi* | [**mouse**](docs/BrowserApi.md#mouse) | **POST** /browser/{browser_id}/mouse | Mouse action: hover or drag
*BrowserApi* | [**navigate_browser**](docs/BrowserApi.md#navigate_browser) | **POST** /browser/{browser_id}/navigate | Navigate to a URL
*BrowserApi* | [**network_logs**](docs/BrowserApi.md#network_logs) | **POST** /browser/{browser_id}/network | Get or clear network logs
*BrowserApi* | [**performance**](docs/BrowserApi.md#performance) | **POST** /browser/{browser_id}/performance | Manage performance: start_trace, stop_trace, metrics, or analyze
*BrowserApi* | [**press_keys**](docs/BrowserApi.md#press_keys) | **POST** /browser/{browser_id}/press_keys | Press keys on an element
*BrowserApi* | [**resize**](docs/BrowserApi.md#resize) | **POST** /browser/{browser_id}/resize | Resize viewport
*BrowserApi* | [**scroll**](docs/BrowserApi.md#scroll) | **POST** /browser/{browser_id}/scroll | Scroll to element/coordinates (absolute) or by delta (relative)
*BrowserApi* | [**select**](docs/BrowserApi.md#select) | **POST** /browser/{browser_id}/select | Select dropdown: select option or get options
*BrowserApi* | [**tabs**](docs/BrowserApi.md#tabs) | **POST** /browser/{browser_id}/tabs | Manage browser tabs: list, new, switch, close, or current
*BrowserApi* | [**take_screenshot**](docs/BrowserApi.md#take_screenshot) | **POST** /browser/{browser_id}/screenshot | Take a screenshot
*BrowserApi* | [**take_snapshot**](docs/BrowserApi.md#take_snapshot) | **POST** /browser/{browser_id}/snapshot | Take DOM/accessibility snapshot
*BrowserApi* | [**type_text**](docs/BrowserApi.md#type_text) | **POST** /browser/{browser_id}/type | Type text into an element
*BrowserApi* | [**upload_file**](docs/BrowserApi.md#upload_file) | **POST** /browser/{browser_id}/upload_file | Upload a file
*BrowserApi* | [**wait_element**](docs/BrowserApi.md#wait_element) | **POST** /browser/{browser_id}/wait_element | Wait for element to become visible or hidden
*BrowserApi* | [**what_is_visible**](docs/BrowserApi.md#what_is_visible) | **GET** /browser/{browser_id}/what_is_visible | Analyze visible page content using AI
*HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /health/ | Check the health status of the browser pool
*HealthApi* | [**prometheus_metrics**](docs/HealthApi.md#prometheus_metrics) | **GET** /health/metrics | Get Prometheus-style metrics for monitoring
*PoolApi* | [**scale_pool**](docs/PoolApi.md#scale_pool) | **POST** /pool/scale | Scale the browser pool to a new maximum size
*PoolApi* | [**shutdown_server**](docs/PoolApi.md#shutdown_server) | **POST** /pool/shutdown | Gracefully shutdown the browser pool server
*ProfilesApi* | [**create_profile**](docs/ProfilesApi.md#create_profile) | **POST** /profiles/ | Create a new browser profile
*ProfilesApi* | [**delete_profile**](docs/ProfilesApi.md#delete_profile) | **DELETE** /profiles/{profile_name} | Delete a browser profile
*ProfilesApi* | [**get_profile**](docs/ProfilesApi.md#get_profile) | **GET** /profiles/{profile_name} | Get profile information
*ProfilesApi* | [**list_profiles**](docs/ProfilesApi.md#list_profiles) | **GET** /profiles/ | List all browser profiles


## Documentation For Models

 - [ActionResult](docs/ActionResult.md)
 - [AttributeResponse](docs/AttributeResponse.md)
 - [BaseResponse](docs/BaseResponse.md)
 - [BrowserConfig](docs/BrowserConfig.md)
 - [BrowserCreated](docs/BrowserCreated.md)
 - [BrowserCreationData](docs/BrowserCreationData.md)
 - [BrowserInfoResponse](docs/BrowserInfoResponse.md)
 - [BrowserList](docs/BrowserList.md)
 - [BrowserListData](docs/BrowserListData.md)
 - [CheckElementRequest](docs/CheckElementRequest.md)
 - [ClickRequest](docs/ClickRequest.md)
 - [CombinedDialogRequest](docs/CombinedDialogRequest.md)
 - [CombinedEmulateRequest](docs/CombinedEmulateRequest.md)
 - [CombinedGuiClickRequest](docs/CombinedGuiClickRequest.md)
 - [CombinedScrollRequest](docs/CombinedScrollRequest.md)
 - [ConsoleLogsRequest](docs/ConsoleLogsRequest.md)
 - [ContentData](docs/ContentData.md)
 - [ContentResponse](docs/ContentResponse.md)
 - [CreateProfileRequest](docs/CreateProfileRequest.md)
 - [DetectCoordinatesRequest](docs/DetectCoordinatesRequest.md)
 - [DetectCoordinatesResult](docs/DetectCoordinatesResult.md)
 - [ElementDataRequest](docs/ElementDataRequest.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [ExecuteData](docs/ExecuteData.md)
 - [ExecuteRequest](docs/ExecuteRequest.md)
 - [ExecuteResponse](docs/ExecuteResponse.md)
 - [FillFormRequest](docs/FillFormRequest.md)
 - [FormField](docs/FormField.md)
 - [HealthStatus](docs/HealthStatus.md)
 - [HistoryRequest](docs/HistoryRequest.md)
 - [LogsResponse](docs/LogsResponse.md)
 - [MouseRequest](docs/MouseRequest.md)
 - [NavigateRequest](docs/NavigateRequest.md)
 - [NetworkLogsRequest](docs/NetworkLogsRequest.md)
 - [PerformanceRequest](docs/PerformanceRequest.md)
 - [PoolScaled](docs/PoolScaled.md)
 - [PoolStatusResponse](docs/PoolStatusResponse.md)
 - [PressKeysRequest](docs/PressKeysRequest.md)
 - [ProfileInfo](docs/ProfileInfo.md)
 - [ProfileListData](docs/ProfileListData.md)
 - [ProfileListResponse](docs/ProfileListResponse.md)
 - [ProfileResponse](docs/ProfileResponse.md)
 - [ResizeRequest](docs/ResizeRequest.md)
 - [ScaleData](docs/ScaleData.md)
 - [ScalePool](docs/ScalePool.md)
 - [ScreenshotData](docs/ScreenshotData.md)
 - [ScreenshotResponse](docs/ScreenshotResponse.md)
 - [SelectRequest](docs/SelectRequest.md)
 - [SnapshotRequest](docs/SnapshotRequest.md)
 - [SuccessResponse](docs/SuccessResponse.md)
 - [TabsRequest](docs/TabsRequest.md)
 - [TypeRequest](docs/TypeRequest.md)
 - [UploadFileRequest](docs/UploadFileRequest.md)
 - [UrlData](docs/UrlData.md)
 - [UrlResponse](docs/UrlResponse.md)
 - [WaitElementRequest](docs/WaitElementRequest.md)
 - [WhatIsVisibleResult](docs/WhatIsVisibleResult.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author




