runAppAutomateTest
Start an Espresso or XCUITest run on a TestingBot device for app automation, returning a run ID immediately so you can poll status and fetch results.
Instructions
Start an Espresso or XCUITest run on a TestingBot device. Returns immediately with the run ID — it does NOT wait for completion. Poll with getAppAutomateRunStatus, then fetch getAppAutomateRunResults. If the app needs a localhost / private-network backend, start a tunnel first (startTunnel): the run uses the account's newest running tunnel. On Android, point the app at a hostname that resolves to 127.0.0.1 on the tunnel's machine (e.g. myapp.localtest.me), not localhost, which Android never proxies.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"framework": "<framework>",
"projectId": "<projectId>"
},
"name": "runAppAutomateTest"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | A name for this test run, shown in the dashboard | |
| build | No | Build identifier to group runs | |
| locale | No | Locale for the run (e.g. "fr_FR") | |
| version | No | OS version (e.g. "14") | |
| packages | No | Espresso only: run only these packages | |
| timeZone | No | Time zone for the run (e.g. "Europe/Brussels") | |
| framework | Yes | Test framework | |
| projectId | Yes | Project ID returned by uploadAppAutomateApp | |
| deviceName | No | Device name, supports wildcards/regex (e.g. "Pixel 8", "iPhone 1[4-6]", "*"). Default: any device | |
| realDevice | No | Run on a physical device instead of an emulator/simulator | |
| testRunner | No | Espresso only: custom instrumentation runner | |
| annotations | No | Espresso only: run only tests with these annotations | |
| testClasses | No | Espresso only: run only these test classes (fully qualified) | |
| skipTestClasses | No | Espresso only: skip these test classes |