Automation API

Android device automation

Text Input Actions

Actions

Keyboard input and clipboard operations

Access these methods through agent.actions. Type text, manage clipboard, and handle keyboard interactions.

writeText()

TypeScript
writeText(text: string): Promise<void>

Types text using keyboard input. The keyboard must be visible.

Parameters

NameTypeDescription
textstringText to type

Returns

Promise<void>Resolves when text is typed

Examples

TypeScript
await agent.actions.writeText("Hello World");

copyText()

TypeScript
copyText(text: string): Promise<void>

Copies the specified text to the system clipboard.

Parameters

NameTypeDescription
textstringText to copy to clipboard

Returns

Promise<void>Resolves when copy is complete

Examples

TypeScript
await agent.actions.copyText("Text to copy");

paste()

TypeScript
paste(): Promise<void>

Pastes content from the clipboard at the current cursor position.

Returns

Promise<void>Resolves when paste is complete

Examples

TypeScript
await agent.actions.paste();

reverseCopy()

TypeScript
reverseCopy(): Promise<{text: string, data?: any, files?: {uri: string, mimeType: string, name: string, dataBase64: string}[]}>

Gets the current clipboard content including text, data, and files.

Returns

{text, data?, files?}Clipboard content with text and optional binary data/files

Examples

TypeScript
const clipboard = await agent.actions.reverseCopy();
console.log(clipboard.text);
if (clipboard.files) {
console.log("Files:", clipboard.files.map(f => f.name));
}

hideKeyboard()

TypeScript
hideKeyboard(): Promise<void>

Hides the software keyboard if it's currently visible.

Returns

Promise<void>Resolves when keyboard is hidden

Examples

TypeScript
await agent.actions.hideKeyboard();

inputKey()

TypeScript
inputKey(keyCode: number, duration?: number, state?: "down" | "up" | null): Promise<void>

Sends a raw key event by Android KeyEvent code. Requires Android 13+ (SDK level 33+) and only works when the on-screen keyboard is visible.

Parameters

NameTypeDescription
keyCodenumberAndroid KeyEvent code (e.g., 66 for ENTER)
duration?numberPress duration in ms
state?"down" | "up" | null"down" for press, "up" for release, null for full press

Returns

Promise<void>Resolves when key event is sent

Examples

Press Enter
TypeScript
await agent.actions.inputKey(66);
Press and hold
TypeScript
await agent.actions.inputKey(66, 500, "down");

Note: inputKey() requires Android 13+ (SDK level 33+) and will only work when the on-screen keyboard is visible. Tap on an input field first to show the keyboard.