curl -X GET "https://nunu.ai/api/v1/project/your-project-id/shared-steps/ssc_login" \
-H "X-Api-Key: YOUR_API_TOKEN"
{
"id": "ssc_login",
"project_id": "test",
"name": "Login Flow",
"version": 2,
"is_shared": true,
"created_at": "2026-03-01T10:00:00.000000+00:00",
"created_by": "user@example.com",
"steps_by_key": {
"1": {
"test_step_id": "step_1",
"goal": "Open login screen",
"expected_results": [
{ "expected": "login fields are visible" }
],
"finish_condition": "login fields are visible",
"screenshots": 1,
"pause_game": false,
"performance_monitoring": false,
"hint_manual": []
}
},
"step_order": ["1"]
}
{
"error": "shared step not found"
}
Shared Steps
Get Shared Step
Retrieve a shared step collection, optionally by version.
GET
/
project
/
{projectId}
/
shared-steps
/
{sharedStepId}
curl -X GET "https://nunu.ai/api/v1/project/your-project-id/shared-steps/ssc_login" \
-H "X-Api-Key: YOUR_API_TOKEN"
{
"id": "ssc_login",
"project_id": "test",
"name": "Login Flow",
"version": 2,
"is_shared": true,
"created_at": "2026-03-01T10:00:00.000000+00:00",
"created_by": "user@example.com",
"steps_by_key": {
"1": {
"test_step_id": "step_1",
"goal": "Open login screen",
"expected_results": [
{ "expected": "login fields are visible" }
],
"finish_condition": "login fields are visible",
"screenshots": 1,
"pause_game": false,
"performance_monitoring": false,
"hint_manual": []
}
},
"step_order": ["1"]
}
{
"error": "shared step not found"
}
Authentication: Any authenticated API key
Path Parameters
string
required
The shared step collection ID
Query Parameters
integer
Fetch a specific version of the collection instead of the latest. Must be a
positive integer.
Response
string
required
Shared step collection ID
string
required
Project the collection belongs to
string
required
Collection name
integer
required
Current version. Pass this back as
expected_version when calling
Update Shared Step.boolean
required
Always
true for collections returned by this endpointstring
ISO 8601 timestamp when the collection was created
string
Who created the collection
object
required
Map of step key (
"1", "2", …) → step body. Each step has the same shape
used inside test cases (goal, expected_results, finish_condition,
screenshots, pause_game, performance_monitoring, hint_manual). See
Get Test → Verification step shape
for the field details — expected_results is the structured list of checks
and finish_condition is its legacy single-string rendering.string[]
required
Ordered list of step keys
curl -X GET "https://nunu.ai/api/v1/project/your-project-id/shared-steps/ssc_login" \
-H "X-Api-Key: YOUR_API_TOKEN"
{
"id": "ssc_login",
"project_id": "test",
"name": "Login Flow",
"version": 2,
"is_shared": true,
"created_at": "2026-03-01T10:00:00.000000+00:00",
"created_by": "user@example.com",
"steps_by_key": {
"1": {
"test_step_id": "step_1",
"goal": "Open login screen",
"expected_results": [
{ "expected": "login fields are visible" }
],
"finish_condition": "login fields are visible",
"screenshots": 1,
"pause_game": false,
"performance_monitoring": false,
"hint_manual": []
}
},
"step_order": ["1"]
}
{
"error": "shared step not found"
}
Authorizations
API key for authentication
Path Parameters
Shared step collection ID
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 >= 1