Frequently Asked Questions
Is Streamoji free to use?
We offer a generous free tier for developers to explore and integrate our avatar system. The free tier includes basic avatar generation and a limited number of API calls per month. Commercial use and higher volume applications require a subscription. Check our pricing page for detailed plans and limits.
What platforms are supported?
Currently, we fully support Web applications (React, Vue, vanilla JavaScript) with Three.js integration. Native Unity and Unreal Engine SDKs are in active development and will be available soon. We also provide REST API access for any platform that can make HTTP requests.
Can I upload my own 3D assets?
Yes! Enterprise customers can upload custom clothing, hair styles, accessories, and other assets through the Developer Studio. Custom assets must follow our technical specifications for compatibility. Contact our sales team for enterprise access and asset guidelines.
How do I handle character animation?
All Streamoji avatars follow a standard humanoid rig compatible with most animation systems. They include 52 ARKit-compatible blendshapes for facial animation, making them compatible with most animation libraries, motion capture solutions, and facial tracking systems. Avatars can be animated using standard skeletal animation techniques.
What file format do avatars use?
Avatars are delivered as GLB (GLTF Binary) files, which is the binary version of the GLTF format. GLB is widely supported across game engines, 3D software, and web frameworks. The files are optimized for real-time rendering and typically range from 2-5MB in size.
How long does it take to generate an avatar?
Avatar generation typically takes 2-5 seconds depending on server load and avatar complexity. Thumbnail generation is faster, usually under 1 second. We recommend implementing loading indicators and caching strategies to improve user experience.
Can I save and reuse avatar configurations?
Yes! You can save avatar configurations using the saveAvatarConfig API endpoint, which returns an avatar ID. You can then use this ID to regenerate the same avatar later without sending the full configuration again. This is more efficient and faster than regenerating from scratch.
What are the rate limits?
Free tier accounts have a limit of 100 requests per minute and 5,000 requests per hour. Enterprise plans have higher limits and can be customized based on your needs. If you exceed rate limits, you'll receive a 429 status code with a Retry-After header indicating when you can retry.
Do avatars work in VR/AR applications?
Yes! Streamoji avatars are designed to work in VR and AR applications. They support ARKit blendshapes for facial tracking, and the standard humanoid rig works with most VR animation systems. We provide examples and guides for Oculus, AR Foundation, and other VR/AR platforms.
Can I customize avatar colors?
Yes! You can customize skin color, hair color, eyebrow color, and beard color using color indices. Each color category has a predefined palette, and you specify colors by their index (0, 1, 2, etc.). See the Asset Library documentation for available color options.
What happens if the API is down?
We maintain high availability with 99.9% uptime SLA for enterprise customers. If you encounter API issues, check our status page. We recommend implementing retry logic with exponential backoff and caching strategies to handle temporary outages gracefully.
How do I handle authentication errors?
If you receive a 401 Unauthorized error, your Firebase token may have expired. Refresh the token using user.getIdToken(true) and retry the request. Implement automatic token refresh in your application to handle this seamlessly.
Can I use Streamoji avatars commercially?
Yes, with the appropriate license. Free tier is for development and testing only. Commercial use requires a paid subscription. Enterprise customers get additional benefits including custom assets, higher rate limits, priority support, and commercial licensing. Contact our sales team for commercial licensing details.
What browsers are supported for web integration?
Streamoji works in all modern browsers that support WebGL 2.0, including Chrome, Firefox, Safari, and Edge. For mobile, iOS Safari 12+ and Chrome Android are supported. Older browsers may have limited functionality.
How do I get support?
For technical questions, check our documentation first. For additional support, you can contact us through our support email or join our Discord community. Enterprise customers receive priority support with dedicated channels.