Get Live

Status

Get voice changer status

get/v1/status

Returns the current state of the voice changer, the selected voice and, while it runs, the voice changer's delay (latencyMs). Call it again, or follow GET /v1/events, to see the latency change.

Responses

200Current status
  • statestringRequired

    Current state of the voice changer

    One ofidlestartingrunningstoppingerror
  • messagestringRequired
  • voiceIdstring or nullRequired

    Currently selected voice ID, or null if none selected

  • latencyMsinteger or nullRequired

    How far the changed voice lags behind your microphone, in milliseconds: the measured end-to-end delay, smoothed and rounded to 10 ms. Null while the voice changer isn't running. Delay your camera by this much (for example with a video delay filter in OBS) to keep it in sync with your voice.

401Invalid or missing API key
  • errorstringRequired

    Error message