Documentation Index
Fetch the complete documentation index at: https://mintlify.com/darkzOGx/youtube-automation-agent/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The YouTube Automation Agent includes a beautiful web dashboard for real-time monitoring and control. Access it athttp://localhost:3456 while the agent is running.
The dashboard auto-refreshes every 30 seconds to show the latest data without manual intervention.
Accessing the Dashboard
Starting the Dashboard
The dashboard automatically starts when you launch the agent:Opening the Dashboard
Wait for Data Load
The dashboard will automatically fetch and display:
- System health status
- Upcoming schedule
- Performance analytics
- Agent status
- Recent activity
Remote Access
To access the dashboard from other devices on your network:Dashboard Layout
Header Section
The dashboard header displays:- Project Name: Ethereal Dreamscript
- Subtitle: YouTube Automation Dashboard
- Gradient Background: Purple/blue gradient for visual appeal
Status Bar
Four real-time status cards at the top:System Status Card
- 🟢 Green: System healthy, all agents running
- 🔴 Red: System error or agents not initialized
- Updates based on
/healthendpoint response
Content Generated Card
- Shows total number of videos created
- Increments with each successful generation
- Data from
/analyticsendpoint
Videos Published Card
- Total count of successfully published videos
- Updates when videos go live on YouTube
- Synced with YouTube channel data
Next Generation Card
- Displays next scheduled content generation time
- Default: “6:00 AM” for daily automation
- Shows “Tomorrow” if next generation is next day
- Updates from
/scheduleendpoint
Action Buttons
Three primary action buttons:Generate Content Now
Triggers immediate content generation, bypassing the schedule.
View Analytics
Opens analytics data in JSON format in new tab.
View Schedule
Opens upcoming schedule in JSON format in new tab.
Dashboard Cards
1. System Overview Card
Shows high-level system health:- Status: Initialized or Initializing
- Agents Active: Count of running agents (should be 7/7)
- Uptime: How long the system has been running
- Last Updated: Time of last data refresh
If Agents Active shows less than 7/7, check the console logs for initialization errors.
2. Upcoming Schedule Card
Displays next 3 scheduled content items:- Content title
- Scheduled publish date and time
- Sorted by publish time (earliest first)
3. Content Strategy Card
Shows current content focus and settings:- Current Focus: Main content theme
- Target Audience: Who the content is for
- Content Types: Formats being produced
- Posting Frequency: How often content publishes
- Optimal Time: Best time for maximum engagement
4. Recent Activity Card
Live log of recent automation events:- ✅ Success: Tasks completed successfully
- ℹ️ Info: Informational messages
- ⚠️ Warning: Non-critical issues
- ❌ Error: Failed operations
5. Agent Status Card
Shows status of all 7 agents:| Agent | Purpose |
|---|---|
| strategy | Analyzes trends and selects content topics |
| scriptWriter | Generates video scripts and narratives |
| thumbnailDesigner | Creates eye-catching thumbnail images |
| seoOptimizer | Optimizes titles, descriptions, and tags |
| production | Compiles and validates content assets |
| publishing | Schedules and uploads videos to YouTube |
| analytics | Tracks performance and generates insights |
6. Performance Metrics Card
Shows aggregated performance data:- Average Performance: Composite score 0-100 based on engagement, retention, CTR
- Total Content: Number of videos generated by the system
- System Health: Overall system status (Excellent, Good, Needs Attention)
Interactive Features
Generate Content Button
Manually trigger content generation:Confirm Action
Confirm the prompt: “Generate content now? This will create a new video for your channel.”
Wait for Processing
A loading alert appears. The system processes through all 6 agents (typically 2-5 minutes).
View Analytics Button
Inspect raw analytics data:
Example analytics response:
View Schedule Button
Inspect upcoming content:Refresh Button
Manually refresh dashboard data:- Location: Bottom-right corner (floating button)
- Icon: 🔄 circular arrow
- Action: Immediately refetches all data from API endpoints
- Use Case: Get latest data without waiting for 30-second auto-refresh
Auto-Refresh Behavior
The dashboard implements smart auto-refresh:- System status indicator (green/red)
- Agent status (7/7 active check)
- Uptime counter
- Upcoming schedule items
- Content and published counts
- Performance metrics
- Recent activity log
Status Indicators
Color Coding
The dashboard uses consistent color coding:| Color | Meaning | Example |
|---|---|---|
| 🟢 Green | Healthy, Active | System status indicator |
| 🔴 Red | Error, Inactive | System down or agent failed |
| 🟡 Yellow | Warning | Low performance score |
| 🔵 Blue | Info | General information messages |
Performance Scoring
Score Interpretation:- 90-100: Exceptional performance
- 80-89: Excellent performance
- 70-79: Good performance
- 60-69: Average performance
- 50-59: Below average, needs improvement
- 0-49: Poor performance, requires attention
Customizing the Dashboard
Changing Port
Run on a different port:http://localhost:8080
Branding Customization
Edit/source/dashboard/index.html to customize:
Adding Custom Metrics
Extend the dashboard with custom data:Troubleshooting
Dashboard Won’t Load
Symptoms:- Browser shows “Cannot connect”
- Page loads but shows errors
Data Not Updating
Symptoms:- Dashboard loads but shows stale data
- “Loading…” messages persist
- Force Refresh: Click the 🔄 button in bottom-right
- Check API Health:
- Review Browser Console: Open DevTools (F12) and check for JavaScript errors
- Restart Agent: Stop and restart the agent with
npm start
System Status Shows Red
Symptoms:- Status card shows 🔴 instead of 🟢
- Agent not fully initialized
- Database connection failed
- Missing credentials
Agents Show Less Than 7/7
Symptoms:- Agent Status card shows “5/7” or similar
- Some agents failed to initialize
- Check console logs for specific agent errors
- Verify all API credentials are configured
- Ensure sufficient API quotas
- Restart with
npm start
Mobile Access
Responsive Design
The dashboard is fully responsive:- Desktop: Full 6-card grid layout
- Tablet: 2-column responsive grid
- Mobile: Single-column stacked layout
Mobile Optimization Tips
- Buttons are touch-friendly (44px minimum hit area)
- Text is readable without zooming (16px base font)
- Cards stack vertically for easy scrolling
- Auto-refresh works seamlessly on mobile
Best Practices
Daily Monitoring
- Check system status is 🟢 green
- Verify all 7 agents are active
- Review upcoming schedule has 2-3 items
- Check performance metrics are improving
- Scan recent activity for errors
Weekly Review
- Analyze performance score trends
- Review top performing content
- Adjust content strategy if needed
- Verify automation schedule is working
- Check database backup was created
When to Take Action
Immediate Action Required:- 🔴 Red system status
- Less than 5/7 agents active
- No scheduled content
- Multiple errors in recent activity
- Performance score below 60
- Declining view counts
- Failed automation events
- System health below 80
Advanced Features
Browser Integration
Bookmark these URLs for quick access:- Main Dashboard:
http://localhost:3456 - Health Check:
http://localhost:3456/health - Analytics JSON:
http://localhost:3456/analytics - Schedule JSON:
http://localhost:3456/schedule
Embedding in Tools
Embed dashboard in other tools:API Integration
Build custom dashboards using the same APIs:Next Steps
API Reference
Explore all API endpoints used by the dashboard
Manual Operations
Learn manual control and API usage
Automation Schedule
Understand the automation schedule
Troubleshooting
Solve common dashboard issues