Skip to main content
Treat pipeline events as the canonical progress interface for dashboard and custom UI integrations. Do not derive progress from log text.
notewise emits typed events from the processing pipeline. The Rich dashboard and plain --no-ui output modes both subscribe to this stream.

​
Event Object

Each event contains:
FieldDescription
event_typeThe event identifier (e.g., VIDEO_SUCCESS, TRANSCRIPT_FETCHED)
video_idYouTube video ID
titleVideo title
chapter_numberCurrent chapter index (for chapter-aware videos)
total_chaptersTotal chapters in video
chunk_numberCurrent chunk index during generation
total_chunksTotal chunks to process
errorError message if the event represents a failure
output_pathPath to generated output file

​
Event Types

1

Pipeline

EventDescription
PIPELINE_STARTPipeline run started
PIPELINE_COMPLETEPipeline run finished
2

Metadata

EventDescription
METADATA_STARTMetadata fetch started
METADATA_FETCHEDMetadata fetched successfully
3

Transcript

EventDescription
TRANSCRIPT_FETCHINGTranscript retrieval started
TRANSCRIPT_FETCHEDTranscript retrieval complete
4

Generation

EventDescription
GENERATION_STARTFlat generation started
CHUNK_GENERATINGTranscript chunk generation in progress
GENERATION_COMBININGMulti-chunk combine stage
GENERATION_COMPLETEMain notes generation complete
5

Chapter

EventDescription
CHAPTER_GENERATINGChapter generation started
CHAPTER_CHUNK_GENERATINGChapter chunk generation progress
CHAPTER_COMBININGChapter combine stage
CHAPTER_COMPLETEChapter generation complete
6

Quiz

EventDescription
QUIZ_GENERATINGQuiz generation started
QUIZ_CHUNK_GENERATINGQuiz chunk generation progress
QUIZ_COMBININGQuiz combine stage
QUIZ_COMPLETEQuiz generation complete
7

Final

EventDescription
VIDEO_SUCCESSVideo completed successfully
VIDEO_SKIPPEDVideo skipped due to cache/output checks
VIDEO_FAILEDVideo failed with error context

​
Typical event sequences

PIPELINE_START
METADATA_START → METADATA_FETCHED
TRANSCRIPT_FETCHING → TRANSCRIPT_FETCHED
GENERATION_START
CHUNK_GENERATING × n
GENERATION_COMBINING  (only if multi-chunk)
GENERATION_COMPLETE
VIDEO_SUCCESS
PIPELINE_COMPLETE

​
Integration

  • Use events as the source of truth for progress UI
  • For custom frontends, subscribe through the pipeline on_event callback and render by event_type
  • Avoid deriving progress solely from log text — the event stream is the stable API
Last modified on March 28, 2026