Quickstart

This guide takes you from an API key to a saved audio file.

1. Get an API key

Create an API key from the Vakyam dashboard . Keys look like vak_live_... and are shown only once at creation, so store yours securely.

See Authentication for how keys are validated.

2. Set your key as an environment variable

1export VAKYAM_API_KEY="vak_live_..."

3. Install the SDK

1pip install vakyamai

See the Python and JavaScript / TypeScript SDK pages for runtime requirements and more options.

4. Synthesize speech

1234567891011121314from vakyamai import VakyamAI

client = VakyamAI()  # reads VAKYAM_API_KEY

response = client.tts.generate(
    text="வணக்கம், நான் வாக்யம் AI பேசுகிறேன்.",
    model_id="raaga-v1",
    voice="Archana",
    language="ta-IN",
    output_format="mp3",
)

response.save("speech.mp3")
print(response.duration_seconds, "seconds")

The JSON response contains base64-encoded audio plus metadata:

123456{
  "audio": "SUQzBAAAAAAA...",
  "format": "mp3",
  "duration_seconds": 2.4,
  "characters_used": 36
}

With cURL, decode the audio field to get the raw file:

1echo "<base64-audio>" | base64 --decode > speech.mp3

5. Discover voices

Not sure which voice and language combinations exist? List them:

12voices = client.voices.list(group_by="language")
print(voices)