You can install the SDK via Node Package Manager, Performant NPM or Yarn.

The SDK requires Node.js version 17.02+, please upgrade if your package manager warns about it.

  • npm

  • pnpm

  • yarn

npm i @avatechai/avatars

Below is a simple example of how to display a generated avatar using the SDK.

import { useState } from 'react'
import { useAvatar } from '@avatechai/avatars/react'
import {
  defaultAvatarLoaders,
} from '@avatechai/avatars/default-loaders'

function App() {
  const { avatarDisplay } = useAvatar({
    // Avatar State
    avatarId: 'af3f42c9-d1d7-4e14-bd81-bf2e05fd11a3',

    // Loader + Plugins
    avatarLoaders: defaultAvatarLoaders,

    // Style Props
    scale: 4,
  })
  return(
  <>
    {avatarDisplay}
  </>
  ) 
}

export default App

​
Demo

Next JS

With Next JS, Vercel AI, a simple chat with avatar experience.