Skip to main content
GET
/
shared-steps
/
{sharedStepId}
curl -X GET "https://nunu.ai/api/v1/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",
      "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"]
}

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 a single shared step collection, including the full body of every step.

​
Path Parameters

​
sharedStepId
string
required
The shared step collection ID

​
Query Parameters

​
version
integer
Fetch a specific version of the collection instead of the latest. Must be a positive integer.

​
Response

​
id
string
required
Shared step collection ID
​
project_id
string
required
Project the collection belongs to
​
name
string
required
Collection name
​
version
integer
required
Current version. Pass this back as expected_version when calling Update Shared Step.
​
is_shared
boolean
required
Always true for collections returned by this endpoint
​
created_at
string
ISO 8601 timestamp when the collection was created
​
created_by
string
Who created the collection
​
steps_by_key
object
required
Map of step key ("1", "2", …) → step body. Each step has the same shape used inside test cases (goal, finish_condition, min_seconds, max_seconds, screenshots, pause_game, performance_monitoring, hint_manual).
​
step_order
string[]
required
Ordered list of step keys
curl -X GET "https://nunu.ai/api/v1/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",
      "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"]
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication

Path Parameters

​
sharedStepId
string
required

Shared step collection ID

Query Parameters

​
version
integer

Specific version (positive integer)

Required range: x >= 1

Response

Successful response

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