Streaming API Overview
Real-time Interactive Avatars with Streaming API
Welcome to Streaming API!
KonPro's Streaming API enables developers to seamlessly integrate dynamic Interactive Avatars into their applications for immersive user experiences. With this API, you can display an Interactive Avatar in a real-time setting to create virtual assistants, training simulations, and more, utilizing low-latency communication between users and Interactive Avatars with the power of WebRTC.
Quick Start
For a quick start, you can use our Interactive Avatar Demo GitHub repository or install our SDK NPM Package directly to your project. Please see the GitHub projects for installation instructions.
Getting Started
Choose between our GitHub demo repository or NPM package based on your preferred development approach.
Streaming API vs. SDK
When deciding where to start, choose based on your development environment:
Streaming SDK
If you're developing in a Node.js environment, start with the Streaming SDK for easier integration.
Best for: Node.js applications, quick prototyping, simplified setup
Streaming API (LiveKit approach)
If you need to develop for different environments, devices, or platforms, start with the Streaming API, which utilizes LiveKit and works in any WebRTC-compatible setup.
Best for: Multi-platform development, WebRTC compatibility, flexible deployment
More Information
For more information about the Streaming API, please read our Interactive Avatar 101 Help center article.
Additional Resources
Check out our comprehensive help center articles for detailed guides and best practices.
About the Streaming Protocol
The Streaming API leverages the WebRTC (Web Real-Time Communication) protocol to ensure low-latency, secure communication between browsers and applications. This foundational technology offers advantages including low latency, cross-browser compatibility, data security, and scalability.
WebRTC Advantages
For detailed information on WebRTC, visit the WebRTC website or WebRTC API page on MDN.
Use Cases
From interactive e-learning and gaming to virtual customer support and immersive entertainment, Interactive Avatars have the potential to transform industries.
E-Learning
Interactive educational experiences with virtual instructors
Gaming
Immersive gaming experiences with AI-powered characters
Customer Support
Virtual assistants for enhanced customer service
Entertainment
Interactive entertainment and virtual performances
Training Simulations
Realistic training environments with AI avatars
Virtual Events
Interactive virtual conferences and presentations
Creating a Custom Interactive Avatar
You can create your own Interactive Avatar on KonPro and use it with the Streaming API! Go to KonPro Labs and click Create Interactive Avatar to get started.
Getting Started with Custom Avatars
- Visit KonPro Labs
- Click "Create Interactive Avatar"
- Follow the filming instructions
- Integrate with the Streaming API
Video Guide
Here is an instructions video for filming the footage!
Conclusion
In summary, the Streaming API empowers developers to create dynamic and interactive experiences by embedding Interactive Avatars into apps and websites of all kinds. Whether you're building virtual assistants, customer support, or immersive training simulations, KonPro API offers the tools needed to bring avatars to life within your applications, marking a significant advancement in user engagement and interactivity.