Skip to content

Sentifyd/sentifyd-avatar-plugin

Repository files navigation

Sentifyd Avatar WordPress Plugin

Sentifyd Avatar Banner

License WordPress PHP

Easily deploy intelligent, real-time 3D AI avatars on your WordPress site with the Sentifyd Avatar plugin.

🌟 Overview

The Sentifyd Avatar plugin allows you to quickly integrate AI-powered 3D avatars into your WordPress website. These interactive avatars combine natural voice-driven conversations with lifelike animations, providing an immersive user experience that goes beyond traditional chatbots.

What are Sentifyd 3D AI Agents?

Sentifyd Avatar Icon

Sentifyd.io empowers you to deploy intelligent, real-time 3D AI agents—fully animated avatars capable of natural, voice-driven conversations. These interactive 3D agents combine:

  • Retrieval-Augmented Generation (RAG): Access and reason over your own content (manuals, FAQs, documents)
  • Dynamic Motion: Lifelike gestures, movement, and tone for immersive experiences
  • Tool Integration: Connect with MCP servers and other powerful tools for task execution
  • Real-Time Interaction: Natural voice and language understanding with instant responses
  • Multi-Language Support: UI supports English, French, German, Spanish, Arabic, and Chinese

✨ Features

  • Easy Installation: Simple plugin setup with minimal configuration
  • Voice Mode Switching: Deploy sentifyd-bot for standard voice or sentifyd-realtime for realtime speech-to-speech avatars
  • Secure Token Management: Built-in REST endpoint for secure token generation
  • Customizable Appearance: Brand colors, logos, backgrounds, and border radius
  • Flexible Deployment: Auto-inject as toggler or embed using shortcode
  • Access Control: Option to restrict avatar visibility to logged-in users
  • Localization Ready: Supports 6+ languages for both admin panel and avatar UI
  • Privacy-Focused: Session-scoped data only, cleared when browser tab closes
  • WordPress Standards: Follows WordPress coding standards and best practices

📦 Installation

From GitHub Releases (Recommended)

  1. Get Your Sentifyd Credentials

    • Sign up at sentifyd.io and create your avatar
    • If you plan to use Real-time voice mode, configure that avatar for realtime voice mode in Sentifyd
    • Note your Avatar ID and API Key from the avatar page
  2. Download the Plugin

    • Go to the Releases page
    • Download the latest sentifyd-avatar-plugin-X.X.X.zip file
  3. Install in WordPress

    • Log in to your WordPress admin panel
    • Navigate to PluginsAdd NewUpload Plugin
    • Click Choose File and select the downloaded ZIP file
    • Click Install Now
    • Click Activate Plugin
  4. Configure the Plugin

    • Go to Sentifyd Avatar in your WordPress admin sidebar
    • Enter your Avatar API Key (required)
    • Enter your Avatar ID (required)
    • Choose Voice mode: Standard for sentifyd-bot or Real-time for sentifyd-realtime
    • Optionally configure branding, theme colors, and other settings
    • Click Save Settings
  5. Verify Installation

    • Visit your website's front-end
    • The avatar should appear in the bottom-right corner (default toggler mode)

Avatar Deployed

Manual Installation

If you want to install directly from source:

# Clone the repository
git clone https://github.com/Sentifyd/sentifyd-avatar-plugin.git

# Create a zip file (excluding dev files)
cd sentifyd-avatar-plugin
zip -r sentifyd-avatar-plugin.zip . \
  -x ".git*" \
  -x ".github/*" \
  -x "*.md" \
  -x ".vscode/*"

Then upload the ZIP file via WordPress AdminPluginsAdd NewUpload Plugin.

⚙️ Configuration

Required Settings

Setting Description
Avatar API Key Your avatar's API key from sentifyd.io (stored server-side only)
Avatar ID Your avatar's unique identifier from sentifyd.io

Optional Settings

Deployment Mode

  • Enable Toggler (default: ON): Auto-injects avatar as a minimizable button in bottom-right
  • Shortcode Mode: Disable toggler and use [sentifyd_avatar] shortcode to place avatar anywhere

Avatar Attributes

  • Voice mode: Choose Standard for sentifyd-bot or Real-time for sentifyd-realtime
  • Require Authentication: Restrict avatar access to logged-in users only
  • Compact Mode: Display avatar without header/footer
  • Enable Captions: Show captions on the avatar by default

If you choose Real-time, the selected avatar in Sentifyd must also be configured for realtime voice mode.

Branding

  • Brand Name: Your organization's name (used in transcripts)
  • Brand Logo URL: Logo displayed in avatar header
  • Terms Link: URL to your Terms of Service
  • Privacy Link: URL to your Privacy Policy

Theme Customization

  • Avatar Background: CSS color value (hex, rgb, gradient)
  • Curved Corner Radius: Border radius (e.g., 12px, 1rem, 50%)
  • Primary Color: Main theme color
  • Secondary Color: Accent color
  • Text Colors: Customize text colors for different backgrounds

Advanced: Custom Token Endpoint

If you want full control over token issuance:

  1. Implement your own secure token endpoint
  2. Enter the endpoint URL in Secure Token Endpoint
  3. The plugin will call your endpoint instead of the built-in one
  4. Your endpoint must return tokens in the expected format (see documentation)

🚀 Usage

As a Toggler (Default)

By default, the avatar appears as a minimizable button in the bottom-right corner on all pages.

Using Shortcode

  1. Disable Enable Toggler in settings
  2. Add the shortcode where you want the avatar to appear:
[sentifyd_avatar]

You can place this shortcode in posts, pages, widgets, or theme templates.

External Services

This plugin relies on external third-party services provided by Sentifyd to function. By using this plugin, you acknowledge and agree to the use of these services.

Sentifyd Frontend Service (frontend.sentifyd.io)

What it does: Provides the JavaScript web component library that powers the 3D AI avatar interface displayed on your website.

Data sent and received: The JavaScript file is loaded from https://frontend.sentifyd.io/sentifyd-bot/main.js in Standard voice mode or https://frontend.sentifyd.io/sentifyd-realtime/v1/main.js in Real-time voice mode whenever a page with the avatar is viewed.

Service provider: Sentifyd.io
Terms of Service | Privacy Policy

Sentifyd Backend Service (serve.sentifyd.io)

What it does: Handles avatar authentication, conversation processing, natural language understanding, voice synthesis, and AI-powered responses.

Data sent and received: When the avatar widget initializes, avatar initialization data is received from the server. During each user interaction with the avatar, users input is sent to the server, and AI responses are recieved. Conversation data is processed in real-time. Session tokens are short-lived (typically expire within 1 hour). Conversation logs are retained for a short period (1 hour) to easily resume conversations.

Service provider: Sentifyd.io
Terms of Service | Privacy Policy

Azure Speech Services (Microsoft Azure)

What it does: Provides speech-to-text (STT) functionality, converting user voice input into text that the avatar can process. The avatar widget connects directly to Azure Speech Services from the user's browser.

Data sent and received: When a user clicks the microphone button and speaks to the avatar, user's voice audio is sent directly from browser to Azure Speech Services. Short-lived speech authentication tokens (obtained from Sentifyd backend, typically expire within minutes).

Service provider: Microsoft Corporation
Terms of Service | Privacy Policy | Azure Speech Docs

🔒 Privacy & Security

  • API Key Security: Stored server-side only, never exposed to browser
  • Token Management: Short-lived tokens generated via secure REST endpoint
  • Session Storage: UI state stored in browser's sessionStorage (cleared on tab close)
  • No Cookies: Plugin does not use cookies or localStorage
  • GDPR Friendly: Privacy policy content auto-generated for WordPress Privacy Policy page

Data Stored in Browser Session

  • showChatbot_{avatar_id}: UI open/closed state
  • authData_{id}: Short-lived authentication tokens
  • conversationData_{avatarId}: Session conversation context

All data is cleared when the browser tab/window closes.

🌍 Localization

The plugin supports multiple languages:

Admin Panel: English, German, French, Spanish, Chinese (Simplified), Arabic

Avatar UI: Automatically detects WordPress site language and sets appropriate UI language (en, fr, de, es, ar, zh)

📝 Requirements

  • WordPress: 6.3 or higher
  • PHP: 7.4 or higher
  • Sentifyd Account: Free trial available at sentifyd.io

🆘 Support

📄 License

This plugin is licensed under the GNU General Public License v2 or later.

See LICENSE file for details.

🙏 Credits

Developed by Sentifyd


Get Started for Free: Sign up and get up to 500 conversation minutes

About

Official WordPress plugin for Sentifyd.io 3D Ai avatars

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors