nui-strapi-chatbot-plugin
v1.0.11
Published
An AI-powered FAQ chatbot plugin for Strapi v5. Integrates an intelligent assistant into your admin panel — backed by OpenAI GPT-4o mini and semantic embeddings — so users can get instant answers from your FAQ content. Includes a built-in admin UI for con
Readme
Strapi Chatbot Plugin
An AI-powered FAQ chatbot plugin for Strapi. Drop it into any Strapi project and get an intelligent FAQ assistant in your admin panel.
⚠️ Note: To test the chatbot API, you can use the nui-strapi-chatbot-react package as a simple frontend UI.
📦 Installation
# npm
npm install nui-strapi-chatbot-plugin@latest
# yarn
yarn add nui-strapi-chatbot-plugin@latest
# pnpm
pnpm add nui-strapi-chatbot-plugin@latest🚀 Build & Start
npm run build
npm run develop💡 Usage
Start your Strapi app.
Open the admin panel and navigate to NUI Chatbot Configuration in the sidebar.
- Add your frontend base domain (used to resolve card assets from its public folder).
- Set up your OpenAI API key. Make sure
gpt-4o-miniandtext-embedding-3-smallmodels are available on your account.
- Clicking Save will validate the API key and save it.
- Add a contact link so the AI can provide it to users on request.
- Save the configuration.
- Add your FAQ entries in the Chatbot-FAQ collection.
- The chatbot is ready to use — test it directly from the admin panel.
🔄 Updating
npm install nui-strapi-chatbot-plugin@latest
# Then rebuild and restart
npm run build && npm run develop🔒 Security
- Admin endpoints (
/collections,/usage,/validate-key) require Strapi admin authentication and are not publicly accessible. - Your OpenAI API key is stored in the Strapi plugin store and is never returned to the browser in plaintext.
- The
/askendpoint is public (required by the frontend chatbot widget). In production, apply rate limiting at your reverse-proxy or CDN to prevent billing abuse.
⚠️ Troubleshooting
Make sure the base domain is set correctly before testing.
Only add FAQ entries to the Chatbot-FAQ collection after providing a valid API key.
If you see a version mismatch during install, run:
npm install --legacy-peer-deps
Additional Information
Response Template
- Add collections for AI to query realtime data
Suggested Questions
- Add questions so that it can be fetched in frontend as suggestions
AI Instructions
System Instrcutions : Used in realtime querying. Sent while AI creates DB query
Response Tone : Used in the final response sent by AI.
