Skip to main content
GET
Authentication: Any authenticated API key
Retrieve the full body of a single test case, including its players, steps, and any referenced shared step collections.

Path Parameters

testId
string
required
The test ID (UUID)

Query Parameters

version
integer
Fetch a specific version of the test instead of the latest. Must be a positive integer.
include_shared_collection_steps
boolean
default:"true"
Whether shared step collections should be expanded inline. When false, shared collection items are returned without their steps_by_key / step_order (the caller can resolve them via Get Shared Step).

Response

The body is a TestCase object whose shape depends on test_type. All variants share the following base fields, and each variant adds its own players_by_key shape.
id
string
required
Test ID
project_id
string
required
Project the test belongs to
name
string
required
Test name
version
integer
required
Current version. Pass this back in the expected_version field when calling Update Test.
test_type
string
required
One of: verification, discovery, task
tags
string[]
required
Test tags
quarantined
boolean
required
Whether the test is quarantined
incident_auto_approve
boolean
required
Whether incidents on this test are auto-approved
source
string
required
How the test was authored: repository or bot
players_by_key
object
required
Map of player key → player definition. The shape inside each player depends on test_type. For verification tests, players carry an items_by_key / item_order describing each step or shared collection reference.
player_order
string[]
required
Ordered list of player keys
testrail
object
TestRail integration metadata, or null
min_seconds
integer
Test-level minimum runtime in seconds. Returned for discovery and task tests. verification tests have no minimum.
max_seconds
integer
Test-level maximum runtime in seconds. Returned for all test types.

Verification step shape

Each step item inside a verification player’s items_by_key has the following fields:
goal
string
required
The instructions for the step — what the agent should do.
expected_results
object[]
required
The list of independent checks the agent verifies for this step. Each entry is an object with an expected string (one observable outcome). A step can carry several atomic checks — one entry per check.
finish_condition
string
required
Legacy single-string rendering of the expected results, kept for backwards compatibility. On read it is always populated: a single result is returned verbatim, multiple results are joined as a numbered list ("1. …\n2. …"). Prefer expected_results; treat finish_condition as derived/read-only.
screenshots
integer
required
How many screenshots the agent captures per turn for this step.
pause_game
boolean
required
Whether the game is paused while the agent reasons about this step.
performance_monitoring
boolean
required
Whether performance monitoring is enabled for this step.
hint_manual
string[]
required
Optional hints that guide the agent through tricky situations.

Authorizations

X-Api-Key
string
header
required

API key for authentication

Path Parameters

testId
string<uuid>
required

The test ID (UUID)

projectId
string
required

The project ID. You can copy it from the project settings page or the project URL in the dashboard.

Query Parameters

version
integer

Specific version (positive integer)

Required range: x >= 1
include_shared_collection_steps
boolean
default:true

Whether shared collection steps are expanded inline

Response

Successful response

Full test case body. Shape varies by test_type (verification, discovery, task); see the docs page for the exact shape.

id
string<uuid>
project_id
string
name
string
version
integer
tags
string[]
incident_auto_approve
boolean
test_type
enum<string>
Available options:
verification,
discovery,
task
quarantined
boolean
testrail
object | null
source
enum<string>
Available options:
repository,
bot
min_seconds
integer

Test-level minimum runtime in seconds. Allowed for discovery and task only; sending this on a verification test is rejected with 400. Defaults when omitted: discovery=3600 (1h), task=0. Must be ≤ max_seconds (validated against the effective budget after defaults are applied).

Required range: 0 <= x <= 19800
max_seconds
integer

Test-level maximum runtime in seconds. Hard ceiling for any single run is 19800 (5.5h). Defaults when omitted: verification=19800 (5.5h), discovery=10800 (3h), task=19800 (5.5h).

Required range: 0 <= x <= 19800
players_by_key
object
player_order
string[]