notebooklm-research
VerifiedAutomate source-grounded research with Google NotebookLM. Create notebooks from URLs, text, or local files; ask cited questions; run fast or deep web research; create articles and social drafts; and generate or download audio, video, cinematic video, slides, reports, study guides, quizzes, flashcards, mind maps, infographics, and data tables. Use when a user asks for NotebookLM, cited source analysis, research-to-content workflows, podcasts, slides, study material, artifact generation, RSS digests, or trend research.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 7.3 KB |
| examples/research-to-article/README.md | markdown | 1.9 KB |
| examples/research-to-threads/README.md | markdown | 1.4 KB |
| examples/trend-to-content/README.md | markdown | 2.0 KB |
| references/api_surface.md | markdown | 6.4 KB |
| references/output_formats.md | markdown | 3.2 KB |
| references/pipeline_recipes.md | markdown | 3.5 KB |
| scripts/__init__.py | script | 0 B |
| scripts/auth_helper.pyexecutable | script | 6.0 KB |
| scripts/common.py | script | 26.5 KB |
| scripts/make_video.shexecutable | script | 3.7 KB |
| scripts/notebooklm_client.pyexecutable | script | 20.2 KB |
| scripts/pipeline.pyexecutable | script | 26.1 KB |
| scripts/skill_installer.pyexecutable | script | 4.5 KB |
references/output_formats.md
View on GitHub# JSON output contract
CLI commands write exactly one JSON document to stdout. Progress and diagnostics go
to stderr. Fields not available from NotebookLM are omitted instead of invented.
## Status values
- `ok`: requested work completed.
- `started`: an asynchronous job was created and the caller chose not to wait.
- `partial`: at least one independent source/question/artifact failed.
- `failed`: the workflow could not produce its primary result.
Operational exceptions use a nonzero process exit and this envelope:
```json
{
"status": "failed",
"error": "Human-readable explanation",
"code": "INVALID_ARGUMENT"
}
```
Codes include `INVALID_ARGUMENT`, `AUTH_REQUIRED`, `CANCELLED`, `TIMEOUT`,
`OPERATION_ERROR`, `PIPELINE_ERROR`, `AUTH_ERROR`, and `INSTALL_ERROR` depending on
the entry point.
## Notebook creation
```json
{
"status": "partial",
"action": "create",
"notebook": {"id": "nb-id", "title": "Research"},
"source_summary": {"requested": 2, "succeeded": 1, "failed": 1},
"sources": [
{
"status": "ok",
"source_type": "url",
"input": "https://example.com",
"source": {"id": "source-id", "title": "Example", "kind": "web_page"}
},
{
"status": "failed",
"source_type": "file",
"input": "missing.pdf",
"error": "Source file not found: missing.pdf"
}
]
}
```
## Grounded answer
```json
{
"status": "ok",
"action": "ask",
"notebook_id": "nb-id",
"query": "What evidence conflicts?",
"answer": "...",
"references": [
{"source_id": "source-id", "citation_number": 1, "cited_text": "..."}
],
"conversation_id": "conversation-id"
}
```
Reference fields are upstream-defined and may evolve. Consumers should tolerate
additional or missing optional fields.
## Generation
Detached task:
```json
{
"status": "started",
"state": "in_progress",
"artifact_type": "audio",
"task_id": "artifact-id",
"action": "generate",
"notebook_id": "nb-id"
}
```
Completed task with an automatic download:
```json
{
"status": "ok",
"state": "completed",
"artifact_type": "slides",
"task_id": "artifact-id",
"result": {"task_id": "artifact-id", "status": "completed"},
"action": "generate",
"notebook_id": "nb-id",
"output_path": "output/deck.pdf"
}
```
Signed upstream URLs are never included.
## Research
```json
{
"status": "ok",
"task_id": "research-task-id",
"mode": "deep",
"query": "Recent evaluations",
"state": "completed",
"result": {"status": "completed", "sources": []},
"sources_found": 8,
"sources_imported": 5,
"imported": [{"id": "source-id", "title": "Imported source"}],
"action": "research",
"notebook_id": "nb-id"
}
```
## Pipeline outputs
Every pipeline includes `status`, `workflow`, serialized notebook metadata, source
results, and the primary result:
- `research-to-article`: `research_findings` and `article`;
- `research-to-social`: `summary`, `social`, and `platform_specs`;
- `trend-to-content`: one result per trend, including research and draft states;
- `batch-digest`: feed entries, `digest`, raw `qa`, and parsed `qa_pairs`;
- `generate-all`: per-artifact generation/download results and aggregate counts.
Consumers must check both the top-level status and nested per-item statuses.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| deprecation-and-migrationaddyosmani/agent-skillsManages deprecation and migration. Use when removing old systems, APIs, or features. Use when migrating users from one implementation to another. Use when migrating a database schema in production, such as renaming or dropping a column without downtime (expand/contract). Use when deciding whether to maintain or sunset existing code. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| performance-optimizationaddyosmani/agent-skillsOptimizes application performance across frontend, backend, queries, and databases. Use when performance requirements exist, when you suspect performance regressions, when Core Web Vitals or load times need improvement, when N+1 query patterns need fixing, or when profiling reveals bottlenecks. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| agent-cost-reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |
| agent-cost-reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |