VIvieneu
Public API v1

List available voices

Changed on

Returns the voices an administrator has activated in the catalog (kind:"catalog"). Authentication is optional: when you send your API key, the response ALSO includes your own saved cloned voices (kind:"cloned", ids like clone_…) — create them in the web Studio at https://vieneu.io/#/clone (cloning is not available through the API), then pass the id as voiceId to POST /v1/tts or POST /v1/tts/stream. Each voice carries the engine it renders on — a voice is only usable on that engine, cloned voices included (a clone is enrolled for one engine at creation). Pass ?engine=v4 to list one engine only; omitting it lists every engine the server renders on. V3 was retired on 2026-09-24: its voices are no longer listed and ?engine=v3 is a 400.

get/api/v1/voices

Request

  • Base URL
    https://api.vieneu.io
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer
    • or none

Query parameters

engine'v4'

Return only the voices available on this engine.

Response

The catalogue, plus your own cloned voices when an API key is sent.

countnumber required

Number of voices in voices.

errorstring

Present only when the catalogue could not be read. The response is still 200 with an empty list — treat a non-empty error as "retry", not as "no voices".

Example response

{
  "voices": [
    {
      "id": "Ngọc Lan",
      "description": "Giọng nữ miền Nam, ấm và rõ.",
      "name": "Ngọc Lan",
      "gender": "female",
      "region": "south",
      "engine": "v4",
      "kind": "catalog"
    }
  ],
  "count": 42,
  "error": "Could not fetch voices"
}

Changes

  • cfba8f835c4fRevision changes
    • breaking

      removed the enum value v3 from the query request parameter engine

    • info

      removed the v3 enum value from the // response property for the response status

  • 98838c7c0e72Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status