curl -X POST "https://nunu.ai/api/v1/project/your-project-id/shared-steps" \
-H "X-Api-Key: YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"shared_step": {
"name": "Login Flow",
"steps_by_key": {
"1": {
"goal": "Open login screen",
"expected_results": [
{ "expected": "login fields are visible" }
],
"screenshots": 1,
"pause_game": false,
"performance_monitoring": false,
"hint_manual": []
}
},
"step_order": ["1"]
}
}'
{
"id": "ssc_abc123",
"project_id": "test",
"name": "Login Flow",
"version": 0,
"is_shared": true,
"created_at": null,
"created_by": null,
"steps_by_key": { "1": { "...": "..." } },
"step_order": ["1"]
}
Shared Steps
Create Shared Step
Create a new shared step collection.
POST
/
project
/
{projectId}
/
shared-steps
curl -X POST "https://nunu.ai/api/v1/project/your-project-id/shared-steps" \
-H "X-Api-Key: YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"shared_step": {
"name": "Login Flow",
"steps_by_key": {
"1": {
"goal": "Open login screen",
"expected_results": [
{ "expected": "login fields are visible" }
],
"screenshots": 1,
"pause_game": false,
"performance_monitoring": false,
"hint_manual": []
}
},
"step_order": ["1"]
}
}'
{
"id": "ssc_abc123",
"project_id": "test",
"name": "Login Flow",
"version": 0,
"is_shared": true,
"created_at": null,
"created_by": null,
"steps_by_key": { "1": { "...": "..." } },
"step_order": ["1"]
}
Permission Required:
project:edit-tests{ "type": "collection", "collection_id": "..." } item.
Request Body
object
required
Shared step definition
Show shared_step properties
Show shared_step properties
string
Optional ID. If omitted, a UUID is generated.
string
required
Collection name
object
required
Map of step key → step body. Same shape as in test cases. Use
expected_results for the step’s checks (a string, a list of strings, or
a list of { "expected": "..." } objects); the legacy single-string
finish_condition is still accepted and ignored when expected_results
is present.string[]
required
Ordered list of step keys
Response
Returns the newly created shared step with status201. Same shape as
Get Shared Step.
curl -X POST "https://nunu.ai/api/v1/project/your-project-id/shared-steps" \
-H "X-Api-Key: YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"shared_step": {
"name": "Login Flow",
"steps_by_key": {
"1": {
"goal": "Open login screen",
"expected_results": [
{ "expected": "login fields are visible" }
],
"screenshots": 1,
"pause_game": false,
"performance_monitoring": false,
"hint_manual": []
}
},
"step_order": ["1"]
}
}'
{
"id": "ssc_abc123",
"project_id": "test",
"name": "Login Flow",
"version": 0,
"is_shared": true,
"created_at": null,
"created_by": null,
"steps_by_key": { "1": { "...": "..." } },
"step_order": ["1"]
}
Authorizations
API key for authentication
Path Parameters
The project ID. You can copy it from the project settings page or the project URL in the dashboard.
Body
application/json
Show child attributes
Show child attributes