Skip to main content

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:

JavaScript / Web Applications

npm install ug-js-sdk

Unity / Game Development

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

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.

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 chatbotJavaScript Quick StartBasic Chat Example

Add an AI character to my Unity gameUnity SetupUnity Quick Start

Test the API without codingInteractive API Tester

Understand player authenticationAuthentication Guide

Learn about utilities (classify/extract)Utilities Reference

See example implementationsExamples

Integrate with a custom languageWebSocket 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:

  1. Get your API key from console.stg.uglabs.app
  2. Open the Interactive API Tester
  3. Connect with your API key
  4. 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?

Next Steps

  1. Choose your SDK (JavaScript or Unity)
  2. Read the authentication guide to understand player management
  3. Follow the quick start for your platform
  4. Explore examples to see complete implementations
  5. Test in the API Tester to experiment without code