# Fleet, agents, budget and recent crews in one answer.

> Shaped for the dashboard's home page.
> https://koi.dog/docs/api/overview/get-overview/

`GET /api/v1/overview` · Scope: `read`

`requestedWorkers`, `agents` and `fleet.vms` are three separate counts. Experimental: this route may change inside v1. No path or query parameters.

## Response.

200 OK: a JSON object. The example has placeholder values.

## Request.

```sh
curl https://app.koi.dog/api/v1/overview \
    -H "Authorization: Bearer $KOIDOG_API_KEY"
```

```js
const res = await fetch("https://app.koi.dog/api/v1/overview", {
  headers: {
    Authorization: `Bearer ${process.env.KOIDOG_API_KEY}`,
  },
});
console.log(await res.json());
```

```python
import os

import requests

r = requests.get(
    "https://app.koi.dog/api/v1/overview",
    headers={
        "Authorization": f"Bearer {os.environ['KOIDOG_API_KEY']}",
    },
)
r.raise_for_status()
print(r.json())
```

## Response example.

```json
{
  "fleet": {
    "nodes": { … },
    "slots": { … },
    "vms": { … }
  },
  "agents": { … },
  "requestedWorkers": 0,
  "budget": {
    "capUsd": 0,
    "spentUsd": 0,
    "reservedUsd": 0,
    "burnUsdPerHour": 0,
    "basis": "string"
  },
  "cloud": {
    "activeSandboxes": { … },
    "starts": { … },
    "walletUsd": 0,
    "nextStartUsd": 0,
    "readAt": "string",
    "error": "string"
  },
  "activeBase": "string",
  "crews": [],
  "projects": [],
  "pendingApprovals": 0,
  "features": []
}
```
