Documentation 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.
client.artifacts is the gateway to all AI-generated studio content in NotebookLM. You call a generation method to kick off an async task, poll or wait for it to complete, then download the result to a local file or export it to Google Docs or Sheets. Every generation method returns a GenerationStatus containing a task_id you pass to wait_for_completion() or poll_status().
Core methods
list(notebook_id, artifact_type)
Lists all artifacts in a notebook, including mind maps stored in the notes system.
The notebook ID.
Filter by type. Pass
ArtifactType.AUDIO, ArtifactType.REPORT, etc. None returns all types.List of
Artifact objects ordered by creation time.get(notebook_id, artifact_id)
Fetches a single artifact by ID.
Artifact object, or None if not found.delete(notebook_id, artifact_id)
Permanently deletes an artifact.
True when deletion succeeds.rename(notebook_id, artifact_id, new_title)
Renames an artifact.
poll_status(notebook_id, task_id)
Checks the current status of a generation task.
Object with
task_id, is_complete (bool), and status (str).wait_for_completion(notebook_id, task_id, timeout, poll_interval)
Polls until generation is complete or the timeout is reached.
The notebook ID.
The
task_id from the GenerationStatus returned by a generate method.Maximum seconds to wait before returning regardless of completion state.
Seconds between each status poll.
Final
GenerationStatus. Check final.is_complete before downloading.Type-specific list methods
Convenience wrappers aroundlist() that filter to a single artifact type.
| Method | Returns |
|---|---|
list_audio(notebook_id) | list[Artifact] — Audio Overviews |
list_video(notebook_id) | list[Artifact] — Video Overviews |
list_reports(notebook_id) | list[Artifact] — Briefing Docs, Study Guides, Blog Posts |
list_quizzes(notebook_id) | list[Artifact] — Quiz artifacts |
list_flashcards(notebook_id) | list[Artifact] — Flashcard artifacts |
list_infographics(notebook_id) | list[Artifact] — Infographic artifacts |
list_slide_decks(notebook_id) | list[Artifact] — Slide deck artifacts |
list_data_tables(notebook_id) | list[Artifact] — Data table artifacts |
Generation methods
generate_audio()
Generates an Audio Overview (podcast) from the notebook’s sources.
The notebook ID.
IDs of sources to include.
None uses all sources.BCP 47 language code for the output.
Custom instructions for the podcast hosts.
DEEP_DIVE · BRIEF · CRITIQUE · DEBATE. Defaults to DEEP_DIVE when None.SHORT · DEFAULT · LONG.generate_video()
Generates a Video Overview.
EXPLAINER · BRIEF.AUTO_SELECT · CLASSIC · WHITEBOARD · KAWAII · ANIME · WATERCOLOR · RETRO_PRINT · HERITAGE · PAPER_CRAFT.generate_cinematic_video()
Generates a cinematic-style video. This is a convenience wrapper around generate_video() with video_format=VideoFormat.CINEMATIC.
notebooklm generate cinematic-video "documentary-style summary"
generate_study_guide()
Generates a Study Guide report. This is a convenience wrapper around generate_report() with report_format=ReportFormat.STUDY_GUIDE.
generate_report()
Generates a report in one of four formats.
BRIEFING_DOC · STUDY_GUIDE · BLOG_POST · CUSTOM.Full generation prompt when
report_format=CUSTOM. Ignored for built-in formats.Additional instructions appended to the built-in template. Ignored when
report_format=CUSTOM (embed everything in custom_prompt instead).generate_quiz()
Generates a multiple-choice quiz.
FEWER · STANDARD · MORE (note: MORE is an alias for STANDARD in the API).EASY · MEDIUM · HARD.generate_flashcards()
Generates a set of flashcards.
generate_quiz().
generate_infographic()
Generates an infographic image.
LANDSCAPE · PORTRAIT · SQUARE.CONCISE · STANDARD · DETAILED.generate_slide_deck()
Generates a presentation slide deck.
DETAILED_DECK · PRESENTER_SLIDES.DEFAULT · SHORT.generate_data_table()
Generates a structured data table.
Natural language description of the desired table structure and columns.
generate_mind_map()
Generates an interactive mind map and saves it as a note.
Dict with
mind_map (parsed JSON tree with name and children keys) and note_id (the ID of the note where the mind map is stored).GenerationStatus dataclass
Task identifier. Pass to
poll_status() or wait_for_completion().True when the generation task has finished successfully.Status string such as
"completed", "processing", or "failed".Download methods
All download methods accept an optionalartifact_id. When omitted they automatically select the most recently completed artifact of that type. They raise ValueError if no completed artifact exists.
| Method | Output format | Notes |
|---|---|---|
download_audio(nb_id, output_path, artifact_id=None) | MP4/MP3 | |
download_video(nb_id, output_path, artifact_id=None) | MP4 | |
download_infographic(nb_id, output_path, artifact_id=None) | PNG | |
download_slide_deck(nb_id, output_path, artifact_id=None, output_format="pdf") | PDF or PPTX | output_format="pptx" also supported |
download_report(nb_id, output_path, artifact_id=None) | Markdown (.md) | Extracts markdown from Briefing Doc, Study Guide, Blog Post |
download_mind_map(nb_id, output_path, artifact_id=None) | JSON | Tree: {"name": "Topic", "children": [...]} |
download_data_table(nb_id, output_path, artifact_id=None) | CSV | UTF-8 with BOM for Excel compatibility |
download_quiz(nb_id, output_path, artifact_id=None, output_format="json") | JSON / Markdown / HTML | output_format: "json", "markdown", "html" |
download_flashcards(nb_id, output_path, artifact_id=None, output_format="json") | JSON / Markdown / HTML | JSON normalizes f/b keys to front/back |
Export methods
Export artifacts to Google Docs or Sheets. Requires the authenticated Google account to have write access.ExportType enum:
ExportType.DOCS— Export to Google DocsExportType.SHEETS— Export to Google Sheets
Complete generate → wait → download example
Artifact dataclass
Unique artifact identifier.
Display title.
Raw status code:
1=processing, 2=pending, 3=completed.Creation timestamp.
Download or preview URL when available.
Property returning an
ArtifactType str-enum (AUDIO, VIDEO, REPORT, QUIZ, FLASHCARDS, MIND_MAP, INFOGRAPHIC, SLIDE_DECK, DATA_TABLE, UNKNOWN).Property:
True when status == 3.Property:
True when the artifact is a quiz.Property:
True when the artifact is a flashcard set.