Optional
options: RequestOptionsClick
Optional
options: RequestOptionsDrag
Optional
options: RequestOptionsExtract data from the UI interface using a JSON schema.
Optional
options: RequestOptionsPerform a long press action at specified coordinates for a specified duration. Useful for triggering context menus, drag operations, or other long-press interactions.
Optional
options: RequestOptionsMove to position
Optional
options: RequestOptionsPress device buttons like power, volume, home, back, etc.
Optional
options: RequestOptionsSimulates pressing a specific key by triggering the complete keyboard key event chain (keydown, keypress, keyup). Use this to activate keyboard key event listeners such as shortcuts or form submissions.
Optional
options: RequestOptionsStart recording the box screen. Only one recording can be active at a time. If a recording is already in progress, starting a new recording will stop the previous one and keep only the latest recording.
Optional
options: RequestOptionsStop recording the box screen
Optional
options: RequestOptionsDisable the device's background screen rewind recording.
Optional
options: RequestOptionsEnable the device's background screen rewind recording.
Optional
options: RequestOptionsRewind and capture the device's background screen recording from a specified time period.
Optional
options: RequestOptionsGet the current structured screen layout information. This endpoint returns detailed structural information about the UI elements currently displayed on the screen, which can be used for UI automation, element analysis, and accessibility purposes. The format varies by box type: Android boxes return XML format with detailed UI hierarchy information including element bounds, text content, resource IDs, and properties, while other box types may return different structured formats.
Optional
options: RequestOptionsRotate the screen orientation. Note that even after rotating the screen, applications or system layouts may not automatically adapt to the gravity sensor changes, so visual changes may not always occur.
Optional
options: RequestOptionsTake screenshot
Optional
options: RequestOptionsPerforms a scroll action. Supports both advanced scroll with coordinates and simple scroll with direction.
Optional
options: RequestOptionsGet the box action settings
Optional
options: RequestOptionsReset the box settings to default
Optional
options: RequestOptionsUpdate the box action settings
Optional
options: RequestOptionsPerforms a swipe in the specified direction
Optional
options: RequestOptionsTap action for Android devices using ADB input tap command
Optional
options: RequestOptionsTouch
Optional
options: RequestOptionsDirectly inputs text content without triggering physical key events (keydown, etc.), ideal for quickly filling large amounts of text when intermediate input events aren't needed.
Optional
options: RequestOptions
Use natural language instructions to perform UI operations on the box. The endpoint will stream progress events before and after the action is executed. If you don't need intermediate events, set stream to false.