# Voices AI Live API

Control the real-time voice changer from your own scripts, bots and apps. Start and stop it, switch voices, create custom voices and follow every change as it happens, through a small REST API that runs on your computer.

- Base URL: `http://127.0.0.1:19470` (only reachable from the same computer, while the app is open)
- Authentication: `Authorization: Bearer <API key>`, key from Settings > Developer
- Format: JSON, plus a Server-Sent Events stream at `GET /v1/events`
- Describes Voices AI Live 2.11.0 and later

## Guides

- [Quickstart](https://docs.getvoices.ai/guides/quickstart.md): Turn on the local API, copy your key and switch voices from a script in a few minutes.
- [Authentication](https://docs.getvoices.ai/guides/authentication.md): Every request carries your API key as a Bearer token. Where to find it, how to send it and how to rotate it.
- [Errors](https://docs.getvoices.ai/guides/errors.md): Status codes the API returns, what each one means and how to recover.

## Endpoints

### Status

- `GET /v1/status`: [Get voice changer status](https://docs.getvoices.ai/reference/get-status.md)

### Events

- `GET /v1/events`: [Stream realtime events](https://docs.getvoices.ai/reference/stream-events.md)

### Control

- `POST /v1/start`: [Start the voice changer](https://docs.getvoices.ai/reference/start.md)
- `POST /v1/stop`: [Stop the voice changer](https://docs.getvoices.ai/reference/stop.md)

### Voice

- `GET /v1/voices`: [List available voices](https://docs.getvoices.ai/reference/list-voices.md)
- `POST /v1/voice`: [Select a voice](https://docs.getvoices.ai/reference/set-voice.md)

### Custom voices

- `GET /v1/custom-voices`: [List custom voices](https://docs.getvoices.ai/reference/list-custom-voices.md)
- `POST /v1/custom-voices`: [Create a custom voice](https://docs.getvoices.ai/reference/create-custom-voice.md)
- `DELETE /v1/custom-voices/{id}`: [Delete a custom voice](https://docs.getvoices.ai/reference/delete-custom-voice.md)

### Sounds

- `GET /v1/sounds`: [List the sounds on your boards](https://docs.getvoices.ai/reference/list-sounds.md)
- `POST /v1/sounds/{padId}/play`: [Play a sound](https://docs.getvoices.ai/reference/play-sound.md)
- `POST /v1/sounds/stop`: [Stop all sounds](https://docs.getvoices.ai/reference/stop-sounds.md)

### Quality

- `PUT /v1/quality`: [Set voice quality mode](https://docs.getvoices.ai/reference/set-quality.md)

### Monitor

- `PUT /v1/monitor`: [Toggle audio monitoring](https://docs.getvoices.ai/reference/set-monitor.md)
