TellaAISophieAI Platform Documentation
Complete documentation for the SophieAI educational platform
SophieAI Platform Documentation
Complete technical documentation for SophieAI, an intelligent educational platform for AI-powered study tools, note-taking, and course management.
What is SophieAI?
SophieAI is a full-stack educational platform that transforms how students interact with their academic content through AI-powered tools and intelligent automation.
Key Benefits:
- AI-powered content analysis and generation
- Automated study material creation
- Semantic search across all your documents
- Integrated calendar and task management
- Personalized learning experience
Core Features:
- Course Management: Organize courses, professors, and academic schedules
- Intelligent Note-Taking: Upload lectures, documents, and media for AI-powered transcription and analysis
- Study Materials: Auto-generate flashcards, quizzes, and study guides from your content
- Document Management: Upload, search, and analyze academic documents with semantic search
- AI Chat: Interactive AI assistant for academic help and content analysis
- Calendar Integration: Track assignments, exams, and academic events
- Background Processing: Asynchronous job processing for file uploads and AI generation
Backend Technologies:
- Runtime: Node.js with Fastify framework
- Database: PostgreSQL with Prisma ORM
- Authentication: Better-auth with Google OAuth
- AI Integration: Google AI SDK and Groq SDK
- File Processing: FFmpeg for media processing
- Background Jobs: BullMQ with Redis
- Storage: AWS S3 for file management
Development Tools:
- TypeScript for type safety
- Swagger for API documentation
- Docker for containerization
- ESLint and Prettier for code quality
Getting Started Tip: New to SophieAI? We recommend starting with our Quick Setup Guide to get your development environment configured in under 10 minutes.
Architecture Overview
The platform consists of:
- Backend API: Fastify-based Node.js server with PostgreSQL database and Prisma ORM
- AI Integration: Google AI SDK and Groq SDK for content generation and analysis
- File Processing: Support for documents, audio, video transcription with FFmpeg
- Authentication: Better-auth integration with Google OAuth and email/password authentication
- Background Jobs: BullMQ with Redis for asynchronous processing
- File Storage: AWS S3 integration for document and media storage
Documentation Structure
Getting Started
Quick setup guide and environment configuration
Authentication
User authentication and session management
API Reference
Complete API endpoint documentation
Database Schema
Data models and relationships
Production Deployment: Before deploying to production, ensure you've configured all environment variables and security settings. Check our Production Guide for detailed instructions.
Configuration
- API Base URL:
http://localhost:5000(development) - Swagger Documentation:
/docs(when ENABLE_SWAGGER is true) - Health Check:
/health - Database: PostgreSQL with Prisma ORM
- Authentication: Better-auth with Google OAuth support
- Background Jobs: BullMQ with Redis
- File Storage: AWS S3
Core Technologies
- Backend: Node.js, Fastify, TypeScript, Prisma ORM
- Database: PostgreSQL with full-text search capabilities
- Authentication: Better-auth with Google OAuth and session management
- AI/ML: Google AI SDK, Groq SDK for content generation
- File Processing: FFmpeg for audio/video processing, office document parsing
- Queue System: BullMQ with Redis for background job processing
Ready to start? Check out our Getting Started Guide to begin your SophieAI journey!