Getting Started

npm install @lokutor/sdk

// save as tts.mjs and run: node tts.mjs
import { TTSClient, VoiceStyle, Language } from '@lokutor/sdk';
import fs from 'node:fs';

const client = new TTSClient({ apiKey: process.env.LOKUTOR_API_KEY });
const chunks = [];

// Resolves when the server has sent all the audio; rejects with a LokutorError on failure.
await client.synthesize({
  text: 'Hello from Lokutor.',
  voice: VoiceStyle.F1,
  language: Language.ENGLISH,
  onAudio: (data) => chunks.push(Buffer.from(data)),
});

fs.writeFileSync('output.raw', Buffer.concat(chunks));
console.log('Saved output.raw');
// Convert: ffmpeg -f s16le -ar 44100 -ac 1 -i output.raw output.wav

import { TTSClient, VoiceStyle, Language } from '@lokutor/sdk';

// Your backend calls POST https://api.lokutor.com/ws-ticket with your key and returns { ticket }.
const { ticket } = await fetch('/api/lokutor-ticket', { method: 'POST' }).then((r) => r.json());

const audioCtx = new AudioContext(); // create it inside a click handler
let nextTime = audioCtx.currentTime;

const client = new TTSClient({ apiKey: ticket });

await client.synthesize({
  text: 'Hello from Lokutor.',
  voice: VoiceStyle.F1,
  language: Language.ENGLISH,
  onAudio: (pcm16) => {
    const int16 = new Int16Array(pcm16.buffer, pcm16.byteOffset, pcm16.byteLength / 2);
    const float32 = new Float32Array(int16.length);
    for (let i = 0; i < int16.length; i++) float32[i] = int16[i] / 32768;

    const buffer = audioCtx.createBuffer(1, float32.length, 44100);
    buffer.getChannelData(0).set(float32);

    const source = audioCtx.createBufferSource();
    source.buffer = buffer;
    source.connect(audioCtx.destination);
    const start = Math.max(audioCtx.currentTime, nextTime);
    source.start(start);
    nextTime = start + buffer.duration;
  },
});

pip install lokutor

import os
import wave
from lokutor import TTSClient, VoiceStyle, Language

client = TTSClient(api_key=os.environ["LOKUTOR_API_KEY"])
chunks = []

client.synthesize(
    text="Hello from Lokutor.",
    voice=VoiceStyle.F1,
    language=Language.ENGLISH,
    on_audio=chunks.append,
    play=False,   # True plays through your speakers: needs pip install "lokutor[audio]"
    block=True,
)

with wave.open("hello.wav", "wb") as f:
    f.setnchannels(1)
    f.setsampwidth(2)
    f.setframerate(44100)
    f.writeframes(b"".join(chunks))

// save as raw-tts.mjs and run: node raw-tts.mjs
import fs from 'node:fs';

const key = encodeURIComponent(process.env.LOKUTOR_API_KEY);
const ws = new WebSocket(`wss://api.lokutor.com/ws/tts?api_key=${key}`);
ws.binaryType = 'arraybuffer';
const chunks = [];

ws.onopen = () => {
  ws.send(JSON.stringify({ text: 'Hello from Lokutor.', voice: 'F1', language: 'en' }));
};
ws.onmessage = (event) => {
  if (event.data instanceof ArrayBuffer) {
    chunks.push(Buffer.from(event.data)); // Int16 PCM, 44.1 kHz, mono
  } else if (event.data === 'EOS') {
    fs.writeFileSync('output.raw', Buffer.concat(chunks));
    ws.close();
  } else {
    console.error(event.data); // {"type":"error","data":{...}}
    ws.close();
  }
};