GET /v1/status
Get voice changer status
Returns the current state of the voice changer, including whether it is running and auto-pitch settings.
Responses
200- Current status401- Invalid or missing API key
Version 1.2.0
Base URL: http://127.0.0.1:19470
Local REST API for programmatic control of the Voices AI Live voice changer.
The API runs on 127.0.0.1 and is only accessible from the local machine.
Enable it in Settings > Developer inside the desktop app.
Query the current voice changer state
/v1/statusGet voice changer status
Returns the current state of the voice changer, including whether it is running and auto-pitch settings.
200 - Current status401 - Invalid or missing API keySubscribe to realtime voice changer events
/v1/eventsStream realtime events
Opens a Server-Sent Events stream. The first event is always a status
snapshot. Subsequent events are sent whenever voice changer status,
selected voice, quality mode, or monitoring changes.
Event names and payloads:
- status: the current engine status; the initial snapshot also includes
selected voice, quality mode, and monitoring state
- voice: { "voiceId": "elon_musk" }
- quality: { "mode": "adaptive" }
- monitoring: { "enabled": true }
A keepalive comment is sent every 15 seconds while no events occur, and
SSE clients are instructed to reconnect after two seconds if disconnected.
Browser clients should use streaming fetch so the Bearer authorization
header can be included; native EventSource cannot set that header.
200 - Realtime Server-Sent Events stream401 - Invalid or missing API keyStart and stop the voice changer
/v1/startStart the voice changer
Starts the voice changer using the currently configured audio devices and voice model.
If it is already running, this is a no-op that returns the current status.
200 - Voice changer started successfully400 - Failed to start (e.g. no audio devices configured)401 - Invalid or missing API key/v1/stopStop the voice changer
Stops the voice changer. If it is already stopped, returns the current status.
200 - Voice changer stopped successfully400 - Failed to stop401 - Invalid or missing API keySelect a voice model
/v1/voicesList available voices
Returns all voices available in the voice library.
200 - List of available voices401 - Invalid or missing API key/v1/voiceSelect a voice
Sets the active voice by its ID. Use GET /v1/voices to list available voice IDs.
If the voice model is not yet downloaded locally, it will be downloaded
automatically. This may take a few seconds on the first call for a given voice.
id string (required) - Voice ID from the voice library200 - Voice set successfully400 - Failed to download or apply voice model401 - Invalid or missing API key403 - Voice requires an active subscription404 - Voice ID not found in librarySelect the voice quality and latency profile
/v1/qualitySet voice quality mode
Sets the quality and latency profile used by the voice changer.
If the voice changer is running, its audio engine restarts briefly to
apply the new mode. If it is stopped, the mode is used on the next start.
mode string (required) - `adaptive` balances quality and latency automatically. `high-quality`
prioritizes detail. `low-latency` prioritizes responsiveness.
200 - Quality mode updated400 - Invalid mode or engine restart failed401 - Invalid or missing API keyDeprecated pitch-shift controls retained for pre-v2 compatibility
/v1/pitchSet pitch shift
Deprecated in Voices AI Live v2 and later. Pitch is managed by the
v2 inference pipeline and this endpoint is retained only for compatibility.
Sets the pitch shift in semitones. Valid range is -24 to +24.
Positive values shift the voice higher, negative values shift it lower.
The voice changer must be running.
value integer (required) - Pitch shift in semitones200 - Pitch shift updated400 - Invalid request or voice changer not running401 - Invalid or missing API key/v1/pitch/autoToggle auto pitch shift
Deprecated in Voices AI Live v2 and later. Pitch is managed by the
v2 inference pipeline and this endpoint is retained only for compatibility.
Enables or disables automatic pitch adjustment.
When enabled, the app automatically calculates the optimal pitch shift
based on your voice and the selected voice model.
enabled boolean (required) - Whether to enable automatic pitch adjustment200 - Auto pitch setting updated400 - Invalid request body401 - Invalid or missing API keyControl audio monitoring (hear yourself)
/v1/monitorToggle audio monitoring
Enables or disables audio monitoring (hear yourself).
Uses the monitor device configured in the desktop app settings.
The voice changer must be running.
enabled boolean (required) - Whether to enable audio monitoring200 - Monitor setting updated400 - Invalid request, no monitor device configured, or voice changer not running401 - Invalid or missing API key