Use Cases
Summary:
Convai’s powerful new Character Crafting APIs make it easier than ever for developers and educators to create, manage, and customize AI characters programmatically for games, virtual worlds, and especially learning and training (LnT) applications. With a flexible, RESTful approach, you can control every aspect of your AI—from knowledge and narratives to actions, voices, and LLM models—empowering dynamic, globally accessible experiences that are easy to build and update.
“APIs matter to developers because they provide a standardized way for different software systems to communicate and exchange data, making development faster, easier, and more efficient” - Blue Tea
Whether you’re developing a large-scale game, a next-generation classroom, or an enterprise training tool, you need to:
Convai’s Core Character Crafting APIs deliver exactly that—making it simple for both developers and educators to:
For insights on AI characters’ role in education and training, check out Convai’s blog revolutionizing learning and training through roleplaying AI characters.
Whether you’re a seasoned developer or new to AI, Convai’s APIs are designed for maximum flexibility and ease of use.
1. Get Your API Key
i. Sign in to the Convai Playground and find your API key in your account dashboard.
2. Create Characters Instantly
i. Use the Create Character API to programmatically generate new AI teachers, guides, or NPCs—customize name, voice, backstory, and more in one request. Try it out on our official collab notebook.
3. List, Retrieve & Update
i. Fetch your entire character roster with Characters List API.
ii. See all character details (e.g., skills, backstory, voice) using Get Character Details API.
iii. Instantly update any character’s info (e.g., new lesson, new language, new voice, etc.) with Update Character API.
4. Upload Knowledge & Design Narratives for Learning & Training
i. Add books, manuals, or learning modules to your AI instructor using the Knowledge Bank API.
ii. Use the Narrative Design API to craft training scenarios, branching lessons, and dynamic interactions.
5. Custom Actions & Animation
i. Bring lessons to life—define how your AI character gestures, demonstrates, or interacts using the Action API.
6. Preview and Personalize
i. Fetch all available voices/languages for your audience with the Voice List API, then update programmatically as needed.
i. Use these APIs in Unity, Unreal Engine, web apps, mobile, or your own LnT dashboards.
i. Simple REST design ensures easy adoption—even for teams new to AI.
Tip: Try out all API endpoints hands-on in the Convai API Playground or collab notebook. The quickstart guide makes onboarding easy for any developer.
Scenario:
A university, corporate training program, or e-learning startup wants to create unique digital instructors for every class, team, or language—all at scale. Using Convai’s APIs, curriculum managers can:
Live Demo:
The video tutorial demonstrates API-based character creation, knowledge uploads, and live updates—mirroring how you’d deploy fresh content or new trainers in real-world learning environments.
The possibilities are endless! Reach out to us with some of the amazing projects you create using Convai by tagging us on LinkedIn or X.
Q: Can I use these APIs even if I’m not an advanced developer?
A: Yes! The REST design, sample notebooks, and detailed docs make it accessible for any developer or technical educator.
Q: Can I create and manage AI instructors for learning and training?
A: Absolutely. Instantly generate, update, and equip AI teachers or coaches with lessons, case studies, or onboarding flows—perfect for any scale of education or workforce training.
Q: Can I integrate Convai with my custom LMS or EdTech app?
A: Yes—Convai’s APIs work with any platform. Connect via REST, and let your admins or learners create and update characters as needed.
Q: Can users update knowledge, language, or voice live?
A: Yes, you can push new content, voices, and abilities to live characters even while users are in session.
Q: What avatar systems and engines are supported?
A: Convai works with Unreal Engine’s Metahumans, Reallusion, Ready Player Me, and custom 3D avatars in Unity, Unreal, or any compatible engine.
Q: Where do I start or get support?
A:
Q: Where can I see examples or try it myself?
A: