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.
notebooklm-py uses Python enums to configure generation options, filter results, and control sharing. Most enums are plain int enums (e.g., AudioFormat.DEEP_DIVE). Two enums—SourceType and ArtifactType—are str enums used by the .kind property on Source, SourceFulltext, and Artifact, enabling both enum and string comparisons without casting.
All enums are importable directly from the notebooklm package:
from notebooklm import AudioFormat, AudioLength, SourceType, ArtifactType
SourceType and ArtifactType are str enums. This means source.kind == "pdf" and source.kind == SourceType.PDF are both True. You can use them in f-strings without calling .value: f"{source.kind}" prints "pdf".
Audio generation
from notebooklm import AudioFormat, AudioLength
generate_audio().
| Member | Value | Description |
|---|
DEEP_DIVE | 1 | In-depth discussion (default) |
BRIEF | 2 | Quick summary |
CRITIQUE | 3 | Critical analysis |
DEBATE | 4 | Two-sided debate |
AudioLength
Controls the approximate duration of a generated podcast.
| Member | Value | Description |
|---|
SHORT | 1 | Shorter podcast |
DEFAULT | 2 | Standard length (default) |
LONG | 3 | Longer podcast |
status = await client.artifacts.generate_audio(
nb_id,
audio_format=AudioFormat.DEBATE,
audio_length=AudioLength.LONG,
)
Video generation
from notebooklm import VideoFormat, VideoStyle
| Member | Value | Description |
|---|
EXPLAINER | 1 | Educational explainer (default) |
BRIEF | 2 | Short overview |
VideoStyle
Controls the visual animation style of the generated video.
| Member | Value | Description |
|---|
AUTO_SELECT | 1 | Let NotebookLM choose (default) |
CUSTOM | 2 | Custom style |
CLASSIC | 3 | Classic style |
WHITEBOARD | 4 | Whiteboard animation |
KAWAII | 5 | Kawaii / cute anime style |
ANIME | 6 | Anime style |
WATERCOLOR | 7 | Watercolor painting style |
RETRO_PRINT | 8 | Retro print / vintage style |
HERITAGE | 9 | Heritage / classic illustration |
PAPER_CRAFT | 10 | Paper craft / cut-out style |
status = await client.artifacts.generate_video(
nb_id,
video_format=VideoFormat.EXPLAINER,
video_style=VideoStyle.KAWAII,
)
Quiz and flashcards
from notebooklm import QuizQuantity, QuizDifficulty
QuizQuantity
Controls how many quiz questions or flashcards are generated.
| Member | Value | Description |
|---|
FEWER | 1 | Fewer questions |
STANDARD | 2 | Standard quantity (default) |
MORE | 2 | Alias for STANDARD (used by CLI and web UI) |
QuizQuantity.MORE is an alias for QuizQuantity.STANDARD—they share the same integer value 2. Both generate the same number of items.
QuizDifficulty
Controls the difficulty level of generated quizzes and flashcards.
| Member | Value | Description |
|---|
EASY | 1 | Foundational concepts |
MEDIUM | 2 | Intermediate difficulty (default) |
HARD | 3 | Advanced / challenging |
status = await client.artifacts.generate_quiz(
nb_id,
quantity=QuizQuantity.MORE,
difficulty=QuizDifficulty.HARD,
)
Reports
from notebooklm import ReportFormat
| Member | Value | Description |
|---|
BRIEFING_DOC | 1 | Executive briefing document (default) |
STUDY_GUIDE | 2 | Study guide with key concepts |
BLOG_POST | 3 | Blog-style article |
CUSTOM | 4 | Fully custom prompt via custom_prompt |
status = await client.artifacts.generate_report(
nb_id,
report_format=ReportFormat.STUDY_GUIDE,
extra_instructions="Target audience: beginners",
)
Infographics
from notebooklm import InfographicOrientation, InfographicDetail
InfographicOrientation
Controls the aspect ratio of the generated infographic image.
| Member | Value | Description |
|---|
LANDSCAPE | 1 | Wider than tall |
PORTRAIT | 2 | Taller than wide |
SQUARE | 3 | Equal dimensions |
InfographicDetail
Controls how much information is packed into the infographic.
| Member | Value | Description |
|---|
CONCISE | 1 | Minimal, high-level overview |
STANDARD | 2 | Balanced detail (default) |
DETAILED | 3 | Dense, comprehensive |
Slide decks
from notebooklm import SlideDeckFormat, SlideDeckLength
| Member | Value | Description |
|---|
DETAILED_DECK | 1 | Full slides with content (default) |
PRESENTER_SLIDES | 2 | Presenter-focused with speaker notes |
SlideDeckLength
Controls the approximate number of slides generated.
| Member | Value | Description |
|---|
DEFAULT | 1 | Standard slide count (default) |
SHORT | 2 | Fewer slides |
Export
from notebooklm import ExportType
ExportType
Controls the target Google Workspace application when exporting an artifact.
| Member | Value | Description |
|---|
DOCS | 1 | Export to Google Docs |
SHEETS | 2 | Export to Google Sheets |
result = await client.artifacts.export_report(
nb_id,
artifact_id="report_123",
title="My Briefing Doc",
export_type=ExportType.DOCS,
)
Sharing
from notebooklm import ShareAccess, ShareViewLevel, SharePermission
ShareAccess
Controls who can access the notebook via a link.
| Member | Value | Description |
|---|
RESTRICTED | 0 | Only explicitly shared users |
ANYONE_WITH_LINK | 1 | Anyone with the share URL |
ShareViewLevel
Controls what content viewers can access in a shared notebook.
| Member | Value | Description |
|---|
FULL_NOTEBOOK | 0 | Chat, sources, and notes |
CHAT_ONLY | 1 | Chat interface only |
SharePermission
Controls what a shared user can do in the notebook.
| Member | Value | Description |
|---|
OWNER | 1 | Full control (read-only, cannot be assigned) |
EDITOR | 2 | Can edit notebook content |
VIEWER | 3 | Read-only access (default when sharing) |
from notebooklm import SharePermission, ShareViewLevel
await client.sharing.add_user(nb_id, "colleague@example.com", SharePermission.EDITOR)
await client.sharing.set_view_level(nb_id, ShareViewLevel.CHAT_ONLY)
Source and artifact types
These are str enums returned by the .kind property. They support both enum and string comparisons.
from notebooklm import SourceType, ArtifactType
SourceType
Returned by Source.kind and SourceFulltext.kind. Use these values to identify source content types.
| Member | String value | Description |
|---|
GOOGLE_DOCS | "google_docs" | Google Docs document |
GOOGLE_SLIDES | "google_slides" | Google Slides presentation |
GOOGLE_SPREADSHEET | "google_spreadsheet" | Google Sheets spreadsheet |
PDF | "pdf" | PDF file |
PASTED_TEXT | "pasted_text" | Pasted/typed text |
WEB_PAGE | "web_page" | Web URL |
GOOGLE_DRIVE_AUDIO | "google_drive_audio" | Audio file from Google Drive |
GOOGLE_DRIVE_VIDEO | "google_drive_video" | Video file from Google Drive |
YOUTUBE | "youtube" | YouTube video |
MARKDOWN | "markdown" | Markdown file |
DOCX | "docx" | Microsoft Word document |
CSV | "csv" | CSV spreadsheet |
EPUB | "epub" | EPUB e-book file |
IMAGE | "image" | Image file (OCR’d) |
MEDIA | "media" | Other audio or video file |
UNKNOWN | "unknown" | Unrecognized type (see UnknownTypeWarning) |
sources = await client.sources.list(nb_id)
for src in sources:
if src.kind == SourceType.PDF:
print(f"PDF: {src.title}")
elif src.kind == SourceType.YOUTUBE:
print(f"Video: {src.url}")
elif src.kind == "web_page": # string comparison also works
print(f"Web: {src.url}")
ArtifactType
Returned by Artifact.kind. Quizzes and flashcards share the same internal type code but are automatically distinguished by the library.
| Member | String value | Description |
|---|
AUDIO | "audio" | Audio overview (podcast) |
VIDEO | "video" | Video overview |
REPORT | "report" | Briefing doc, study guide, or blog post |
QUIZ | "quiz" | Quiz with multiple-choice questions |
FLASHCARDS | "flashcards" | Flashcard deck |
MIND_MAP | "mind_map" | Mind map (hierarchical JSON) |
INFOGRAPHIC | "infographic" | Infographic image |
SLIDE_DECK | "slide_deck" | Slide deck (PDF or PPTX) |
DATA_TABLE | "data_table" | Data table (CSV) |
UNKNOWN | "unknown" | Unrecognized type (see UnknownTypeWarning) |
artifacts = await client.artifacts.list(nb_id)
for art in artifacts:
if art.kind == ArtifactType.AUDIO and art.is_completed:
await client.artifacts.download_audio(nb_id, f"{art.title}.mp4")
SourceStatus
Internal processing status for sources. Use Source.is_ready, Source.is_processing, and Source.is_error properties instead of comparing integers.
| Member | Value | Description |
|---|
PROCESSING | 1 | Being indexed (use source wait to poll) |
READY | 2 | Indexed and available |
ERROR | 3 | Processing failed |
PREPARING | 5 | Pre-processing / upload stage |
Chat configuration
from notebooklm import ChatGoal, ChatResponseLength, ChatMode
ChatGoal
RPC-level enum passed to client.chat.configure() to set the chat persona.
| Member | Value | Description |
|---|
DEFAULT | 1 | General-purpose assistant (default) |
CUSTOM | 2 | Uses a custom_prompt for persona |
LEARNING_GUIDE | 3 | Educational focus |
ChatResponseLength
Controls the verbosity of chat answers.
| Member | Value | Description |
|---|
DEFAULT | 1 | Standard length (default) |
LONGER | 4 | More detailed responses |
SHORTER | 5 | More concise responses |
ChatMode
Service-level enum providing named presets for configure(). Use ChatMode for readable configuration; use ChatGoal when you need low-level RPC control.
| Member | String value | Description |
|---|
DEFAULT | "default" | General-purpose assistant |
LEARNING_GUIDE | "learning_guide" | Educational focus |
CONCISE | "concise" | Brief responses |
DETAILED | "detailed" | Verbose responses |
from notebooklm import ChatGoal, ChatResponseLength
await client.chat.configure(
nb_id,
goal=ChatGoal.LEARNING_GUIDE,
response_length=ChatResponseLength.LONGER,
custom_prompt="Focus on practical applications",
)
Google Drive MIME types
from notebooklm import DriveMimeType
DriveMimeType
MIME type values for use with client.sources.add_drive().
| Member | MIME type |
|---|
DOCUMENT | application/vnd.google-apps.document |
SPREADSHEET | application/vnd.google-apps.spreadsheet |
PRESENTATION | application/vnd.google-apps.presentation |
from notebooklm import DriveMimeType
await client.sources.add_drive(
nb_id,
file_id="1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms",
title="Q4 Report",
mime_type=DriveMimeType.SPREADSHEET,
)
