GET

Get Voice

Retrieves metadata for a single voice.

GEThttps://api.vantaxai.com/v1/voices/{voice_id}

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…

Path Parameters

voice_idstringrequired
The voice identifier.
example: voice_aria

Request

curl -X GET https://api.vantaxai.com/v1/voices/voice_aria \
  -H "Authorization: Bearer vx_live_3fa9c2..."

const res = await fetch(
  "https://api.vantaxai.com/v1/voices/voice_aria",
  {
  method: "GET",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
  },
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// GET /v1/voices/{voice_id}
const result = await vantax.request("GET", "/v1/voices/{voice_id}");

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# GET /v1/voices/{voice_id}
result = vantax.request("GET", "/v1/voices/{voice_id}")

Response

{
  "success": true,
  "data": {
    "id": "voice_aria",
    "name": "Aria",
    "language": "en-US",
    "language_label": "English (US)",
    "gender": "female",
    "tone": "warm",
    "description": "Bright, friendly, great for front-desk reception",
    "preview_url": "https://cdn.vantaxai.com/voices/aria-preview.mp3"
  }
}

{ "success": false, "message": "Voice not found" }