Nexus Web Assistant v3.0

🚀 Quick Start

Embed the Nexus widget on your website in four simple steps.

<script>
window.NexusConfig = {
  apiKey: 'YOUR_NEXUS_API_KEY',
  model: 'meta-llama/llama-4-scout-17b-16e-instruct',
  botName: 'Nexus AI',
  greeting: '👋 Hello! How can I assist you today?'
};
</script>

<script defer src="https://cdn.jsdelivr.net/npm/nexus-web-assistant@3.0.0/dist/nexus-assistant.min.js"></script>

⚙️ Configuration Options

Customize the widget's behaviour by setting the window.NexusConfig object before the script loads. All properties are optional except apiKey.

window.NexusConfig = {
  apiKey: 'nxs_abc123def456',
  model: 'llama3-70b-8192',
  botName: 'DocBot',
  greeting: '📚 Welcome to our docs! Ask me anything.',
  systemPrompt: 'You are a helpful assistant. Cite sources.',
  theme: 'dark'
};

🔌 Framework Integrations

Nexus works seamlessly with every major frontend framework. Visit the Integrations page for framework-specific code snippets.

Plus WordPress, Shopify, Webflow, Laravel, Vite, Gatsby, Remix, and more. See full list →

🎨 Theming

Nexus automatically adapts to your website's theme, but you can also force a specific mode or let users toggle it.

Auto-detection Engine

By default (theme: 'auto'), the widget tracks visual context signals in this sequential order:

1. Explicit execution setup via window.NexusConfig.theme
2. Cached environment flag matching persistent state indicators inside localStorage
3. Active style presence configurations (checking for structural dark or light class hooks inside your document markup roots)
4. Checking data targets via the custom fallback property selector attribute configurations data-theme
5. System level device preferences monitored through native query execution wrappers prefers-color-scheme

✨ Key Features

🔐 Security Model

Nexus is built with a zero-trust approach to API key management. Here's how your keys are protected:

🔧 Advanced Customization

Styling Overrides

Customize the widget's appearance by overriding targeted layout variables mapped straight on the custom identity layer selector target parameter #ai-widget-root.

#ai-widget-root {
  --bg-panel: rgba(10, 10, 10, 0.92);
  --text-primary: #eee;
  --accent: #a855f7;
  --send-bg: #a855f7;
  --send-color: #fff;
  --user-bubble-bg: #2a2a2e;
  --bot-bubble-bg: #1a1a1e;
  --border-color: rgba(255, 255, 255, 0.06);
}

Programmatic API Control

The widget ecosystem injects flexible custom methods straight inside the window browser context container layer. Execute these methods directly within local custom application files:

🔌 API Reference

The embedded script interfaces secure communications down your secure proxy entry paths matching endpoint layouts at POST /api/chat. Expected processing payloads follow this structural format:

{
  "nexusKey": "nxs_abc123def456",
  "messages": [
    { "role": "system", "content": "You are a helpful assistant..." },
    { "role": "user", "content": "What is this page about?" }
  ],
  "model": "meta-llama/llama-4-scout-17b-16e-instruct"
}

🧪 API Playground

The Nexus Playground is a live testing environment where you can send requests to the API using your own keys — with zero configuration.

⚠️ Error Codes

Common HTTP status codes returned by the Nexus proxy and their meanings:

❓ Troubleshooting & FAQ

Common issues and frequently asked questions.

📊 System Status

Monitor the health of the Nexus platform in real time. The Status Page provides uptime metrics, service latencies, and incident history.

Status page updates automatically every 30 seconds. All incidents are documented with timestamps.

🖥️ Self-Hosting

Since Nexus is open-source (MIT), you can self-host the widget and backend entirely on your own infrastructure.

git clone https://github.com/thekaifansari01/NexusWeb.git
cd NexusWeb

npm install
npm run build

🆘 Support

Need help? We've got you covered.