Hello! 👋 This tutorial will help you get started with the Avatar SDK for AIPI.
To install the package, run the following command:
npm i alpha-ai-avatar-sdk-aipi
apiKey
(required): Your API key for authentication.baseUrl
(optional): Send'https://staging.avatar.alpha.school'
to use the staging environment. Defaults to the production URL.initialPrompt
(optional): This be included before the conversation, helping guide AI behavior and responses.avatarId
(optional): This will be used if you need to connect to a specific avatar.
import {
ConversationalAvatarController,
ConversationalAvatarDisplay,
Chat,
} from 'alpha-ai-avatar-sdk-aipi';
const avatarController = new ConversationalAvatarController({
apiKey: 'API_KEY',
initialPrompt: [
{
role: 'system',
content: 'Act like Albert Einstein',
},
],
});
export function App() {
return (
<div
style={{
display: 'flex',
alignItems: 'center',
flexDirection: 'column',
color: 'black',
gap: '20px',
}}>
<p>Conversational mode example</p>
<ConversationalAvatarDisplay avatarController={avatarController} />
<Chat avatarController={avatarController} />
</div>
);
}
You can explore our comprehensive list of plugins supported within the Avatar SDK to streamline and accelerate your application development process. For detailed information about each plugin, refer to our plugins documentation.
You can find a few examples in the examples folder of the library. These examples demonstrates how to configure and use the SDK in a React project.
For a detailed overview of all supported configurations, please refer to our comprehensive documentation.
Note: Always ensure you keep your API key secure and do not expose it in publicly accessible code.
Congratulations! You have successfully integrated the Avatar SDK into your app. 🎉 Feel free to experiment and build more complex components with avatars.