Back

Getting Started

Welcome to NeutralAiz SDK

The NeutralAiz SDK provides a comprehensive suite of AI-powered services for speech processing, entity extraction, and real-time communication. This guide will help you get started quickly.

Quick Start

1. Test LiveKit Connection

Start with our interactive LiveKit test interface:

# Open in your browser
http://admin.test.neutralaiz.com/examples/full-test.html

This provides a full WebRTC testing environment with transcription and TTS.

2. Access API Documentation

Explore our interactive API documentation:

# API Documentation Portal
http://admin.test.neutralaiz.com/docs/api-reference.html

Test endpoints directly from the documentation using Swagger UI.

3. Make Your First API Call

Example: Transcribe audio using STT service:

// Using fetch API
const formData = new FormData();
formData.append('audio', audioFile);
formData.append('provider', 'whisper');

const response = await fetch('http://stt-agent:8001/transcribe', {
    method: 'POST',
    body: formData
});

const result = await response.json();
console.log('Transcription:', result.text);

Core Services

Speech-to-Text (STT)

  • Multiple providers (Whisper, GPT-4o, Deepgram)
  • Real-time streaming support
  • Competitive accuracy analysis

Text-to-Speech (TTS)

  • OpenAI voice models
  • Multiple voice options
  • Streaming audio output

Parakeet ASR

  • GPU-accelerated processing
  • NVIDIA NeMo models
  • Low-latency transcription

Entity Extraction

  • Person profile building
  • Question generation
  • Task extraction

WebSocket Integration

Connect to real-time services for live updates:

// Connect to transcription WebSocket
const ws = new WebSocket('wss://admin.test.neutralaiz.com/ws/transcriptions/room-name');

ws.onmessage = (event) => {
    const data = JSON.parse(event.data);
    console.log('Transcription:', data);
};

// Send audio chunks for real-time transcription
ws.send(audioChunk);

Environment URLs

Service Test Environment Internal
Admin Dashboard https://admin.test.neutralaiz.com -
STT Agent - http://stt-agent:8001
TTS Agent - http://tts-agent:8002
Parakeet GPU - http://parakeet-gpu:8000
Entity Processor https://entities.test.neutralaiz.com http://entity-processor-alpha:8080
LiveKit Server wss://livekit.test.neutralaiz.com ws://livekit-server:7880

Next Steps

Explore APIs

Deep dive into our API documentation

Try Live Demo

Test WebRTC and transcription

Code Examples

Learn from working examples