nblm-rs Documentation¶
Complete documentation for the NotebookLM Enterprise API client (CLI & Python SDK).
Unofficial Project
This project is not affiliated with, sponsored, or endorsed by Google. nblm-rs is an independent, unofficial tool. It is provided "as is" without any warranty.
Getting Started¶
New to nblm-rs? Start here:
- Installation - Install CLI or Python SDK
- Authentication - Set up authentication with gcloud
- Configuration - Project numbers, locations, environment variables
Features¶
API Status
The NotebookLM API is currently in alpha. Some features may not work as documented due to API limitations. See API Limitations for details.
Notebooks¶
| Feature | CLI | Python | Status | Notes |
|---|---|---|---|---|
| Create notebook | ✅ | ✅ | Working | |
| List recent notebooks | ✅ | ✅ | Working | Pagination not implemented by API |
| Delete notebook(s) | ✅ | ✅ | Working | Sequential deletion (API limitation) |
Sources¶
| Feature | CLI | Python | Status | Notes |
|---|---|---|---|---|
| Add web URL | ✅ | ✅ | Working | |
| Add text content | ✅ | ✅ | Working | |
| Add video (YouTube) | ✅ | ✅ | Working | Uses youtubeUrl field |
| Add Google Drive | ✅ | ✅ | Working | Requires Drive-enabled auth |
| Upload file | ✅ | ✅ | Working | |
| Delete source(s) | ✅ | ✅ | Working | |
| Get source by ID | ✅ | ✅ | Working |
Audio Overview¶
| Feature | CLI | Python | Status | Notes |
|---|---|---|---|---|
| Create audio overview | ✅ | ✅ | Working | Config fields not supported |
| Delete audio overview | ✅ | ✅ | Working |
Sharing¶
| Feature | CLI | Python | Status | Notes |
|---|---|---|---|---|
| Share notebook | ✅ | ❌ | Untested | Requires additional users |
CLI Reference¶
Complete command-line interface documentation:
- CLI Overview - Command structure and common options
- Notebooks Commands - Create, list, and delete notebooks
- Sources Commands - Add, upload, and manage sources
- Audio Commands - Create and delete audio overviews
- Doctor Command - Run environment diagnostics
Python SDK Reference¶
Python bindings documentation:
- Python SDK Overview - Installation and basic usage
- Quickstart - Get started in 5 minutes
- API Reference - All classes and methods
- Source Management - Source operations in detail
- Notebooks API - Notebook operations in detail
- Audio API - Audio overview operations
- Error Handling - Exception handling patterns
Rust SDK¶
Rust library documentation:
- Getting Started - Rust SDK setup and usage
Work in Progress
The Rust SDK is currently being refactored. The Getting Started guide will be updated once the new core APIs are finalized.
Guides¶
Additional guides and tutorials:
- Troubleshooting - Common issues and solutions
API Information¶
- API Limitations - Known limitations and workarounds
- NotebookLM API Documentation - Official API docs
Contributing¶
- Contributing Guide - Development setup and guidelines
Note
The investigation/ directory contains internal research notes and experiments with the NotebookLM API.