Skip to main content
GET
/
tests
/
{testId}
curl -X GET "https://nunu.ai/api/v1/tests/a5060a07-d386-4269-98ce-b33fb894201e" \
  -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",
  "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",
          "finish_condition": "main menu is visible",
          "min_seconds": 0,
          "max_seconds": 60,
          "screenshots": 1,
          "pause_game": false,
          "performance_monitoring": false,
          "hint_manual": []
        }
      },
      "item_order": ["1"]
    }
  },
  "player_order": ["1"]
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.nunu.ai/llms.txt

Use this file to discover all available pages before exploring further.

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
curl -X GET "https://nunu.ai/api/v1/tests/a5060a07-d386-4269-98ce-b33fb894201e" \
  -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",
  "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",
          "finish_condition": "main menu is visible",
          "min_seconds": 0,
          "max_seconds": 60,
          "screenshots": 1,
          "pause_game": false,
          "performance_monitoring": false,
          "hint_manual": []
        }
      },
      "item_order": ["1"]
    }
  },
  "player_order": ["1"]
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication

Path Parameters

​
testId
string<uuid>
required

The test ID (UUID)

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
​
source
enum<string>
Available options:
repository,
bot
​
players_by_key
object
​
player_order
string[]