DOCS
Write tests

Test options

Every setting a test has, with the values the app, the API and MCP accept.

In the app#

The options line under a plan ("Desktop · 15 min limit · video on · trackers blocked") opens them with Change. In a plain-text test, Show options.

OptionAPI nameValuesDefault
Screendevicedesktop (1280 × 800), tablet (820 × 1180), mobile (412 × 914)desktop
Time limit (minutes)timeoutMinutes2 to 2015
Record a review videorecordVideotrue, falsetrue
Ads and trackerstrackersblock, allow (websites)block
Sign-in accountscredentialsnames of the project's accountsnone
Mailbox, phone number, endpointsservicesemail, sms, call, httpnone
Two phonesdevices1, 2 (apps: when the test involves a second person on their own device)1
Platformplatformweb, android, iosweb
AppappIdpackage name or bundle id
BuildbuildIda build id (ab_…) to always use; empty uses the app's newestnewest
Build linkbuildUrlan https link to the .apk or zipped .app, downloaded on every run

Blocking ads and trackers makes runs faster and steadier; allow them when your test is about them. Every run stops by 20 minutes whatever the limit.

Over the API and MCP#

Pass options to create a test or update one. platform, appId, buildId, device and credentials can also be given at the top level. Updating replaces the options as a whole, so read them with get_test first.

options
{ "device": "mobile", "timeoutMinutes": 10, "recordVideo": true, "services": ["email"], "credentials": ["customer"] }