Admin UI Overview
Welcome to the ChatSDK Admin Interface. This is your central hub for managing projects, API keys, documentation, and monitoring your chat implementations.
What is the Admin UI?
The Admin UI is a web-based dashboard that allows you to:
- Create and manage projects - Organize your chat implementations by project
- Generate and manage API keys - Secure authentication for your applications
- Upload and manage documentation - Feed your knowledge base to power intelligent responses
- Monitor usage and analytics - Track API usage, costs, and performance
- Configure settings - Customize behavior for each project
Key Features
Projects Management
Organize your implementations into projects:
- Create separate projects for different applications
- Manage multiple environments (development, staging, production)
- Track usage and costs per project
- Share projects with team members (Team plan)
API Key Management
Generate and manage API keys for SDK authentication:
- Create keys for different environments (test/live)
- Set permissions and rate limits
- Track key usage and last activity
- Revoke compromised keys instantly
- Rotate keys without downtime
Documentation Upload
Build your knowledge base for context-aware chat:
- Upload product documentation (Markdown, PDF, HTML)
- Process and vectorize documents for semantic search
- Organize docs by category and relevance
- Monitor indexing progress and quality
- Version your documentation
Usage Analytics
Monitor and optimize your implementation:
- Real-time usage metrics and charts
- Cost tracking and projections
- Performance monitoring
- Error rates and debugging
- Per-API-key analytics
Getting Started
1. Create an Account
Sign up for a ChatSDK account to access the Admin UI.
2. Create a Project
Create your first project to organize your implementation.
3. Get an API Key
Generate an API key to authenticate your SDK.
4. Upload Documentation
Feed your product documentation into the knowledge base.
5. Integrate SDK
Add the Chat SDK to your application using your API key.
User Roles & Permissions
Owner
- Full access to project
- Can manage team members
- Billing and payment management
- View all analytics and usage
Admin
- Create and manage API keys
- Upload and manage documentation
- View project analytics
- Cannot manage team or billing
Developer
- View API keys (limited info)
- Monitor project usage
- Access documentation (read-only)
- Cannot modify settings
Note: Team roles and permissions are available on Team plan and above.
Common Tasks
Quick Setup (5 minutes)
- Create a new project
- Generate an API key
- Copy the key to your environment
- Install SDK in your React app
- Wrap your app with ChatProvider
Document Your Product (30 minutes)
- Gather your documentation files (Markdown, HTML, or PDFs)
- Upload to the Documentation section
- Configure categories and importance levels
- Start a chat to test the knowledge base
Monitor Performance
- Go to Analytics dashboard
- Review daily usage charts
- Check error rates and troubleshooting
- Optimize based on insights
Pricing & Plans
All plans include:
- Unlimited chat conversations
- API access for integrations
- Analytics and monitoring
- Community support
Free Plan
- 1 project
- 50 requests/minute
- 500MB storage
- Limited documentation
Starter Plan
- 3 projects
- 100 requests/minute
- 2GB documentation storage
- Email support
Pro Plan
- Unlimited projects
- 500 requests/minute
- 10GB documentation storage
- Priority support
- Team collaboration
Enterprise Plan
- Custom limits
- Dedicated support
- Custom integrations
- SLA guarantees
Navigation
Main Menu
- Dashboard - Overview and quick stats
- Projects - Manage all your projects
- API Keys - Create and manage keys
- Documentation - Upload and organize docs
- Analytics - Usage and performance metrics
- Settings - Account and project settings
- Help - Documentation and support
Account Menu (Top Right)
- Profile - User settings and preferences
- Billing - Payment and subscription management
- Team - Team member management
- Help - Documentation and support
- Sign Out - Log out of your account
Security & Privacy
- API Keys - Encrypted and hashed, never logged
- Documentation - Private to your project
- Data - Encrypted in transit and at rest
- Compliance - GDPR, SOC 2 (Enterprise plan)
Support
Need help?
- Documentation - Browse our comprehensive guides
- Email Support - support@chatsdk.com
- Chat Support - Available in the Admin UI (Starter+ plans)
- Community - GitHub discussions