InAppAI Documentation
Add intelligent AI chat to your React application with function calling, multi-provider AI, and custom knowledge base support.
Quick Start
Get started in 5 minutes:
import { InAppAI } from '@inappai/react';
function App() {
return (
<InAppAI
agentId="your-agent-id"
theme="light"
/>
);
}
Documentation Sections
1. Getting Started
Quick 4-step guide to add InAppAI to your React app:
- Install NPM package
- Sign up for backend at app.inappai.com
- Add component with your Agent ID
- Test the integration
2. Core Concepts
Understand the fundamentals:
- Agents - What AI agents are and how they work
- Context - How agents understand your application
- Tools - How agents execute actions via function calling
3. React Components
Comprehensive React integration guides:
- Installation - Setup and TypeScript configuration
- Display Modes - Popup, sidebar, panel, embedded layouts
- Themes - Built-in themes and custom styling
- Customization - Advanced styling techniques
- Context - Provide app state to the AI
- Tools - Enable AI to execute actions
- Persistence - Save and restore conversations
- Message Handling - Handle message events and analytics
- Authentication - JWT authentication
4. API Reference
Complete API documentation:
- Components - InAppAI component props
- Types - TypeScript type definitions
- Styling - CustomStyles API reference
- Hooks - useTools and useToolRegistry
5. Advanced Topics
Deep dive into architecture and best practices:
- Security - Security best practices
- Troubleshooting - Common issues and solutions
- Performance - Optimization tips
- Architecture - How InAppAI React works internally
6. Backend Configuration
Configure your subscription:
- Settings - AI provider/model, CORS, JWT, rate limiting
- Knowledge Base - Add custom docs with RAG
Key Features
🎨 Multiple Display Modes
- Popup - Floating chat button (default)
- Sidebar - Full-height slide-in panel
- Panel - Resizable split-screen
- Embedded - Custom layouts
🎭 Built-in Themes
Choose from 7 professionally designed themes: light, dark, professional, playful, minimal, ocean, sunset
🤖 Multi-Provider AI
- OpenAI - GPT-4o, GPT-4o Mini
- Anthropic - Claude 3.5 Sonnet, Claude 3.5 Haiku
- Google - Gemini 2.0 Flash
🔧 Function Calling
Let your AI agent execute JavaScript functions to:
- Retrieve data from your app
- Update application state
- Trigger workflows
- Control UI elements
📚 Knowledge Base (RAG)
Add your documentation so the AI can:
- Answer product-specific questions
- Reference your API docs
- Provide accurate help content
Pricing
- Developer: Free - 1,000 requests/month
- Startup: $89/month - 50,000 requests/month
- ScaleUp: $299/month - 300,000 requests/month
Resources
- GitHub Repository - Source code and examples
- Live Demo - Interactive examples
Support
- GitHub Issues - Report bugs or request features
- Contact - Contact Us
- Dashboard - app.inappai.com
Ready to get started? → 5-Minute Quick Start