# Nesoi Documentation for AI Agents

> Nesoi is an AI-powered interactive video learning platform. Users create videos with AI-generated content, customizable visuals, and real-time AI tutoring. This documentation covers the dashboard, video creation, and video player.

## Documentation Files

### Getting Started
- https://helpdocs.nesoi.ai/getting-started/welcome.md - Introduction to Nesoi platform
- https://helpdocs.nesoi.ai/getting-started/quick-start.md - Create your first interactive video in minutes

### Video Creation
- https://helpdocs.nesoi.ai/video-creation/chapters-and-sections.md - Chapters, chapter types (general, quiz, roleplay, case study, simulation, screen share, feedback, video, dynamic), and content organization
- https://helpdocs.nesoi.ai/video-creation/visual-editing.md - Editing visual elements, adding animations, and unlocking dynamic elements for AI personalization
- https://helpdocs.nesoi.ai/video-creation/avatar-settings.md - Per-chapter avatar positioning, size, shape, and visibility
- https://helpdocs.nesoi.ai/video-creation/speaking-notes.md - Instructor notes, speaking scripts, interaction notes, and personalized variables ({{viewer_name}}, {{personalized_answer1}})
- https://helpdocs.nesoi.ai/video-creation/using-ai-assistant.md - Using Ask AI to generate and modify content, plan mode, undoing changes, and request queue
- https://helpdocs.nesoi.ai/video-creation/settings.md - Global vs per-video settings, instructor persona, avatars and voices, custom avatars, TTS speed, personalization questions, progress bar, language and translation, pronunciations, response timing, onboarding options
- https://helpdocs.nesoi.ai/video-creation/ai-conversations.md - Viewing viewer conversations with the AI for a specific video
- https://helpdocs.nesoi.ai/video-creation/themes.md - Style templates, reference video templates, UI component templates, themes, and custom theme creation
- https://helpdocs.nesoi.ai/video-creation/evaluations.md - Testing AI instructor with simulated viewers, evaluation criteria, pass/fail scoring
- https://helpdocs.nesoi.ai/video-creation/sharing.md - Sharing videos via direct link, iframe embed, or floating widget embed

### Video Player
- https://helpdocs.nesoi.ai/video-player/overview.md - Player components, viewer journey, chapter type experiences, and device support
- https://helpdocs.nesoi.ai/video-player/viewer-interactions.md - Chat, quiz, roleplay interactions, navigation, feedback, and accessibility
- https://helpdocs.nesoi.ai/video-player/playback-controls.md - Volume, TTS speed, fullscreen, microphone, camera, and keyboard shortcuts

### Dashboard Management
- https://helpdocs.nesoi.ai/dashboard/bulk-actions.md - Folder management, bulk create, bulk edit, and bulk actions (select, move, delete)
- https://helpdocs.nesoi.ai/dashboard/conversations.md - Analytics, search, filtering, and message review across all viewer conversations
- https://helpdocs.nesoi.ai/dashboard/organization-settings.md - Team management, member roles, profile settings, appearance, and theme editor
- https://helpdocs.nesoi.ai/dashboard/onboarding-customization.md - Branding onboarding screens: logo, colors, screen text, typography, spacing, and custom loading HTML

## Architecture Diagrams

### Dashboard UI Architecture

```mermaid
graph TB
    subgraph "Authentication"
        Home["/"]
        SignIn["/sign-in"]
        SignUp["/sign-up"]
    end

    subgraph "Organization Layout /org/[slug]"
        OrgLayout["Organization Context"]

        subgraph "Dashboard /dashboard"
            DashboardLayout["Dashboard Layout<br/>(Sidebar + Main)"]

            subgraph "Main Tabs"
                HomeTab["Home Tab<br/>(AI Prompt, Theme Editor,<br/>Templates, Recent Videos)"]
                VideosTab["Your Videos Tab<br/>(Folders, Search, Grid,<br/>Bulk Actions)"]
                ConversationsTab["Conversations Tab<br/>(Stats, Search,<br/>Message History)"]
            end

            subgraph "Sidebar"
                TeamSwitcher["Team Switcher<br/>(Organization Selection)"]
                NavMenu["Navigation Menu<br/>(Home, Videos, Conversations)"]
                UserDropdown["User Dropdown<br/>(Account, Settings, Theme)"]
            end
        end

        subgraph "Video Editor /dashboard/edit/[video_url]"
            EditorLayout["Editor Layout"]

            subgraph "Editor Tabs"
                VisualsTab["Visuals Tab<br/>(Visual Editing)"]
                ConvTab["Conversations Tab<br/>(Viewer Conversations)"]
                SettingsTab["Settings Tab<br/>(Instructor, Avatar,<br/>Personalization, Language)"]
                EvalTab["Evaluations Tab<br/>(AI Testing)"]
            end

            subgraph "Editor Components"
                AIPanel["AI Agent Panel<br/>(Modules, Prompts)"]
                ThemeEditor["Theme Editor<br/>(Colors, Fonts)"]
                TranscriptEditor["Transcript Editor<br/>(Speaking Notes)"]
            end
        end

        subgraph "Account Pages"
            MyAccount["/my-account<br/>(Profile Settings)"]
            OrgSettings["Organization Settings<br/>(Team Members)"]
        end
    end

    Home -->|Not signed in| SignIn
    Home -->|Signed in| OrgLayout
    SignIn --> OrgLayout
    SignUp --> OrgLayout

    OrgLayout --> DashboardLayout
    DashboardLayout --> HomeTab
    DashboardLayout --> VideosTab
    DashboardLayout --> ConversationsTab

    DashboardLayout --> TeamSwitcher
    DashboardLayout --> NavMenu
    DashboardLayout --> UserDropdown

    VideosTab -->|Edit Video| EditorLayout
    HomeTab -->|Create Video| EditorLayout

    EditorLayout --> VisualsTab
    EditorLayout --> ConvTab
    EditorLayout --> SettingsTab
    EditorLayout --> EvalTab
    EditorLayout --> AIPanel
    EditorLayout --> ThemeEditor
    EditorLayout --> TranscriptEditor

    UserDropdown --> MyAccount
    UserDropdown --> OrgSettings

    style Home fill:#e3f2fd
    style DashboardLayout fill:#f3e5f5
    style EditorLayout fill:#e8f5e9
    style HomeTab fill:#fff3e0
    style VideosTab fill:#fff3e0
    style ConversationsTab fill:#fff3e0
```

### Video Player UI Architecture

```mermaid
graph TB
    subgraph "User Onboarding"
        Welcome["Welcome Page<br/>(Lesson Title + Play Button)"]
        Intro["Intro Page<br/>(Name & Email Collection)"]
        LangQ["Language Questions<br/>(Language + Personalization)"]
        Avatar["Avatar Selection<br/>(Avatar & Voice Preview)"]
        Loading["Loading Page<br/>(Connection Progress)"]
    end

    subgraph "Main Session View"
        SessionView["Session View<br/>(Main Video Player)"]

        subgraph "Content Display"
            SlidePlayer["Slide Player<br/>(Current Visual)"]
            Templates["Template Renderer"]
            Transcription["Live Transcription"]
        end

        subgraph "User Interaction"
            Chat["Chat Input<br/>(Ask Questions)"]
            Suggestions["AI Suggestions<br/>(Conversation Starters)"]
            MediaControls["Media Controls<br/>(Mic/Camera/Speaker)"]
        end

        subgraph "Agent Display"
            AvatarTile["Avatar Tile<br/>(AI Instructor)"]
            ControlBar["Control Bar<br/>(Pause/Interrupt)"]
        end
    end

    subgraph "Content Templates"
        DefaultT["General<br/>(Text + Images)"]
        QuizT["Quiz<br/>(Multiple Choice)"]
        RoleplayT["Roleplay<br/>(Conversation Practice)"]
        SimT["Simulation<br/>(Drawing Canvas)"]
        CaseT["Case Study<br/>(Probing Questions)"]
        ScreenT["Screen Share<br/>(Walkthrough)"]
        FeedbackT["Feedback<br/>(Structured Input)"]
        VideoT["Video<br/>(Media Playback)"]
        DynamicT["Dynamic<br/>(AI-Personalized)"]
    end

    subgraph "Backend Communication"
        LiveKit["LiveKit WebSocket<br/>(Audio/Video Streaming)"]
        DataChannel["Data Channel<br/>(Slide Sync, Quiz Data)"]
        APIs["REST APIs<br/>(Preferences, Quiz Answers)"]
    end

    subgraph "End Experience"
        EndScreen["End Screen<br/>(Completion Summary)"]
        Webhook["Completion Webhook"]
    end

    Welcome -->|Click Play| Intro
    Intro -->|Submit Info| LangQ
    LangQ -->|Select Language| Avatar
    Avatar -->|Choose Avatar| Loading
    Loading -->|Connected| SessionView

    SessionView --> SlidePlayer
    SessionView --> Templates
    SessionView --> Transcription
    SessionView --> Chat
    SessionView --> Suggestions
    SessionView --> MediaControls
    SessionView --> AvatarTile
    SessionView --> ControlBar

    Templates --> DefaultT
    Templates --> QuizT
    Templates --> RoleplayT
    Templates --> SimT
    Templates --> CaseT
    Templates --> ScreenT
    Templates --> FeedbackT
    Templates --> VideoT
    Templates --> DynamicT

    SessionView <--> LiveKit
    SessionView <--> DataChannel
    SessionView <--> APIs

    SessionView -->|Lesson Complete| EndScreen
    EndScreen --> Webhook

    style Welcome fill:#e1f5fe
    style SessionView fill:#f3e5f5
    style LiveKit fill:#c8e6c9
    style EndScreen fill:#fff9c4
```

## Key Concepts

### Chapters
Videos are organized into chapters. Each chapter has:
- A type (general, quiz, roleplay, case study, simulation, screen share, feedback, video, dynamic)
- Visual content (what viewers see)
- Speaking notes (what the AI avatar says)
- Interaction notes (how AI responds to questions)

### Personalized Variables
Content can be personalized per viewer using `{{variable_name}}` syntax:
- System variables: `{{viewer_name}}`, `{{viewer_email}}`
- Question variables: `{{personalized_answer1}}`, `{{personalized_answer2}}` (from personalization questions)

### Dynamic Elements
Text elements in visuals can be "unlocked for AI" so the AI personalizes them per viewer at runtime.

### AI Assistant
The Ask AI panel in the editor allows natural language requests to:
- Generate new chapters
- Modify existing content
- Edit visuals
- Create quizzes and roleplays
- Plan mode: generate outlines before full content

### Global vs Per-Video Settings
Settings like instructor persona, avatars, pronunciations, and onboarding branding can be applied globally to all videos or overridden per video.

### Templates vs Themes
- Templates: Complete design systems that guide AI-generated layouts (style, UI component, landing page, or reference video)
- Themes: Colors, fonts, and CSS variables for brand customization

### Chapter Types
- General: Standard content with visuals and narration
- Quiz: Multiple-choice questions with feedback
- Roleplay: Conversational practice scenarios
- Case Study: Decision-making with probing questions
- Simulation: Interactive drawing canvas
- Screen Share: Recorded walkthroughs with AI narration
- Feedback: Structured feedback collection
- Video: Uploaded video/media playback
- Dynamic: Custom interactive content with AI-personalized elements

## API/Integration Notes

Videos can be embedded using iframe:
```html
<iframe src="https://app.nesoi.ai/videos/{video-id}" width="100%" height="600"></iframe>
```

Or as a floating widget button using the script embed from the Share dialog.