Trigger a discovery run

View as Markdown

Queue a free-roam discovery run: the QA agent gets only a goal, decides what to test itself, and reports every bug it finds. Supports web, iOS, and Android; mobile platforms explore the uploaded app. FAILED means bugs were found.

Authentication

AuthorizationBearer
API key authentication using Bearer token format

Path parameters

projectIdstringRequired
Project ID or shortId

Request

This endpoint expects an object.
goalstringRequired8-2000 characters

The exploration goal for the free-roam QA agent, e.g. “Explore the checkout flow and find bugs”. The agent decides what to test; there is no predefined step list.

targetUrlstringOptionalformat: "uri"
Optional URL to explore instead of the project's production URL. Web only.
platformenumOptional

Target platform; defaults to web. Mobile platforms explore the uploaded app.

appIdstringOptional
Uploaded mobile app ID to explore. Defaults to the project's latest app for the platform.
deviceModelenumOptional

Mobile device variant within the platform (e.g. ipad on iOS). Omit for the default phone-sized device.

Response

Discovery run queued successfully
statusenum
runIdstringformat: "uuid"
projectIdstringformat: "uuid"
platformenum

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
413
Content Too Large Error
429
Too Many Requests Error
500
Internal Server Error
504
Gateway Timeout Error