TheDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/teng-lin/notebooklm-py/llms.txt
Use this file to discover all available pages before exploring further.
generate command group creates AI content from your notebook sources. Most subcommands are asynchronous by default: they start generation and return immediately with a task_id, so you can continue working while the content is produced in the background. The only synchronous exception is mind-map, which completes instantly.
Generation tasks can take anywhere from seconds (
mind-map) to 30+ minutes (complex video or audio). For LLM agents, avoid --wait and instead poll with artifact wait <id> in a separate step.-s, --source ID— limit generation to specific sources (repeatable)--json— return{"task_id": "...", "status": "..."}for scripting--language CODE— override the output language (defaults to account setting oren)--retry N— automatically retry on rate limits with exponential backoff--wait— wait inline for completion (not recommended for agents)
audio — generate a podcast
audio — generate a podcast
Generate an audio overview in podcast format from your notebook sources.
| Option | Values | Default | Description |
|---|---|---|---|
--format | deep-dive, brief, critique, debate | deep-dive | Podcast discussion format |
--length | short, default, long | default | Approximate duration |
--language | BCP-47 code | account setting | Output language |
-s, --source | Source ID | all sources | Limit to specific source(s) |
--wait | — | off | Wait for completion inline |
--json | — | off | Machine-readable output |
--retry N | integer | 0 | Retries on rate limit with backoff |
video — generate a video overview
video — generate a video overview
Generate a video overview with animated visuals from your notebook sources.
| Option | Values | Default | Description |
|---|---|---|---|
--format | explainer, brief | explainer | Video format |
--style | auto, classic, whiteboard, kawaii, anime, watercolor, retro-print, heritage, paper-craft | auto | Visual animation style |
--language | BCP-47 code | account setting | Output language |
-s, --source | Source ID | all sources | Limit to specific source(s) |
--wait | — | off | Wait for completion inline |
--json | — | off | Machine-readable output |
cinematic-video — generate a cinematic video
cinematic-video — generate a cinematic video
Alias for
generate video --format cinematic. Generates a cinematic-style video overview. Accepts the same --style and other options as video.slide-deck — generate a slide presentation
slide-deck — generate a slide presentation
Generate a slide deck from your notebook sources. Download as PDF (default) or editable PPTX with
notebooklm download slide-deck --format pptx.| Option | Values | Default | Description |
|---|---|---|---|
--format | detailed, presenter | detailed | Slide template |
--length | default, short | default | Approximate slide count |
--wait | — | off | Wait for completion inline |
--json | — | off | Machine-readable output |
revise-slide — revise an individual slide
revise-slide — revise an individual slide
Revise a specific slide in an existing slide deck using a natural-language description. The slide deck must already be fully generated before you can revise individual slides.
Use
| Option | Values | Description |
|---|---|---|
-a, --artifact ID | Artifact ID | Required. The slide deck to revise |
--slide N | Integer | Required. Zero-based slide index (0 = first slide) |
--wait | — | Wait for revision to complete |
--json | — | Machine-readable output |
notebooklm artifact list --type slide-deck to find the artifact ID for an existing slide deck.quiz — generate a quiz
quiz — generate a quiz
Generate a multiple-choice quiz based on your notebook sources.
Download the quiz after generation with
| Option | Values | Default | Description |
|---|---|---|---|
--difficulty | easy, medium, hard | medium | Question difficulty |
--quantity | fewer, standard, more | standard | Number of questions |
-s, --source | Source ID | all sources | Limit to specific source(s) |
--wait | — | off | Wait for completion inline |
--json | — | off | Machine-readable output |
notebooklm download quiz --format markdown.flashcards — generate flashcards
flashcards — generate flashcards
Generate a flashcard deck for studying. Options match those for
quiz.| Option | Values | Default | Description |
|---|---|---|---|
--difficulty | easy, medium, hard | medium | Card difficulty |
--quantity | fewer, standard, more | standard | Number of cards |
-s, --source | Source ID | all sources | Limit to specific source(s) |
--wait | — | off | Wait for completion inline |
--json | — | off | Machine-readable output |
infographic — generate an infographic
infographic — generate an infographic
Generate a visual infographic summarizing your notebook sources.
| Option | Values | Default | Description |
|---|---|---|---|
--orientation | landscape, portrait, square | — | Image orientation |
--detail | concise, standard, detailed | standard | Information density |
--style | auto, sketch-note, professional, bento-grid, editorial, instructional, bricks, clay, anime, kawaii, scientific | auto | Visual style |
--wait | — | off | Wait for completion inline |
--json | — | off | Machine-readable output |
data-table — generate a data table
data-table — generate a data table
Generate a structured data table from your notebook sources. The description is required and should specify what data to extract.
Download the result with
| Option | Values | Description |
|---|---|---|
--wait | — | Wait for completion inline |
--json | — | Machine-readable output |
notebooklm download data-table ./data.csv. The CSV uses UTF-8 with BOM encoding for Excel compatibility.mind-map — generate a mind map
mind-map — generate a mind map
Generate a hierarchical mind map. This is the only synchronous generate command — it completes immediately and requires no
Download the mind map as a JSON tree with
--wait option.| Option | Values | Description |
|---|---|---|
--json | — | Machine-readable output |
notebooklm download mind-map ./map.json. The JSON structure is {"name": "Topic", "children": [{"name": "Subtopic", "children": [...]}]}.report — generate a text report
report — generate a text report
Generate a structured text report. Choose from built-in templates or write a fully custom prompt.
| Option | Values | Default | Description |
|---|---|---|---|
--format | briefing-doc, study-guide, blog-post, custom | briefing-doc | Report template |
--append TEXT | Text string | — | Append extra instructions to a built-in template |
-s, --source | Source ID | all sources | Limit to specific source(s) |
--wait | — | off | Wait for completion inline |
--json | — | off | Machine-readable output |
--append adds instructions to the end of a built-in template prompt. It has no effect when --format custom is used; for custom reports, put your full prompt in the description argument.Async behavior reference
| Command | Async? | Notes |
|---|---|---|
audio | Yes | Returns task_id. Audio can take 2–15 minutes. |
video | Yes | Returns task_id. Video can take 5–30+ minutes. |
cinematic-video | Yes | Alias for video --format cinematic. |
slide-deck | Yes | Returns task_id. |
revise-slide | Yes | Returns task_id. |
quiz | Yes | Returns task_id. |
flashcards | Yes | Returns task_id. |
infographic | Yes | Returns task_id. |
data-table | Yes | Returns task_id. |
mind-map | No | Synchronous. Completes immediately. |
report | Yes | Returns task_id. |
notebooklm artifact poll <task_id> or block with notebooklm artifact wait <id>.