Skip to main content
POST
/
shared-steps
curl -X POST "https://nunu.ai/api/v1/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",
          "finish_condition": "login fields are visible",
          "min_seconds": 0,
          "max_seconds": 30,
          "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"]
}

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.

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

Response

Returns the newly created shared step with status 201. Same shape as Get Shared Step.
curl -X POST "https://nunu.ai/api/v1/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",
          "finish_condition": "login fields are visible",
          "min_seconds": 0,
          "max_seconds": 30,
          "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

Body

application/json
shared_step
object
required

Response

Shared step created

id
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[]