Skip to main content
GET
/
runs
/
{runId}
/
live
curl -X GET "https://nunu.ai/api/v1/runs/lkkg6t5612m/live?include_screenshot=true" \
  -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"
      }
    }
  ]
}

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: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
​
players
LivePlayer[]
required
Snapshot per player
curl -X GET "https://nunu.ai/api/v1/runs/lkkg6t5612m/live?include_screenshot=true" \
  -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}$

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