Skip to content

Compress tool outputs, logs, files, and RAG chunks before they reach the LLM. 20% fewer tokens for coding agents, 60-95% fewer tokens for JSON, same answers. Library, proxy, MCP server.

docs: fix generate_report example arguments (#4435)

Anton Dziatkovskii6cc08012191e
diff --git a/docs/content/docs/api-reference.mdx b/docs/content/docs/api-reference.mdx
index 3fdaa9d4d..5bf631050 100644
--- a/docs/content/docs/api-reference.mdx
+++ b/docs/content/docs/api-reference.mdx
@@ -639,16 +639,17 @@ tokens = tokenizer.count_messages(messages)
### generate_report()
-Generate HTML/Markdown reports from stored metrics:
+Generate an HTML report from stored metrics:
```python
+from datetime import datetime, timedelta, timezone
from headroom import generate_report
-report = generate_report(
- store_url="sqlite:///headroom.db",
- format="html",
- period="day",
-)
+path = generate_report(
+ store_url="sqlite:////absolute/path/to/headroom.db",
+ output_path="report.html",
+ start_time=datetime.now(timezone.utc) - timedelta(days=1),
+) # returns the path to the generated HTML file
```
---
diff --git a/wiki/api.md b/wiki/api.md
index fce1b03ac..3d9ad32d9 100644
--- a/wiki/api.md
+++ b/wiki/api.md
@@ -319,16 +319,17 @@ tokens = tokenizer.count_messages(messages)
### generate_report()
-Generate HTML/Markdown reports from stored metrics.
+Generate an HTML report from stored metrics.
```python
+from datetime import datetime, timedelta, timezone
from headroom import generate_report
-report = generate_report(
- store_url="sqlite:///headroom.db",
- format="html",
- period="day",
-)
+path = generate_report(
+ store_url="sqlite:////absolute/path/to/headroom.db",
+ output_path="report.html",
+ start_time=datetime.now(timezone.utc) - timedelta(days=1),
+) # returns the path to the generated HTML file
```
---