Get Started with UG Labs
Welcome to UG Labs - the platform for building real-time, voice-enabled AI experiences. This guide will help you quickly find what you need.
Choose Your SDK
Select the SDK that matches your platform to get started:
Build conversational AI for web, Node.js, or React applications. Perfect for web apps, chatbots, and voice assistants.
Create AI-powered NPCs and interactive characters. Perfect for Unity games, VR/AR experiences, and interactive avatars.
JavaScript / Web Applications
- JavaScript SDK Installation - Install the npm package
- Quick Start Guide - Your first conversation in 5 minutes
- Interactive API Tester - Test the API in your browser
npm install ug-js-sdk
Unity / Game Development
- Unity SDK Introduction - Overview and features
- Unity Setup - Installation and configuration
- Unity Quick Start - First conversation in Unity
https://github.com/uglabs/ug-unity-sdk.git
Direct WebSocket API
Integrate with any programming language using the WebSocket protocol.
Perfect for: Python, Go, Rust, Java, or custom implementations
- WebSocket Protocol - Complete protocol reference
- API Messages - Message types and utilities
- Interactive Tester - Live testing environment
Understanding Core Concepts
New to UG Labs? Start here to understand the fundamentals:
Authentication & Players
Learn how to authenticate and manage users in your application.
- Authentication Guide - Developer and player authentication
- Terminology - Key concepts explained
- Players vs Users, Teams, API Keys, and Federated IDs
Interaction Flow
Understand how conversations work with the UG Labs API.
- Interaction Flow - Message lifecycle and patterns
- WebSocket connection flow
- Audio streaming and utilities
- Session management
Quick Navigation
I want to...
Build a chatbot → JavaScript Quick Start → Basic Chat Example
Add an AI character to my Unity game → Unity Setup → Unity Quick Start
Test the API without coding → Interactive API Tester
Understand player authentication → Authentication Guide
Learn about utilities (classify/extract) → Utilities Reference
See example implementations → Examples
Integrate with a custom language → WebSocket Protocol
What You Can Build
UG Labs enables powerful conversational AI experiences:
- Interactive NPCs: AI-powered game characters that understand and respond naturally
- Voice Assistants: Hands-free applications with speech recognition and synthesis
- Customer Support: Automated support with context-aware responses
- Educational Tools: Tutors, language learning, and interactive storytelling
- Multi-modal Experiences: Combine text, voice, and image generation
Try It Now
The fastest way to see UG Labs in action:
- Get your API key from console.stg.uglabs.app
- Open the Interactive API Tester
- Connect with your API key
- Try the example scenarios
Platform Features
Real-time Streaming
Bi-directional WebSocket communication for low-latency, natural conversations.
Voice Input & Output
Built-in audio recording and high-quality voice synthesis.
Utilities System
- Classify: Categorize user input (sentiment, intent, etc.)
- Extract: Pull structured data from conversations
Image Generation
Create AI images on-the-fly based on conversation context.
Multi-tenant Architecture
Isolate players and resources by team for secure deployment.
Need Help?
- Examples: Basic Chat
- API Reference: WebSocket Protocol
- Interactive Testing: API Tester
- GitHub: github.com/uglabs
- Support: support@uglabs.app
Next Steps
- Choose your SDK (JavaScript or Unity)
- Read the authentication guide to understand player management
- Follow the quick start for your platform
- Explore examples to see complete implementations
- Test in the API Tester to experiment without code