# List the sounds on your boards

`GET http://127.0.0.1:19470/v1/sounds`

Returns your boards from the Sounds page with the pads on them: names,
pictures and pad IDs to play with `POST /v1/sounds/{padId}/play`. Only the
sounds on your boards are listed, and never their audio. A pad can also be
a voice: playing it switches to that voice. `isLocked` boards need a Live
subscription; on a free plan only the Starter board plays.

Authenticate with `Authorization: Bearer <API key>` (key from Settings > Developer in Voices AI Live).

## Responses

### 200: Your boards and their pads

- `boards` (array of SoundBoard, required)
  - `id` (string, required)
  - `name` (string, required)
  - `isLocked` (boolean, required): Needs a Live subscription to play
  - `pads` (array of SoundPad, required)
    - `id` (string, required): Pad ID for `POST /v1/sounds/{padId}/play`
    - `name` (string, required)
    - `imageUrl` (string or null, required): The sound's picture; your own sounds may have none
    - `loop` (boolean, required): Whether it loops until played again or stopped
    - `slot` (integer, required): Its place on the board's 5 × 3 grid, row by row

```json
{
  "boards": [
    {
      "id": "starter",
      "name": "Starter",
      "isLocked": false,
      "pads": [
        {
          "id": "pad_3f2a",
          "name": "Air horn",
          "imageUrl": "https://cdn.getvoices.ai/live-sounds/images/air-horn.webp",
          "loop": false,
          "slot": 0
        }
      ]
    }
  ]
}
```

### 401: Invalid or missing API key

- `error` (string, required): Error message

```json
{
  "error": "Invalid or missing API key"
}
```

### 504: The desktop app did not finish the request in time

- `ok` (boolean, required)
- `error` (string): Present only when `ok` is `false`

```json
{
  "ok": false,
  "error": "The desktop app did not respond in time. Keep it open and signed in."
}
```

## Examples

```bash
curl http://127.0.0.1:19470/v1/sounds \
  -H "Authorization: Bearer $VOICES_AI_API_KEY"
```

```javascript
const res = await fetch('http://127.0.0.1:19470/v1/sounds', {
  headers: {
    Authorization: `Bearer ${process.env.VOICES_AI_API_KEY}`,
  },
});
const data = await res.json();
```

```python
import os
import requests

res = requests.get(
    "http://127.0.0.1:19470/v1/sounds",
    headers={"Authorization": f"Bearer {os.environ['VOICES_AI_API_KEY']}"},
)
print(res.json())
```
