Documentation

Scribez Documentation

Welcome to the Scribez documentation. This guide will help you understand how to use all of Scribez's features effectively.

What is Scribez?

Scribez is an AI-powered note-taking platform that transforms your lectures, meetings, and audio content into organized, searchable notes, flashcards, and study materials. Our platform uses advanced AI to transcribe audio, generate summaries, and create personalized learning materials.

Key Features

  • Audio Transcription: Convert audio files to text with high accuracy
  • AI Summaries: Generate structured notes from your content
  • Flashcard Generation: Create study cards automatically
  • Study Guides: Comprehensive study materials tailored to your content
  • Course Organization: Organize content by subject or topic

Authentication

Scribez uses session-based authentication with Flask-Login. Users must create an account and log in to access the platform.

Creating an Account

To create an account, visit the registration page and provide:

  • Username (unique)
  • Email address
  • Password (minimum 8 characters)

Logging In

Use your username/email and password to log in. Sessions are maintained until you log out or the session expires.

Courses

Courses are the primary organizational unit in Scribez. Each course can contain multiple transcripts, notes, flashcards, and study materials.

Creating a Course

  1. Navigate to "My Courses" from the main menu
  2. Click "Create New Course"
  3. Enter course title and description
  4. Click "Create Course"

Course Dashboard

Each course has a dedicated dashboard with access to:

  • Audio uploads and recordings
  • Transcripts and notes
  • Flashcards
  • Study guides

Transcripts

Transcripts are generated from audio content using OpenAI's Whisper model for high-accuracy speech-to-text conversion.

Supported Audio Formats

  • MP3 (recommended)
  • WAV
  • M4A
  • WEBM
  • OGG

Upload Process

  1. Go to your course dashboard
  2. Click "Upload Audio" or use the recording feature
  3. Select your audio file (max 50MB for free accounts)
  4. Wait for transcription to complete
  5. Review and edit the transcript if needed

Transcription Accuracy

Transcription accuracy depends on:

  • Audio quality and clarity
  • Background noise levels
  • Speaker pronunciation
  • Audio format and bitrate

Notes & Summaries

AI-generated summaries transform your transcripts into structured, organized notes that highlight key concepts and information.

Automatic Generation

Notes are automatically generated after transcription using GPT-4 to:

  • Extract key concepts and themes
  • Create structured outlines
  • Identify important definitions
  • Highlight actionable items

Customization

You can customize note generation by:

  • Editing generated summaries
  • Adding your own insights
  • Reorganizing content structure
  • Combining multiple session notes

Export Options

Notes can be exported as:

  • PDF files
  • Plain text files
  • Combined session summaries

Flashcards

Generate flashcards automatically from your content to enhance memorization and active recall.

Generation Process

  1. Navigate to the Flashcards section in your course
  2. Click "Generate Flashcards"
  3. Select content source (specific transcript or all content)
  4. Choose difficulty level and quantity
  5. Review and edit generated cards

Flashcard Types

  • Definition Cards: Term on front, definition on back
  • Question Cards: Question on front, answer on back
  • Concept Cards: Key concepts with explanations

Study Mode

Interactive study mode includes:

  • Card flipping animation
  • Progress tracking
  • Difficulty-based sorting
  • Spaced repetition recommendations

Study Guides

Comprehensive study guides synthesize all your course content into structured study materials.

Generation Options

Study guides can be generated with different focus areas:

  • Comprehensive: All course content
  • Exam Focused: Key concepts for testing
  • Topic Specific: Focused on particular subjects
  • Quick Review: Condensed overview

Content Structure

Study guides include:

  • Learning objectives
  • Key concepts summary
  • Important definitions
  • Practice questions
  • Review checklist

Download and Sharing

Study guides can be:

  • Downloaded as PDF
  • Printed for offline study
  • Shared with study groups

Rate Limits

Scribez implements rate limiting to ensure fair usage and system stability.

Current Limits

  • Global: 200 requests per day, 50 per hour
  • Audio Upload: 5 requests per minute
  • AI Generation: 10 requests per minute
  • File Size: 50MB per file (free accounts)

Premium Accounts

Premium accounts have higher limits:

  • 500 requests per day, 100 per hour
  • 100MB file size limit
  • Priority processing
  • Extended storage

Error Handling

Understanding common errors and how to resolve them.

Common Errors

File Too Large

Cause: Audio file exceeds size limit

Solution: Compress audio or upgrade to premium

Transcription Failed

Cause: Poor audio quality or unsupported format

Solution: Check audio format and quality

Rate Limit Exceeded

Cause: Too many requests in short period

Solution: Wait before making additional requests

AI Generation Error

Cause: Insufficient content or API issues

Solution: Ensure adequate content and retry