Create 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"]
}

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

Create a new shared step collection in your project. Once created, the collection can be referenced from any verification test by adding a { "type": "collection", "collection_id": "..." } item.

Request Body

shared_step

object

required

Shared step definition

Show shared_step properties

shared_step.id

string

Optional ID. If omitted, a UUID is generated.

shared_step.name

string

required

Collection name

shared_step.steps_by_key

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.

shared_step.step_order

string[]

required

Ordered list of step keys

Response

Returns the newly created shared step with status 201. 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

X-Api-Key

string

header

required

API key for authentication

Path Parameters

projectId

string

required

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

Body

application/json

shared_step

object

required

Show child attributes

Response

Shared step created

string

project_id

string

name

string

version

integer

is_shared

boolean

created_at

string<date-time> | null

created_by

string | null

steps_by_key

object

step_order

string[]

Get Shared Step Update Shared Step

​Request Body

​Response

Authorizations

Path Parameters

Body

Response

Request Body

Response