runMaestroTest
Start a Maestro test run on a TestingBot device and get the run ID immediately; poll its status and fetch results after completion.
Instructions
Start a Maestro test run on a TestingBot device. Returns immediately with the run ID — it does NOT wait for completion. Poll with getMaestroRunStatus, then fetch getMaestroRunResults once completed.
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": {
"projectId": "<projectId>",
"platformName": "<platformName>"
},
"name": "runMaestroTest"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| env | No | Environment variables passed to the Maestro flows | |
| name | No | A name for this test run, shown in the TestingBot dashboard | |
| version | No | OS version (e.g. "14") | |
| otherApps | No | Up to 4 companion app URLs (tb:// from uploadMaestroCompanionApp, or http(s)://) installed alongside the app under test | |
| projectId | Yes | Project ID returned by uploadMaestroApp | |
| 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 (required for .ipa apps) | |
| shardSplit | No | Split flows across this many parallel devices | |
| excludeTags | No | Skip flows with these Maestro tags | |
| includeTags | No | Only run flows with these Maestro tags | |
| platformName | Yes | Mobile platform to run on | |
| tunnelIdentifier | No | Identifier of a running TestingBot Tunnel (from startTunnel) for the app to reach localhost / private-network backends through. Without it the account's newest running tunnel, if any, is used. On Android, `localhost` / `127.0.0.1` never go through the tunnel: in flows and app config, use a hostname that resolves to 127.0.0.1 on the tunnel's machine instead, e.g. http://myapp.localtest.me:3000. |