Agent skill

Synology API

by tympanix in tympanix/Electorrent

Synology Download Station Web API reference covering API discovery, authentication, request format, common errors, and Download Station task operations.

GPL-3.0Auto-check passedBackend & APIs

Install Synology API

skills CLI
$ npx skills add tympanix/Electorrent --skill synology-api -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install tympanix/Electorrent synology-api --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/tympanix/Electorrent.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/synology-api .claude/skills/synology-api && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
synology-api
GitHub stars
1.2k
Token cost
~1.3k tokens
SKILL.md length
442 words
Files
1
Skills in repo
6
Repo updated
First seen
Licence
GPL-3.0

At a glance

Synology Download Station Web API reference covering API discovery, authentication, request format, common errors, and Download Station task operations.

  • Works in 7 steps: SYNO.API.Info query for API discovery → SYNO.API.Auth login → SYNO.DownloadStation.Task.list → …
  • Backend & APIs work in your project
  • SKILL.md covers Purpose, Request format, Response format and Common error codes, plus 7 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Synology API is an agent skill from tympanix/Electorrent. Synology Download Station Web API reference covering API discovery, authentication, request format, common errors, and Download Station task operations.

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Backend & APIs. The repository describes itself as: A remote control client for µTorrent, qBittorrent, rTorrent, Transmission, Synology & Deluge. The licence is GPL-3.0.

When your agent uses it

  • Backend & APIs work in your project

Example prompts

  • “/synology-api”

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

  1. SYNO.API.Info query for API discovery
  2. SYNO.API.Auth login
  3. SYNO.DownloadStation.Task.list
  4. SYNO.DownloadStation.Task.create for URL and file uploads
  5. SYNO.DownloadStation.Task.pause
  6. SYNO.DownloadStation.Task.resume
  7. SYNO.DownloadStation.Task.delete

What it can do on your machine

Read from SKILL.md and the folder at commit d45444f. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • global.download.synology.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Synology API loads about 1.3k tokens when it runs. Until then it costs about 41 tokens; SKILL.md has 442 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~41
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from tympanix/Electorrent at commit d45444f, republished under its GPL-3.0 licence (© tympanix). 442 words, ~1,294 tokens.

Download SKILL.mdSave it as .claude/skills/synology-api/SKILL.md (or your agent's skills folder).
name
synology-api
description
Synology Download Station Web API reference covering API discovery, authentication, request format, common errors, and Download Station task operations.

Skill: Synology Download Station API

Purpose

Use this skill when you need to integrate with Synology DSM Download Station through its Web API.

Request format

All requests use /webapi/<CGI_PATH> with these core query parameters:

  • api=<API_NAME>
  • version=<VERSION>
  • method=<METHOD>
  • additional method-specific params
  • session via _sid=<SID> or cookie

General form:

text
GET /webapi/<CGI_PATH>?api=<API_NAME>&version=<VERSION>&method=<METHOD>[&<PARAMS>][&_sid=<SID>]

Response format

All responses are JSON objects with:

  • success: true or false
  • data: method result on success
  • error: integer error code on failure

Common error codes

CodeMeaning
100Unknown error
101Invalid parameter
102Requested API does not exist
103Requested method does not exist
104Requested version does not support the functionality
105Logged-in session does not have permission
106Session timeout
107Session interrupted by duplicate login

API discovery

Start with SYNO.API.Info.

  • fixed path: /webapi/query.cgi
  • query available APIs:
text
/webapi/query.cgi?api=SYNO.API.Info&version=1&method=query&query=ALL

Electorrent specifically needs:

  • SYNO.API.Auth
  • SYNO.DownloadStation.Task

Authentication

SYNO.API.Auth
  • path is discovered from SYNO.API.Info (commonly auth.cgi)
  • login:
text
/webapi/auth.cgi?api=SYNO.API.Auth&version=2&method=login&account=<user>&passwd=<pass>&session=DownloadStation&format=cookie

Important params:

  • account
  • passwd
  • session=DownloadStation
  • format=cookie or format=sid
  • optional otp_code

Logout:

text
/webapi/auth.cgi?api=SYNO.API.Auth&version=1&method=logout&session=DownloadStation

Auth-specific error codes:

CodeMeaning
400No such account or incorrect password
401Account disabled
402Permission denied
4032-step verification code required
404Failed to authenticate 2-step verification code

Download Station API families

APIPurpose
SYNO.DownloadStation.InfoPackage info and settings
SYNO.DownloadStation.ScheduleSchedule settings
SYNO.DownloadStation.TaskList tasks and perform task actions
SYNO.DownloadStation.StatisticTotal download/upload stats
SYNO.DownloadStation.RSS.SiteRSS site list/refresh
SYNO.DownloadStation.RSS.FeedRSS feed list
SYNO.DownloadStation.BTSearchBT search operations

SYNO.DownloadStation.Task

list

Request params:

  • offset optional, default 0
  • limit optional, default -1
  • additional optional comma-separated expansions:
    • detail
    • transfer
    • file
    • tracker
    • peer

Example:

text
/webapi/DownloadStation/task.cgi?api=SYNO.DownloadStation.Task&version=1&method=list&additional=detail,file

Returns:

  • total
  • offset
  • tasks[]

Task objects include fields such as:

  • id
  • type
  • username
  • title
  • size
  • status
  • status_extra
  • optional additional.detail, additional.transfer, additional.file, additional.tracker, additional.peer
Show full SKILL.md (176 more words)Show less
getinfo

Params:

  • id=dbid_001,dbid_002
  • optional additional=detail,transfer,file,tracker,peer

Returns tasks[].

create

Used to add downloads.

Params:

  • uri optional: HTTP / FTP / magnet / ED2K links, or shared-folder file paths
  • file optional: uploaded torrent/NZB payload
  • username optional
  • password optional
  • unzip_password optional
  • destination optional shared-folder-relative destination

This is typically a POST for uploads.

delete

Params:

  • id
  • force_complete

Returns per-task result objects containing:

  • id
  • error (0 means success)
pause

Params:

  • id

Returns per-task result objects with id and error.

resume

Params:

  • id

Returns per-task result objects with id and error.

edit

Commonly used to change destination.

Params:

  • id
  • destination

Returns per-task result objects with id and error.

Task error codes

Useful task-specific codes:

CodeMeaning
400File upload failed
401Max number of tasks reached
402Destination denied
403Destination does not exist
404Invalid task id
405Invalid task action
406No default destination
407Set destination failed
408File does not exist

Electorrent usage

Electorrent uses:

  1. SYNO.API.Info query for API discovery
  2. SYNO.API.Auth login
  3. SYNO.DownloadStation.Task.list
  4. SYNO.DownloadStation.Task.create for URL and file uploads
  5. SYNO.DownloadStation.Task.pause
  6. SYNO.DownloadStation.Task.resume
  7. SYNO.DownloadStation.Task.delete

Reference

© tympanix, GPL-3.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/synology-api of tympanix/Electorrent.

Open the folder on GitHubat commit d45444f

Compare with similar skills

Synology API next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Synology API compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Synology API this skilltympanix/Electorrent1.2k—~1.3kAutomated safety check: PassGPL-3.0
Configuring Horizoncoollabsio/coolify63k4 repos~898Automated safety check: PassMIT
Nestjs Best Practicesrolling-scopes/rsschool-app10k6 repos~1.2kAutomated safety check: PassMIT
Sub2API AdminWei-Shaw/sub2api43k1 repos~717Automated safety check: PassLGPL-3.0
Firecrawl Build Onboardingfirecrawl/firecrawl190k1 repos~1.4kAutomated safety check: NotesISC
Obsidian BasesAtmosphere/atmosphere3.8k22 repos~3.2kAutomated safety check: PassApache-2.0

Similar skills

  • Configuring Horizon

    coollabsio/coolify

    A skill your agent uses whenever the user mentions Horizon by name in a Laravel context.

    63k GitHub starsUsed in 4 repos~898 tokens
    Backend & APIsAuto-check passed
  • Nestjs Best Practices

    rolling-scopes/rsschool-app

    NestJS best practices and architecture patterns for building production-ready applications.

    10k GitHub starsUsed in 6 repos~1.2k tokens
    Backend & APIsAuto-check passed
  • Sub2API Admin

    Wei-Shaw/sub2api

    Manages a Sub2API deployment from the command line: accounts, redeem and invitation codes, groups, proxies, imports, exports and raw admin API calls.

    43k GitHub starsUsed in 1 repo~717 tokens
    Backend & APIsAuto-check passed
  • Firecrawl Build Onboarding

    firecrawl/firecrawl

    Gets Firecrawl working in a project: signs you in through the browser, saves FIRECRAWL_API_KEY to .env and picks the first SDK or REST path.

    190k GitHub starsUsed in 1 repo~1.4k tokens
    Backend & APIsAuto-check: notes
  • Obsidian Bases

    Atmosphere/atmosphere

    Create and edit Obsidian Bases (.base files) with views, filters, formulas, and summaries.

    3.8k GitHub starsUsed in 22 repos~3.2k tokens
    Backend & APIsAuto-check passed
  • Fortify Development

    coollabsio/coolify

    ACTIVATE when the user works on authentication in Laravel. An agent skill from coollabsio/coolify.

    63k GitHub starsUsed in 4 repos~1.9k tokens
    Backend & APIsAuto-check passed

More from tympanix/Electorrent

  • Deluge API

    tympanix/Electorrent

    Deluge Web JSON-RPC and core RPC reference covering session login, web methods, and commonly used core torrent operations.

    1.2k GitHub stars~1.2k tokensUpdated 5 days ago
    Auto-check passed
  • Electron Ipc

    tympanix/Electorrent

    Safe Electron IPC patterns for renderer-main communication with preload bridges, channel design, replies, and serialization limits.

    1.2k GitHub stars~1.2k tokensUpdated 5 days ago
    Auto-check passed
  • Rtorrent API

    tympanix/Electorrent

    rTorrent XML-RPC command reference focused on remote control, multicall patterns, load methods, and the torrent commands used by Electorrent.

    1.2k GitHub stars~17k tokensUpdated 5 days ago
    Auto-check passed
  • Transmission API

    tympanix/Electorrent

    Transmission RPC reference covering JSON-RPC 2.0 transport, session token handling, torrent methods, session methods, and protocol versioning.

    1.2k GitHub stars~12k tokensUpdated 5 days ago
    Auto-check passed
  • Impl

    tympanix/Electorrent

    Implement a feature. An agent skill from tympanix/Electorrent.

    1.2k GitHub stars~834 tokensUpdated 5 days ago
    Auto-check passed

Categories

Questions about Synology API

What does Synology API do?

Synology Download Station Web API reference covering API discovery, authentication, request format, common errors, and Download Station task operations. Synology API is an agent skill from tympanix/Electorrent. Synology Download Station Web API reference covering API discovery, authentication, request format, common errors, and Download Station task operations.

When should I use Synology API?

Synology API fits situations like: backend & APIs work in your project.

How do I install Synology API in Claude Code?

Run `npx skills add tympanix/Electorrent --skill synology-api -a claude-code`. Or copy the skill folder (.agents/skills/synology-api in tympanix/Electorrent) into .claude/skills/synology-api in your project. Claude Code loads it when a task matches its description.

How do I install Synology API in Codex?

Run `npx skills add tympanix/Electorrent --skill synology-api -a codex`. Or copy the skill folder (.agents/skills/synology-api in tympanix/Electorrent) into .agents/skills/synology-api in your project. Codex loads it when a task matches its description.

Can I use Synology API in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add tympanix/Electorrent --skill synology-api -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/synology-api, .gemini/skills/synology-api, .github/skills/synology-api and .opencode/skills/synology-api in your project.

What does Synology API need to run?

SKILL.md names no scripts, command-line tools or credentials: Synology API is instructions for the agent only.

Does Synology API access the network?

SKILL.md names 1 domain. As links in the text: global.download.synology.com. This is read from the text; nothing was executed.

Is Synology API safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Synology API use?

Synology API is published under the GPL-3.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Synology API use?

About 1.3k tokens (SKILL.md is roughly 5.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Synology API?

Skills that share tags, products or a category with Synology API: Configuring Horizon (coollabsio/coolify, 63k stars), Nestjs Best Practices (rolling-scopes/rsschool-app, 10k stars), Sub2API Admin (Wei-Shaw/sub2api, 43k stars) and Firecrawl Build Onboarding (firecrawl/firecrawl, 190k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Synology API?

tympanix (a GitHub user) maintains it in tympanix/Electorrent, which has 1,192 GitHub stars. The repository holds 6 skills in this directory. The repository was last updated on October 3, 2026.

Source: tympanix/Electorrent on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.