Get Live Run Snapshot

curl -X GET "https://nunu.ai/api/v1/project/your-project-id/runs/lkkg6t5612m/live?include_screenshot=true" \
  -H "X-Api-Key: YOUR_API_TOKEN"

curl -X GET "https://nunu.ai/api/v1/project/your-project-id/runs/lkkg6t5612m/live?include_screenshot=false" \
  -H "X-Api-Key: YOUR_API_TOKEN"

{
  "multiplayer_run_id": "lkkg6t5612m",
  "state": "RUNNING",
  "test": {
    "id": "a5060a07-d386-4269-98ce-b33fb894201e",
    "name": "Sanity smoke"
  },
  "players": [
    {
      "player_number": 0,
      "composite_run_id": "lkkg6t5612m-1",
      "current_run_id": "run_abc123",
      "current_step": 4,
      "game_state": { "scene": "main_menu" },
      "screenshot": {
        "data": "iVBORw0KGgoAAAANSUhEUgAA...",
        "mimeType": "image/png",
        "encoding": "base64"
      },
      "last_agent_step": {
        "agent": "user-beholder",
        "step": 12,
        "save_data": { "reasoning": "navigated to main menu" },
        "start_time": "2026-04-01T09:55:01.000000+00:00"
      }
    }
  ]
}

GET

project

{projectId}

runs

{runId}

live

curl -X GET "https://nunu.ai/api/v1/project/your-project-id/runs/lkkg6t5612m/live?include_screenshot=true" \
  -H "X-Api-Key: YOUR_API_TOKEN"

curl -X GET "https://nunu.ai/api/v1/project/your-project-id/runs/lkkg6t5612m/live?include_screenshot=false" \
  -H "X-Api-Key: YOUR_API_TOKEN"

{
  "multiplayer_run_id": "lkkg6t5612m",
  "state": "RUNNING",
  "test": {
    "id": "a5060a07-d386-4269-98ce-b33fb894201e",
    "name": "Sanity smoke"
  },
  "players": [
    {
      "player_number": 0,
      "composite_run_id": "lkkg6t5612m-1",
      "current_run_id": "run_abc123",
      "current_step": 4,
      "game_state": { "scene": "main_menu" },
      "screenshot": {
        "data": "iVBORw0KGgoAAAANSUhEUgAA...",
        "mimeType": "image/png",
        "encoding": "base64"
      },
      "last_agent_step": {
        "agent": "user-beholder",
        "step": 12,
        "save_data": { "reasoning": "navigated to main menu" },
        "start_time": "2026-04-01T09:55:01.000000+00:00"
      }
    }
  ]
}

Permission Required: project:read-runs

Return a live snapshot of an active run: latest game state and (optionally) a screenshot per player, pulled from the newest beholder step. Useful for displaying real-time progress in a custom dashboard or for quick programmatic checks while a run is executing. For completed-run details, use Get Run.

Path Parameters

runId

string

required

The multiplayer run ID (12 lowercase alphanumeric characters)

Query Parameters

include_screenshot

boolean

default:"true"

Whether to include a base64-encoded screenshot per player. Set to false for a lighter-weight response.

Response

multiplayer_run_id

string

required

Run ID (echoes the path param)

state

string

required

Run state: initializing, running, or completed

test

object

required

The test that the run is executing

Show test properties

test.id

string

Test ID

test.name

string

Test name

players

LivePlayer[]

required

Snapshot per player

Show LivePlayer properties

player_number

integer

Player number (0-indexed)

composite_run_id

string

Composite run ID for this player

current_run_id

string

Currently executing inner run ID, or null

current_step

integer

Latest beholder step number, or null

game_state

object

Latest captured game state, or null

screenshot

object

Latest screenshot — { data, mimeType, encoding: "base64" } — or null if not available or include_screenshot=false

last_agent_step

object

Latest agent reasoning entry — { agent, step, save_data, start_time } — or null

curl -X GET "https://nunu.ai/api/v1/project/your-project-id/runs/lkkg6t5612m/live?include_screenshot=true" \
  -H "X-Api-Key: YOUR_API_TOKEN"

curl -X GET "https://nunu.ai/api/v1/project/your-project-id/runs/lkkg6t5612m/live?include_screenshot=false" \
  -H "X-Api-Key: YOUR_API_TOKEN"

{
  "multiplayer_run_id": "lkkg6t5612m",
  "state": "RUNNING",
  "test": {
    "id": "a5060a07-d386-4269-98ce-b33fb894201e",
    "name": "Sanity smoke"
  },
  "players": [
    {
      "player_number": 0,
      "composite_run_id": "lkkg6t5612m-1",
      "current_run_id": "run_abc123",
      "current_step": 4,
      "game_state": { "scene": "main_menu" },
      "screenshot": {
        "data": "iVBORw0KGgoAAAANSUhEUgAA...",
        "mimeType": "image/png",
        "encoding": "base64"
      },
      "last_agent_step": {
        "agent": "user-beholder",
        "step": 12,
        "save_data": { "reasoning": "navigated to main menu" },
        "start_time": "2026-04-01T09:55:01.000000+00:00"
      }
    }
  ]
}

Authorizations

X-Api-Key

string

header

required

API key for authentication

Path Parameters

runId

string

required

The multiplayer run ID (12 lowercase alphanumeric characters)

Pattern: ^[a-z0-9]{12}$

projectId

string

required

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

Query Parameters

include_screenshot

boolean

default:true

Whether to include per-player screenshots

Response

Live run snapshot

multiplayer_run_id

string

state

enum<string>

Available options:

initializing,

running,

completed

test

object

Show child attributes

players

object[]

Show child attributes

Get Run Details List Run Bugs

​Path Parameters

​Query Parameters

​Response

Authorizations

Path Parameters

Query Parameters

Response

Path Parameters

Query Parameters

Response