[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install [email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

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 | checkElement | GET /browser/{browser_id}/check_element | Check if element exists or is visible BrowserApi | click | POST /browser/{browser_id}/click | Click element BrowserApi | closeBrowser | DELETE /browser/{browser_id}/close_browser | Close browser instance BrowserApi | consoleLogs | POST /browser/{browser_id}/console_logs | Console logs: get or clear BrowserApi | cookies | POST /browser/{browser_id}/cookies | Manage browser cookies BrowserApi | createBrowser | POST /browser/create_browser | Create browser instance with optional persistent profile BrowserApi | detectCoordinates | 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 | executeCdp | POST /browser/{browser_id}/execute_cdp | Execute a Chrome DevTools Protocol command BrowserApi | executeScript | POST /browser/{browser_id}/execute_script | Execute JavaScript BrowserApi | fillForm | POST /browser/{browser_id}/fill_form | Fill multiple form fields BrowserApi | getCdpEndpoint | GET /browser/{browser_id}/get_cdp_endpoint | Get Chrome DevTools Protocol WebSocket URL for direct CDP access BrowserApi | getContent | GET /browser/{browser_id}/get_content | Get page HTML BrowserApi | getElementData | GET /browser/{browser_id}/get_element_data | Get element text, attribute, or property BrowserApi | getUrl | GET /browser/{browser_id}/get_url | Get current URL BrowserApi | guiClick | POST /browser/{browser_id}/gui_click | GUI click by selector or coordinates with smart validation BrowserApi | guiClickXy | POST /browser/{browser_id}/gui_click_xy | MCP compatibility alias for coordinate-mode `gui_click` BrowserApi | guiHoverXy | POST /browser/{browser_id}/gui_hover_xy | GUI hover at coordinates BrowserApi | guiPressKeysXy | POST /browser/{browser_id}/gui_press_keys_xy | Press keys at coordinates (click to focus, then send keys) BrowserApi | guiTypeXy | 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 | navigateBrowser | POST /browser/{browser_id}/navigate | Navigate to URL BrowserApi | networkLogs | 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 | pressKeys | 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 | takeScreenshot | POST /browser/{browser_id}/screenshot | Take screenshot BrowserApi | typeText | POST /browser/{browser_id}/type | Type text into element BrowserApi | uploadFile | POST /browser/{browser_id}/upload_file | Upload file to input BrowserApi | waitElement | POST /browser/{browser_id}/wait_element | Wait for element to be visible or hidden BrowserApi | whatIsVisible | POST /browser/{browser_id}/what_is_visible | AI page analysis - what's visible HealthApi | healthCheck | GET /health/ | Check the health status of the browser pool HealthApi | prometheusMetrics | GET /health/metrics | Get Prometheus-style metrics for monitoring PoolApi | scalePool | POST /pool/scale | Scale the browser pool to a new maximum size PoolApi | shutdownServer | POST /pool/shutdown | Gracefully shutdown the browser pool server ProfilesApi | createProfile | POST /profiles/ | Create a new browser profile ProfilesApi | deleteProfile | DELETE /profiles/{profile_name} | Delete a browser profile ProfilesApi | getProfile | GET /profiles/{profile_name} | Get profile information ProfilesApi | listProfiles | 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.