Device API
Files & Navigation
Clipboard access, file transfer, deep links, system panels, and volume control.
Clipboard operations, file transfer between local and device filesystems, app launching, and system panel control.
Clipboard
get_clipboard
Read the current device clipboard contents.
Clipboard contains: "user@example.com"set_clipboard
Write text to the device clipboard.
| Parameter | Type | Required | Description |
|---|---|---|---|
text | string | Yes | Text to place on clipboard |
Clipboard set to: "user@example.com"File Transfer
push_file
Upload a local file to the device filesystem.
| Parameter | Type | Required | Description |
|---|---|---|---|
localPath | string | Yes | Absolute local file path |
devicePath | string | Yes | Destination path on device (e.g. /sdcard/Download/test.json) |
File uploaded to /sdcard/Download/test-data.json (4.2 KB).pull_file
Download a file from the device to a local path.
| Parameter | Type | Required | Description |
|---|---|---|---|
devicePath | string | Yes | Path on the device |
localPath | string | Yes | Absolute local path to save the file |
Pulled /sdcard/Download/screenshot.png (128 KB) to /tmp/screenshot.pngNavigation
open_settings
Open the Android Settings app.
Settings app opened.open_chrome
Open Chrome, optionally navigating to a URL.
| Parameter | Type | Required | Description |
|---|---|---|---|
url | string | No | URL to navigate to |
Chrome opened at https://example.com.open_deep_link
Launch any URI — custom scheme deep links, HTTPS URLs, or intent URIs.
| Parameter | Type | Required | Description |
|---|---|---|---|
uri | string | Yes | URI to launch |
Deep link launched: myapp://checkout/cart/123System Panels
expand_settings
Open the quick settings panel.
Settings panel expanded.expand_notifications
Open the notification shade.
Notification panel expanded.collapse_panels
Dismiss all open system panels.
All panels collapsed.Volume
set_volume
Press volume up or down by one step.
| Parameter | Type | Required | Description |
|---|---|---|---|
direction | string | Yes | up or down |
Volume increased to 8/15.set_silent_mode
Toggle Do Not Disturb / silent mode.
| Parameter | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | true = silent mode on |
Silent mode enabled.