Skip to main content
POST
Trigger a discovery run

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format

Path Parameters

projectId
string
required

Project ID or shortId

Body

application/json
goal
string
required

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.

Required string length: 8 - 2000
targetUrl
string<uri>

Optional URL to explore instead of the project's production URL. Web only.

platform
enum<string>

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

Available options:
web,
ios,
android
appId
string

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

deviceModel
enum<string>

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

Available options:
iphone,
ipad

Response

Discovery run queued successfully

status
enum<string>
required
Available options:
queued
runId
string<uuid>
required
projectId
string<uuid>
required
platform
enum<string>
required
Available options:
web,
ios,
android