---
title: "Read Live Overlay"
method: GET
path: "/api/v1/sim-runs/{run_id}/live-overlay"
tags: ["simulated runs"]
---

# Read Live Overlay

`GET /api/v1/sim-runs/{run_id}/live-overlay`

## Request

- Base URL: `https://api.brumby.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.brumby.com/api/v1/sim-runs/{run_id}/live-overlay`
- Auth: HTTP bearer

## Path parameters

- `run_id` string, uuid, required

## Response `200`

Successful Response

- SimLiveOverlayResponse
  - `run_id` string, uuid, required
  - `observed_at` string, date-time, nullable, required
  - `origin` object, nullable, required
  - `cattle` SimLiveCattle[], required
    - `x` number, required
    - `y` number, required
    - `id` string, required
  - `path` SimLivePoint[], required
    - `x` number, required
    - `y` number, required
  - `scene_paths` SimLiveScenePath[]
    - `kind` 'planned' | 'scout' | 'frontier' | 'engaged' | 'loop' | 'press' | 'flight' | 'mob' | 'fence' | 'fov', required
    - `points` SimLivePoint[], required
      - `x` number, required
      - `y` number, required
    - `label` string, nullable
  - `scene_points` SimLiveScenePoint[]
    - `x` number, required
    - `y` number, required
    - `kind` 'goal' | 'target' | 'objective' | 'engaged' | 'filtered-cattle' | 'fov-corner', required
    - `label` string, nullable
    - `radius_m` number, nullable
  - `coverage_pct` number, nullable
  - `visited` SimLiveVisitedCell[]
    - `x` number, required
    - `y` number, required
    - `half_width` number, required
    - `half_height` number, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/brumby/apis/brumby-platform-api.md) - [All operations](https://skmtc.dev/brumby/apis/brumby-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/brumby/apis/brumby-platform-api/revisions/fe185e20813e?raw)