curl -X GET "https://nunu.ai/api/v1/project/your-project-id/tests/a5060a07-d386-4269-98ce-b33fb894201e" \
-H "X-Api-Key: YOUR_API_TOKEN"
curl -X GET "https://nunu.ai/api/v1/project/your-project-id/tests/a5060a07-d386-4269-98ce-b33fb894201e?version=3" \
-H "X-Api-Key: YOUR_API_TOKEN"
{
"id": "a5060a07-d386-4269-98ce-b33fb894201e",
"project_id": "test",
"name": "Sanity smoke",
"version": 4,
"tags": ["smoke"],
"incident_auto_approve": false,
"test_type": "verification",
"quarantined": false,
"testrail": null,
"source": "repository",
"max_seconds": 19800,
"memory": null,
"players_by_key": {
"1": {
"name": "P1",
"agent_config_id": null,
"game_funcs_config_id": null,
"items_by_key": {
"1": {
"type": "step",
"goal": "Reach the main menu",
"expected_results": [
{ "expected": "the main menu is visible" },
{ "expected": "no loading spinner remains on screen" }
],
"finish_condition": "1. the main menu is visible\n2. no loading spinner remains on screen",
"screenshots": 1,
"pause_game": false,
"performance_monitoring": false,
"hint_manual": []
}
},
"item_order": ["1"]
}
},
"player_order": ["1"]
}
{
"error": "test not found"
}
Tests
Get Test
Retrieve a single test case, optionally by version.
GET
/
project
/
{projectId}
/
tests
/
{testId}
curl -X GET "https://nunu.ai/api/v1/project/your-project-id/tests/a5060a07-d386-4269-98ce-b33fb894201e" \
-H "X-Api-Key: YOUR_API_TOKEN"
curl -X GET "https://nunu.ai/api/v1/project/your-project-id/tests/a5060a07-d386-4269-98ce-b33fb894201e?version=3" \
-H "X-Api-Key: YOUR_API_TOKEN"
{
"id": "a5060a07-d386-4269-98ce-b33fb894201e",
"project_id": "test",
"name": "Sanity smoke",
"version": 4,
"tags": ["smoke"],
"incident_auto_approve": false,
"test_type": "verification",
"quarantined": false,
"testrail": null,
"source": "repository",
"max_seconds": 19800,
"memory": null,
"players_by_key": {
"1": {
"name": "P1",
"agent_config_id": null,
"game_funcs_config_id": null,
"items_by_key": {
"1": {
"type": "step",
"goal": "Reach the main menu",
"expected_results": [
{ "expected": "the main menu is visible" },
{ "expected": "no loading spinner remains on screen" }
],
"finish_condition": "1. the main menu is visible\n2. no loading spinner remains on screen",
"screenshots": 1,
"pause_game": false,
"performance_monitoring": false,
"hint_manual": []
}
},
"item_order": ["1"]
}
},
"player_order": ["1"]
}
{
"error": "test not found"
}
Authentication: Any authenticated API key
Path Parameters
string
required
The test ID (UUID)
Query Parameters
integer
Fetch a specific version of the test instead of the latest. Must be a
positive integer.
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 aTestCase object whose shape depends on test_type. All variants share the
following base fields, and each variant adds its own players_by_key shape.
string
required
Test ID
string
required
Project the test belongs to
string
required
Test name
integer
required
Current version. Pass this back in the
expected_version field when calling
Update Test.string
required
One of:
verification, discovery, taskstring[]
required
Test tags
boolean
required
Whether the test is quarantined
boolean
required
Whether incidents on this test are auto-approved
string
required
How the test was authored:
repository or botobject
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.string[]
required
Ordered list of player keys
object
TestRail integration metadata, or
nullinteger
Test-level minimum runtime in seconds. Returned for
discovery and task
tests. verification tests have no minimum.integer
Test-level maximum runtime in seconds. Returned for all test types.
string
Test-level memory override:
disabled, read_only, or read_write. null
means “auto” — the test inherits the project’s default memory setting. Always
present on reads. See Create Test.Verification step shape
Eachstep item inside a verification player’s items_by_key has the
following fields:
string
required
The instructions for the step — what the agent should do.
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.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.integer
required
How many screenshots the agent captures per turn for this step.
boolean
required
Whether the game is paused while the agent reasons about this step.
boolean
required
Whether performance monitoring is enabled for this step.
string[]
required
Optional hints that guide the agent through tricky situations.
curl -X GET "https://nunu.ai/api/v1/project/your-project-id/tests/a5060a07-d386-4269-98ce-b33fb894201e" \
-H "X-Api-Key: YOUR_API_TOKEN"
curl -X GET "https://nunu.ai/api/v1/project/your-project-id/tests/a5060a07-d386-4269-98ce-b33fb894201e?version=3" \
-H "X-Api-Key: YOUR_API_TOKEN"
{
"id": "a5060a07-d386-4269-98ce-b33fb894201e",
"project_id": "test",
"name": "Sanity smoke",
"version": 4,
"tags": ["smoke"],
"incident_auto_approve": false,
"test_type": "verification",
"quarantined": false,
"testrail": null,
"source": "repository",
"max_seconds": 19800,
"memory": null,
"players_by_key": {
"1": {
"name": "P1",
"agent_config_id": null,
"game_funcs_config_id": null,
"items_by_key": {
"1": {
"type": "step",
"goal": "Reach the main menu",
"expected_results": [
{ "expected": "the main menu is visible" },
{ "expected": "no loading spinner remains on screen" }
],
"finish_condition": "1. the main menu is visible\n2. no loading spinner remains on screen",
"screenshots": 1,
"pause_game": false,
"performance_monitoring": false,
"hint_manual": []
}
},
"item_order": ["1"]
}
},
"player_order": ["1"]
}
{
"error": "test not found"
}
Authorizations
API key for authentication
Path Parameters
The test ID (UUID)
The project ID. You can copy it from the project settings page or the project URL in the dashboard.
Query Parameters
Specific version (positive integer)
Required range:
x >= 1Whether 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.
Available options:
verification, discovery, task Available options:
repository, bot 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 <= 19800Test-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 <= 19800Test-level memory override. null or omitted means "auto" — inherit the project's default memory setting. disabled turns memory off for this test; read_write lets the agent read and write memory files across runs. Requires the project's knowledge feature to be enabled. Applies to all test types. On read it is always present (null = auto); on a patch, omit it to leave it unchanged.
Available options:
disabled, read_only, read_write