POST

Get Voice Preview

Generates a short spoken preview of the given voice.

POSThttps://api.vantaxai.com/v1/voices/{voice_id}/preview

Pass custom `text` to hear the voice say a specific phrase, or omit it to use a default greeting. Returns a temporary audio URL.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…
Content-Typestringrequired
Must be application/json for requests with a body.
example: application/json

Path Parameters

voice_idstringrequired
The voice to preview.
example: voice_aria

Body Parameters

textstringoptional
Text to synthesize. Defaults to a sample greeting.
languagestringoptional
Override the language for this preview.
example: en-US
speed_alphanumberoptional
Speech rate multiplier (0.5–2.0).

Request

curl -X POST https://api.vantaxai.com/v1/voices/voice_aria/preview \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "text": "string",
  "language": "en-US",
  "speed_alpha": 0
}'

const res = await fetch(
  "https://api.vantaxai.com/v1/voices/voice_aria/preview",
  {
  method: "POST",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "text": "string",
    "language": "en-US",
    "speed_alpha": 0
  }),
  }
);
const { data } = await res.json();

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

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// POST /v1/voices/{voice_id}/preview
const result = await vantax.request("POST", "/v1/voices/{voice_id}/preview", {
  "text": "string",
  "language": "en-US",
  "speed_alpha": 0
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# POST /v1/voices/{voice_id}/preview
result = vantax.request("POST", "/v1/voices/{voice_id}/preview", json={"text": "string", "language": "en-US", "speed_alpha": 0})

Response

{
  "success": true,
  "data": {
    "voice_id": "voice_aria",
    "audio_url": "https://cdn.vantaxai.com/previews/tmp_9f2a.mp3",
    "expires_at": "2026-06-10T13:30:00Z"
  }
}