SDK Access
next-virtual
is a NextJS client SDK that offers a collection of React UI components to easily integrate with VIRTUAL to spawn 3D AI character with messaging feature.
Features
Integration with VIRTUAL: Integrate conversational AI 3D models into your NextJS applications by utilizing the customizable component.
Customizable Components and Hooks:
next-virtual
provides a customizable UI component to render animated 3D AI character for you. For complete customizability, you can use theuseVirtualAI
hook to build your own components that integrate with VIRTUAL.Managed Infrastucture: Conversation storing, memory, databases, model hostings and other infrastructure requirements are managed by Virtual Protocol.
Model Inference Points: API-based inference points allow applications to plug and play our models for usage.
Installation
Once you have subscribed to the characters, you will receive an email with the license key.
To install next-virtual
in your React project, follow these simple steps:
Step 1: Install the Package
or
Step 2: Obtain Your API Key
Follow Build with Virtual to obtain your first API key.
Step 3: Implement initAccessToken
function
initAccessToken
functionThis function communicates with your access token API and returns an VIRTUAL-specific access token.
Sample implementation:
Step 4: Put the CharacterRoom
component
CharacterRoom
componentNow you can start using the UI components provided by react-character-ai
in your React components.
If you prefer implementing own components, use the useVirtualAI
hook as follows.
Next step
To continue from here, you can either:
Check out our Virtuals and start consuming them.
Read our API References to understand our API Endpoints.
Learn more about how our SDK works.
Last updated