| name | sabnzbd |
| version | 1.0.0 |
| description | Manage Usenet downloads with SABnzbd. Use when the user asks to "check SABnzbd", "list NZB queue", "add NZB", "pause downloads", "resume downloads", "SABnzbd status", "Usenet queue", "NZB history", or mentions SABnzbd/sab download management. |
SABnzbd API
Manage Usenet downloads via SABnzbd's REST API.
Setup
Config: ~/.clawdbot/credentials/sabnzbd/config.json
{
"url": "http://localhost:8080",
"apiKey": "your-api-key-from-config-general"
}
Get your API key from SABnzbd Config → General → Security.
Quick Reference
Queue Status
./scripts/sab-api.sh queue
./scripts/sab-api.sh queue --limit 10 --category tv
./scripts/sab-api.sh queue --nzo-id SABnzbd_nzo_xxxxx
Add NZB
./scripts/sab-api.sh add "https://indexer.com/get.php?guid=..."
./scripts/sab-api.sh add "URL" --name "My Download" --category movies --priority high
./scripts/sab-api.sh add-file /path/to/file.nzb --category tv
Priority: force, high, normal, low, paused, duplicate
Control Queue
./scripts/sab-api.sh pause
./scripts/sab-api.sh resume
./scripts/sab-api.sh pause-job <nzo_id>
./scripts/sab-api.sh resume-job <nzo_id>
./scripts/sab-api.sh delete <nzo_id>
./scripts/sab-api.sh delete <nzo_id> --files
./scripts/sab-api.sh purge
Speed Control
./scripts/sab-api.sh speedlimit 50
./scripts/sab-api.sh speedlimit 5M
./scripts/sab-api.sh speedlimit 0
History
./scripts/sab-api.sh history
./scripts/sab-api.sh history --limit 20 --failed
./scripts/sab-api.sh retry <nzo_id>
./scripts/sab-api.sh retry-all
./scripts/sab-api.sh delete-history <nzo_id>
Categories & Scripts
./scripts/sab-api.sh categories
./scripts/sab-api.sh scripts
./scripts/sab-api.sh change-category <nzo_id> movies
./scripts/sab-api.sh change-script <nzo_id> notify.py
Status & Info
./scripts/sab-api.sh status
./scripts/sab-api.sh version
./scripts/sab-api.sh warnings
./scripts/sab-api.sh server-stats
Response Format
Queue slot includes:
nzo_id, filename, status
mb, mbleft, percentage
timeleft, priority, cat
script, labels
Status values: Downloading, Queued, Paused, Propagating, Fetching
History status: Completed, Failed, Queued, Verifying, Repairing, Extracting