# Get a board run

`GET https://api.vidmoat.com/v1/storyboard-runs/{id}`

- Scope: `projects.read`
- Cost: Free

Each scene's run in a board run: status, outcome, review verdict and credits, the total spent, and the next unbuilt scene.

### Path parameters

- `id` (string, required): The boardRunId.

## Response

Returns `200`.

### Response fields

- `status` (enum): Where the board run is. One of `running`, `stopped`, `settled`.
- `scenes` (array): `{ sceneId, title, runId, status, outcome, review, credits }`.
- `creditsSpent` (integer): Net credits.

## Errors

Besides the errors any request can get ([authentication](https://developer.vidmoat.com/developer/docs/authentication#when-a-request-is-refused), [rate limits](https://developer.vidmoat.com/developer/docs/rate-limits)):

| Status | Code | When |
| --- | --- | --- |
| 404 | [`not_found`](https://developer.vidmoat.com/developer/docs/errors#not_found) | No such board run on this account. |

## Request examples

```bash curl
curl https://api.vidmoat.com/v1/storyboard-runs/$BOARD_RUN_ID \
  -H "Authorization: Bearer $VIDMOAT_KEY"
```

```js Node
const BOARD_RUN_ID = 'REPLACE_ME';

const res = await fetch(`https://api.vidmoat.com/v1/storyboard-runs/${BOARD_RUN_ID}`, {
  headers: {
    Authorization: `Bearer ${process.env.VIDMOAT_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(data.error?.message ?? `HTTP ${res.status}`);
console.log(data);
```

```python Python
import os
import requests

BOARD_RUN_ID = "REPLACE_ME"

res = requests.get(
    f"https://api.vidmoat.com/v1/storyboard-runs/{BOARD_RUN_ID}",
    headers={"Authorization": f"Bearer {os.environ['VIDMOAT_KEY']}"},
    timeout=60,
)
res.raise_for_status()
print(res.json())
```

---

Source: https://developer.vidmoat.com/developer/docs/api/projects/get-storyboard-run
Previous: [Build a storyboard](https://developer.vidmoat.com/developer/docs/api/projects/run-storyboard.md)
Next: [Stop a board run](https://developer.vidmoat.com/developer/docs/api/projects/stop-storyboard-run.md)
All documentation: https://developer.vidmoat.com/llms-full.txt