Quick Start - Lokutor

Authenticate

Get your API key by contacting us at [email protected]. We’ll provide you with the necessary credentials to access our API.

export LOKUTOR_API_KEY="your-api-key"

Your First Request

Since we’re still growing, we currently offer our API via WebSocket for real-time streaming. Here’s how to connect and synthesize your first audio.

JavaScript (Node.js)
Python

const WebSocket = require('ws');

const ws = new WebSocket(`wss://api.lokutor.com/ws?api_key=${process.env.LOKUTOR_API_KEY}`);

ws.on('open', function open() {
  console.log('Connected to Lokutor');
  
  // Send synthesis request
  ws.send(JSON.stringify({
    text: "Hello, this is Lokutor!",
    voice: "M1",
    lang: "en",
    speed: 1.05,
    steps: 5,
    version: "versa-1.0",
    visemes: false  // Optional: Enable for lipsync data
  }));
});

ws.on('message', function message(data) {
  if (typeof data === 'string') {
    if (data === 'EOS') {
      console.log('Synthesis complete');
      ws.close();
    } else if (data.startsWith('ERR:')) {
      console.error('Error:', data);
    }
  } else {
    // Binary audio data
    console.log('Received audio chunk:', data.length, 'bytes');
    // Process audio (e.g., play or save)
  }
});

import websocket
import json
import os

def on_message(ws, message):
    if isinstance(message, str):
        if message == 'EOS':
            print('Synthesis complete')
            ws.close()
        elif message.startswith('ERR:'):
            print('Error:', message)
    else:
        # Binary audio data
        print('Received audio chunk:', len(message), 'bytes')
        # Process audio

def on_open(ws):
    print('Connected to Lokutor')
    
    # Send synthesis request
    request = {
        "text": "Hello, this is Lokutor!",
        "voice": "M1",
        "lang": "en",
        "speed": 1.05,
        "steps": 5,
        "version": "versa-1.0",
        "visemes": False  # Optional: Enable for lipsync data
    }
    ws.send(json.dumps(request))

ws = websocket.WebSocketApp(
    f"wss://api.lokutor.com/ws?api_key={os.environ['LOKUTOR_API_KEY']}",
    on_message=on_message,
    on_open=on_open
)

ws.run_forever()

Next Steps

Explore the API Reference
Have a specific request? Contact us at [email protected]

Welcome

API Reference

​Authenticate

​Your First Request

​Next Steps

Authenticate

Your First Request

Next Steps