Public API v1

List available voices

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 with POST /v1/voices, 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=v3 (or v4) to list one engine only; omitting it lists every engine.

get/api/v1/voices

Query parameters

engine'v3' | '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": "v3",
      "kind": "catalog"
    }
  ],
  "count": 42,
  "error": "Could not fetch voices"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.