moviepilot-api

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

MoviePilot REST API

All script paths are relative to this skill file.

Use

scripts/mp-api.py

to call any MoviePilot REST API endpoint directly.

所有脚本路径均相对于当前skill文件。

使用

scripts/mp-api.py

可直接调用任意MoviePilot REST API接口。

Setup

配置步骤

Configure the backend host and API key (persisted to

~/.config/moviepilot_api/config

python scripts/mp-api.py configure --host http://localhost:3000 --apikey <API_TOKEN>

The API key is the

API_TOKEN

value from MoviePilot settings.

配置后端主机地址和API密钥（配置会持久化保存到

~/.config/moviepilot_api/config

）：

python scripts/mp-api.py configure --host http://localhost:3000 --apikey <API_TOKEN>

API密钥是MoviePilot设置中的

API_TOKEN

值。

How to Call APIs

API调用方法

General syntax

通用语法

python scripts/mp-api.py <METHOD> <PATH> [key=value ...] [--json '<body>']

python scripts/mp-api.py <METHOD> <PATH> [key=value ...] [--json '<body>']

Authentication

认证方式

By default, the key is sent via the
```
X-API-KEY
```
header.
For endpoints suffixed with
```
2
```
(e.g.
```
/api/v1/dashboard/statistic2
```
), use
```
--token-param
```
to send the key as
```
?token=
```
.
Both methods validate against the same
```
API_TOKEN
```
value.

默认情况下，密钥会通过
```
X-API-KEY
```
请求头发送。
对于以
```
2
```
为后缀的接口（例如
```
/api/v1/dashboard/statistic2
```
），使用
```
--token-param
```
参数将密钥通过
```
?token=
```
参数发送。
两种方式校验的都是同一个
```
API_TOKEN
```
值。

Examples

示例

bash

undefined

bash

undefined

GET with query params

带查询参数的GET请求

python scripts/mp-api.py GET /api/v1/media/search title="Avatar" type="movie"

POST with JSON body

带JSON请求体的POST请求

python scripts/mp-api.py POST /api/v1/download/add --json '{"torrent_url":"abc1234:1"}'

DELETE

DELETE请求

python scripts/mp-api.py DELETE /api/v1/subscribe/123

Endpoints that require ?token= auth

需要通过?token=认证的接口

python scripts/mp-api.py GET /api/v1/dashboard/statistic2 --token-param

undefined

python scripts/mp-api.py GET /api/v1/dashboard/statistic2 --token-param

undefined

Complete API Reference

完整API参考

All endpoints are under the base URL

{MP_HOST}

. Path parameters are shown as

{param}

所有接口的基础URL为

{MP_HOST}

，路径参数以

{param}

格式标注。

Media Search (13 endpoints)

媒体搜索（13个接口）

Method	Path	Description
GET	`/api/v1/media/search`	Search media/person by title. Params: `title` (required), `type` , `page` , `count`
GET	`/api/v1/media/recognize`	Recognize media from torrent title. Params: `title` (required), `subtitle`
GET	`/api/v1/media/recognize2`	Recognize media (API_TOKEN auth, use `--token-param` ). Params: `title` , `subtitle`
GET	`/api/v1/media/recognize_file`	Recognize media from file path. Params: `path` (required)
GET	`/api/v1/media/recognize_file2`	Recognize file (API_TOKEN auth). Params: `path`
POST	`/api/v1/media/scrape/{storage}`	Scrape media metadata. Body: FileItem JSON
GET	`/api/v1/media/category/config`	Get category strategy config
POST	`/api/v1/media/category/config`	Save category strategy config. Body: CategoryConfig
GET	`/api/v1/media/category`	Get auto-categorization config
GET	`/api/v1/media/group/seasons/{episode_group}`	Get episode group seasons
GET	`/api/v1/media/groups/{tmdbid}`	Get media episode groups
GET	`/api/v1/media/seasons`	Get media season info. Params: `mediaid` , `title` , `year` , `season`
GET	`/api/v1/media/{mediaid}`	Get media detail. Params: `type_name` (required: movie/tv), `title` , `year`

方法	路径	说明
GET	`/api/v1/media/search`	按标题搜索媒体/人物。参数： `title` （必填）、 `type` 、 `page` 、 `count`
GET	`/api/v1/media/recognize`	从种子标题识别媒体信息。参数： `title` （必填）、 `subtitle`
GET	`/api/v1/media/recognize2`	识别媒体信息（通过API_TOKEN认证，需使用 `--token-param` ）。参数： `title` 、 `subtitle`
GET	`/api/v1/media/recognize_file`	从文件路径识别媒体信息。参数： `path` （必填）
GET	`/api/v1/media/recognize_file2`	识别文件媒体信息（通过API_TOKEN认证）。参数： `path`
POST	`/api/v1/media/scrape/{storage}`	刮削媒体元数据。请求体：FileItem JSON
GET	`/api/v1/media/category/config`	获取分类策略配置
POST	`/api/v1/media/category/config`	保存分类策略配置。请求体：CategoryConfig
GET	`/api/v1/media/category`	获取自动分类配置
GET	`/api/v1/media/group/seasons/{episode_group}`	获取剧集分组的季度信息
GET	`/api/v1/media/groups/{tmdbid}`	获取媒体剧集分组
GET	`/api/v1/media/seasons`	获取媒体季度信息。参数： `mediaid` 、 `title` 、 `year` 、 `season`
GET	`/api/v1/media/{mediaid}`	获取媒体详情。参数： `type_name` （必填：movie/tv）、 `title` 、 `year`

TMDB (8 endpoints)

TMDB（8个接口）

Method	Path	Description
GET	`/api/v1/tmdb/seasons/{tmdbid}`	All seasons for a TMDB title
GET	`/api/v1/tmdb/similar/{tmdbid}/{type_name}`	Similar movies/TV shows
GET	`/api/v1/tmdb/recommend/{tmdbid}/{type_name}`	Recommended movies/TV shows
GET	`/api/v1/tmdb/collection/{collection_id}`	Collection details. Params: `page` , `count`
GET	`/api/v1/tmdb/credits/{tmdbid}/{type_name}`	Cast and crew. Params: `page`
GET	`/api/v1/tmdb/person/{person_id}`	Person details
GET	`/api/v1/tmdb/person/credits/{person_id}`	Person's filmography. Params: `page`
GET	`/api/v1/tmdb/{tmdbid}/{season}`	All episodes of a season. Params: `episode_group`

方法	路径	说明
GET	`/api/v1/tmdb/seasons/{tmdbid}`	获取TMDB标题对应的所有季度
GET	`/api/v1/tmdb/similar/{tmdbid}/{type_name}`	相似电影/电视剧
GET	`/api/v1/tmdb/recommend/{tmdbid}/{type_name}`	推荐的电影/电视剧
GET	`/api/v1/tmdb/collection/{collection_id}`	合集详情。参数： `page` 、 `count`
GET	`/api/v1/tmdb/credits/{tmdbid}/{type_name}`	演职人员信息。参数： `page`
GET	`/api/v1/tmdb/person/{person_id}`	人物详情
GET	`/api/v1/tmdb/person/credits/{person_id}`	人物参演作品。参数： `page`
GET	`/api/v1/tmdb/{tmdbid}/{season}`	某一季度的所有剧集。参数： `episode_group`

Douban (5 endpoints)

Douban（5个接口）

Method	Path	Description
GET	`/api/v1/douban/{doubanid}`	Douban media detail
GET	`/api/v1/douban/person/{person_id}`	Person detail
GET	`/api/v1/douban/person/credits/{person_id}`	Person filmography. Params: `page`
GET	`/api/v1/douban/credits/{doubanid}/{type_name}`	Cast info (type_name: movie/tv)
GET	`/api/v1/douban/recommend/{doubanid}/{type_name}`	Recommendations

方法	路径	说明
GET	`/api/v1/douban/{doubanid}`	豆瓣媒体详情
GET	`/api/v1/douban/person/{person_id}`	人物详情
GET	`/api/v1/douban/person/credits/{person_id}`	人物参演作品。参数： `page`
GET	`/api/v1/douban/credits/{doubanid}/{type_name}`	演职人员信息（type_name: movie/tv）
GET	`/api/v1/douban/recommend/{doubanid}/{type_name}`	推荐内容

Bangumi (5 endpoints)

Bangumi（5个接口）

Method	Path	Description
GET	`/api/v1/bangumi/{bangumiid}`	Bangumi detail
GET	`/api/v1/bangumi/credits/{bangumiid}`	Cast. Params: `page` , `count`
GET	`/api/v1/bangumi/recommend/{bangumiid}`	Recommendations. Params: `page` , `count`
GET	`/api/v1/bangumi/person/{person_id}`	Person detail
GET	`/api/v1/bangumi/person/credits/{person_id}`	Person filmography. Params: `page` , `count`

方法	路径	说明
GET	`/api/v1/bangumi/{bangumiid}`	Bangumi详情
GET	`/api/v1/bangumi/credits/{bangumiid}`	演职人员。参数： `page` 、 `count`
GET	`/api/v1/bangumi/recommend/{bangumiid}`	推荐内容。参数： `page` 、 `count`
GET	`/api/v1/bangumi/person/{person_id}`	人物详情
GET	`/api/v1/bangumi/person/credits/{person_id}`	人物参演作品。参数： `page` 、 `count`

Search / Torrents (4 endpoints)

搜索/种子（4个接口）

Method	Path	Description
GET	`/api/v1/search/media/{mediaid}`	Search torrents by media ID (format: `tmdb:123` / `douban:123` / `bangumi:123` ). Params: `mtype` , `area` , `title` , `year` , `season` , `sites`
GET	`/api/v1/search/title`	Fuzzy search torrents by keyword. Params: `keyword` , `page` , `sites`
GET	`/api/v1/search/last`	Get latest search results
POST	`/api/v1/search/recommend`	AI recommended resources. Body: `filtered_indices` , `check_only` , `force`

方法	路径	说明
GET	`/api/v1/search/media/{mediaid}`	按媒体ID搜索种子（格式： `tmdb:123` / `douban:123` / `bangumi:123` ）。参数： `mtype` 、 `area` 、 `title` 、 `year` 、 `season` 、 `sites`
GET	`/api/v1/search/title`	按关键词模糊搜索种子。参数： `keyword` 、 `page` 、 `sites`
GET	`/api/v1/search/last`	获取最新搜索结果
POST	`/api/v1/search/recommend`	AI推荐资源。请求体： `filtered_indices` 、 `check_only` 、 `force`

Download (7 endpoints)

下载（7个接口）

Method	Path	Description
GET	`/api/v1/download/`	List active downloads. Params: `name` (downloader name)
POST	`/api/v1/download/`	Add download (with media info). Body: JSON
POST	`/api/v1/download/add`	Add download (without media info). Body: JSON with `torrent_url`
GET	`/api/v1/download/start/{hashString}`	Resume download task
GET	`/api/v1/download/stop/{hashString}`	Pause download task
GET	`/api/v1/download/clients`	List available download clients
DELETE	`/api/v1/download/{hashString}`	Delete download task. Params: `name`

方法	路径	说明
GET	`/api/v1/download/`	列出活跃下载任务。参数： `name` （下载器名称）
POST	`/api/v1/download/`	添加下载任务（携带媒体信息）。请求体：JSON
POST	`/api/v1/download/add`	添加下载任务（不携带媒体信息）。请求体：带 `torrent_url` 的JSON
GET	`/api/v1/download/start/{hashString}`	恢复下载任务
GET	`/api/v1/download/stop/{hashString}`	暂停下载任务
GET	`/api/v1/download/clients`	列出可用下载客户端
DELETE	`/api/v1/download/{hashString}`	删除下载任务。参数： `name`

Subscribe (28 endpoints)

订阅（28个接口）

Method	Path	Description
GET	`/api/v1/subscribe/`	List all subscriptions
POST	`/api/v1/subscribe/`	Add subscription. Body: Subscribe JSON
PUT	`/api/v1/subscribe/`	Update subscription. Body: Subscribe JSON
GET	`/api/v1/subscribe/list`	List subscriptions (API_TOKEN auth, use `--token-param` )
GET	`/api/v1/subscribe/{subscribe_id}`	Subscription detail
DELETE	`/api/v1/subscribe/{subscribe_id}`	Delete subscription
PUT	`/api/v1/subscribe/status/{subid}`	Update subscription status. Params: `state` (required)
GET	`/api/v1/subscribe/media/{mediaid}`	Query subscription by media ID. Params: `season` , `title`
DELETE	`/api/v1/subscribe/media/{mediaid}`	Delete subscription by media ID. Params: `season`
GET	`/api/v1/subscribe/refresh`	Refresh all subscriptions
GET	`/api/v1/subscribe/reset/{subid}`	Reset subscription
GET	`/api/v1/subscribe/check`	Refresh subscription TMDB info
GET	`/api/v1/subscribe/search`	Search all subscriptions
GET	`/api/v1/subscribe/search/{subscribe_id}`	Search specific subscription
POST	`/api/v1/subscribe/seerr`	Overseerr/Jellyseerr notification subscription
GET	`/api/v1/subscribe/history/{mtype}`	Subscription history. Params: `page` , `count`
DELETE	`/api/v1/subscribe/history/{history_id}`	Delete subscription history
GET	`/api/v1/subscribe/popular`	Popular subscriptions. Params: `stype` (required), `page` , `count` , `min_sub` , `genre_id` , `min_rating` , `max_rating` , `sort_type`
GET	`/api/v1/subscribe/user/{username}`	User's subscriptions
GET	`/api/v1/subscribe/files/{subscribe_id}`	Subscription related files
POST	`/api/v1/subscribe/share`	Share subscription. Body: SubscribeShare JSON
DELETE	`/api/v1/subscribe/share/{share_id}`	Delete shared subscription
POST	`/api/v1/subscribe/fork`	Fork shared subscription. Body: SubscribeShare JSON
GET	`/api/v1/subscribe/follow`	List followed share users
POST	`/api/v1/subscribe/follow`	Follow a share user. Params: `share_uid`
DELETE	`/api/v1/subscribe/follow`	Unfollow a share user. Params: `share_uid`
GET	`/api/v1/subscribe/shares`	List shared subscriptions. Params: `name` , `page` , `count` , `genre_id` , `min_rating` , `max_rating` , `sort_type`
GET	`/api/v1/subscribe/share/statistics`	Share statistics

方法	路径	说明
GET	`/api/v1/subscribe/`	列出所有订阅
POST	`/api/v1/subscribe/`	添加订阅。请求体：Subscribe JSON
PUT	`/api/v1/subscribe/`	更新订阅。请求体：Subscribe JSON
GET	`/api/v1/subscribe/list`	列出订阅（通过API_TOKEN认证，需使用 `--token-param` ）
GET	`/api/v1/subscribe/{subscribe_id}`	订阅详情
DELETE	`/api/v1/subscribe/{subscribe_id}`	删除订阅
PUT	`/api/v1/subscribe/status/{subid}`	更新订阅状态。参数： `state` （必填）
GET	`/api/v1/subscribe/media/{mediaid}`	按媒体ID查询订阅。参数： `season` 、 `title`
DELETE	`/api/v1/subscribe/media/{mediaid}`	按媒体ID删除订阅。参数： `season`
GET	`/api/v1/subscribe/refresh`	刷新所有订阅
GET	`/api/v1/subscribe/reset/{subid}`	重置订阅
GET	`/api/v1/subscribe/check`	刷新订阅TMDB信息
GET	`/api/v1/subscribe/search`	搜索所有订阅
GET	`/api/v1/subscribe/search/{subscribe_id}`	搜索指定订阅
POST	`/api/v1/subscribe/seerr`	Overseerr/Jellyseerr通知订阅
GET	`/api/v1/subscribe/history/{mtype}`	订阅历史。参数： `page` 、 `count`
DELETE	`/api/v1/subscribe/history/{history_id}`	删除订阅历史
GET	`/api/v1/subscribe/popular`	热门订阅。参数： `stype` （必填）、 `page` 、 `count` 、 `min_sub` 、 `genre_id` 、 `min_rating` 、 `max_rating` 、 `sort_type`
GET	`/api/v1/subscribe/user/{username}`	用户的订阅
GET	`/api/v1/subscribe/files/{subscribe_id}`	订阅相关文件
POST	`/api/v1/subscribe/share`	分享订阅。请求体：SubscribeShare JSON
DELETE	`/api/v1/subscribe/share/{share_id}`	删除分享的订阅
POST	`/api/v1/subscribe/fork`	复刻分享的订阅。请求体：SubscribeShare JSON
GET	`/api/v1/subscribe/follow`	列出已关注的分享用户
POST	`/api/v1/subscribe/follow`	关注分享用户。参数： `share_uid`
DELETE	`/api/v1/subscribe/follow`	取消关注分享用户。参数： `share_uid`
GET	`/api/v1/subscribe/shares`	列出分享的订阅。参数： `name` 、 `page` 、 `count` 、 `genre_id` 、 `min_rating` 、 `max_rating` 、 `sort_type`
GET	`/api/v1/subscribe/share/statistics`	分享统计数据

Site (24 endpoints)

站点（24个接口）

Method	Path	Description
GET	`/api/v1/site/`	List all sites
POST	`/api/v1/site/`	Add site. Body: Site JSON
PUT	`/api/v1/site/`	Update site. Body: Site JSON
GET	`/api/v1/site/{site_id}`	Site detail by ID
DELETE	`/api/v1/site/{site_id}`	Delete site
GET	`/api/v1/site/domain/{site_url}`	Site detail by domain
GET	`/api/v1/site/cookiecloud`	Sync CookieCloud
GET	`/api/v1/site/reset`	Reset sites
POST	`/api/v1/site/priorities`	Batch update site priorities. Body: array
GET	`/api/v1/site/cookie/{site_id}`	Update site cookie & UA. Params: `username` , `password` , `code`
POST	`/api/v1/site/userdata/{site_id}`	Refresh site user data
GET	`/api/v1/site/userdata/{site_id}`	Get site user data. Params: `workdate`
GET	`/api/v1/site/userdata/latest`	All sites latest user data
GET	`/api/v1/site/test/{site_id}`	Test site connection
GET	`/api/v1/site/icon/{site_id}`	Site icon
GET	`/api/v1/site/category/{site_id}`	Site categories
GET	`/api/v1/site/resource/{site_id}`	Site resources. Params: `keyword` , `cat` , `page`
GET	`/api/v1/site/statistic/{site_url}`	Specific site statistics
GET	`/api/v1/site/statistic`	All site statistics
GET	`/api/v1/site/rss`	RSS subscription sites
GET	`/api/v1/site/auth`	Check authenticated sites
POST	`/api/v1/site/auth`	Authenticate a site. Body: SiteAuth
GET	`/api/v1/site/mapping`	Site domain-to-name mapping
GET	`/api/v1/site/supporting`	Supported site list

方法	路径	说明
GET	`/api/v1/site/`	列出所有站点
POST	`/api/v1/site/`	添加站点。请求体：Site JSON
PUT	`/api/v1/site/`	更新站点。请求体：Site JSON
GET	`/api/v1/site/{site_id}`	按ID获取站点详情
DELETE	`/api/v1/site/{site_id}`	删除站点
GET	`/api/v1/site/domain/{site_url}`	按域名获取站点详情
GET	`/api/v1/site/cookiecloud`	同步CookieCloud
GET	`/api/v1/site/reset`	重置站点
POST	`/api/v1/site/priorities`	批量更新站点优先级。请求体：数组
GET	`/api/v1/site/cookie/{site_id}`	更新站点Cookie和UA。参数： `username` 、 `password` 、 `code`
POST	`/api/v1/site/userdata/{site_id}`	刷新站点用户数据
GET	`/api/v1/site/userdata/{site_id}`	获取站点用户数据。参数： `workdate`
GET	`/api/v1/site/userdata/latest`	所有站点最新用户数据
GET	`/api/v1/site/test/{site_id}`	测试站点连通性
GET	`/api/v1/site/icon/{site_id}`	站点图标
GET	`/api/v1/site/category/{site_id}`	站点分类
GET	`/api/v1/site/resource/{site_id}`	站点资源。参数： `keyword` 、 `cat` 、 `page`
GET	`/api/v1/site/statistic/{site_url}`	指定站点统计数据
GET	`/api/v1/site/statistic`	所有站点统计数据
GET	`/api/v1/site/rss`	RSS订阅站点
GET	`/api/v1/site/auth`	检查已认证站点
POST	`/api/v1/site/auth`	认证站点。请求体：SiteAuth
GET	`/api/v1/site/mapping`	站点域名到名称映射
GET	`/api/v1/site/supporting`	支持的站点列表

History (5 endpoints)

历史记录（5个接口）

Method	Path	Description
GET	`/api/v1/history/download`	Download history. Params: `page` , `count`
DELETE	`/api/v1/history/download`	Delete download history. Body: DownloadHistory JSON
GET	`/api/v1/history/transfer`	Transfer history. Params: `title` , `page` , `count` , `status`
DELETE	`/api/v1/history/transfer`	Delete transfer history. Params: `deletesrc` , `deletedest` . Body: TransferHistory
GET	`/api/v1/history/empty/transfer`	Clear all transfer history

方法	路径	说明
GET	`/api/v1/history/download`	下载历史。参数： `page` 、 `count`
DELETE	`/api/v1/history/download`	删除下载历史。请求体：DownloadHistory JSON
GET	`/api/v1/history/transfer`	转移历史。参数： `title` 、 `page` 、 `count` 、 `status`
DELETE	`/api/v1/history/transfer`	删除转移历史。参数： `deletesrc` 、 `deletedest` 。请求体：TransferHistory
GET	`/api/v1/history/empty/transfer`	清空所有转移历史

Media Server (8 endpoints)

媒体服务器（8个接口）

Method	Path	Description
GET	`/api/v1/mediaserver/play/{itemid}`	Play media online
GET	`/api/v1/mediaserver/exists`	Check if media exists in library. Params: `title` , `year` , `mtype` , `tmdbid` , `season`
POST	`/api/v1/mediaserver/exists_remote`	Check existing episodes (remote). Body: MediaInfo JSON
POST	`/api/v1/mediaserver/notexists`	Check missing episodes (remote). Body: MediaInfo JSON
GET	`/api/v1/mediaserver/latest`	Latest library items. Params: `server` (required), `count`
GET	`/api/v1/mediaserver/playing`	Currently playing. Params: `server` (required), `count`
GET	`/api/v1/mediaserver/library`	Library list. Params: `server` (required), `hidden`
GET	`/api/v1/mediaserver/clients`	Available media servers

方法	路径	说明
GET	`/api/v1/mediaserver/play/{itemid}`	在线播放媒体
GET	`/api/v1/mediaserver/exists`	检查媒体库中是否存在该媒体。参数： `title` 、 `year` 、 `mtype` 、 `tmdbid` 、 `season`
POST	`/api/v1/mediaserver/exists_remote`	检查已存在剧集（远程）。请求体：MediaInfo JSON
POST	`/api/v1/mediaserver/notexists`	检查缺失剧集（远程）。请求体：MediaInfo JSON
GET	`/api/v1/mediaserver/latest`	媒体库最新内容。参数： `server` （必填）、 `count`
GET	`/api/v1/mediaserver/playing`	当前正在播放的内容。参数： `server` （必填）、 `count`
GET	`/api/v1/mediaserver/library`	媒体库列表。参数： `server` （必填）、 `hidden`
GET	`/api/v1/mediaserver/clients`	可用媒体服务器

Storage / Files (13 endpoints)

存储/文件（13个接口）

Method	Path	Description
POST	`/api/v1/storage/list`	List directory contents. Params: `sort` . Body: FileItem JSON
POST	`/api/v1/storage/mkdir`	Create directory. Params: `name` (required). Body: FileItem
POST	`/api/v1/storage/delete`	Delete file or directory. Body: FileItem JSON
POST	`/api/v1/storage/download`	Download file. Body: FileItem JSON
POST	`/api/v1/storage/image`	Preview image. Body: FileItem JSON
POST	`/api/v1/storage/rename`	Rename file/dir. Params: `new_name` (required), `recursive` . Body: FileItem
GET	`/api/v1/storage/usage/{name}`	Storage usage info
GET	`/api/v1/storage/transtype/{name}`	Supported transfer types
GET	`/api/v1/storage/qrcode/{name}`	Generate QR code for auth
GET	`/api/v1/storage/auth_url/{name}`	Get OAuth2 auth URL
GET	`/api/v1/storage/check/{name}`	Confirm QR login. Params: `ck` , `t`
POST	`/api/v1/storage/save/{name}`	Save storage config. Body: JSON object
GET	`/api/v1/storage/reset/{name}`	Reset storage config

方法	路径	说明
POST	`/api/v1/storage/list`	列出目录内容。参数： `sort` 。请求体：FileItem JSON
POST	`/api/v1/storage/mkdir`	创建目录。参数： `name` （必填）。请求体：FileItem
POST	`/api/v1/storage/delete`	删除文件或目录。请求体：FileItem JSON
POST	`/api/v1/storage/download`	下载文件。请求体：FileItem JSON
POST	`/api/v1/storage/image`	预览图片。请求体：FileItem JSON
POST	`/api/v1/storage/rename`	重命名文件/目录。参数： `new_name` （必填）、 `recursive` 。请求体：FileItem
GET	`/api/v1/storage/usage/{name}`	存储使用信息
GET	`/api/v1/storage/transtype/{name}`	支持的转移类型
GET	`/api/v1/storage/qrcode/{name}`	生成认证二维码
GET	`/api/v1/storage/auth_url/{name}`	获取OAuth2认证URL
GET	`/api/v1/storage/check/{name}`	确认二维码登录。参数： `ck` 、 `t`
POST	`/api/v1/storage/save/{name}`	保存存储配置。请求体：JSON对象
GET	`/api/v1/storage/reset/{name}`	重置存储配置

Transfer (5 endpoints)

转移（5个接口）

Method	Path	Description
GET	`/api/v1/transfer/name`	Preview transfer name. Params: `path` (required), `filetype` (required)
GET	`/api/v1/transfer/queue`	Transfer queue
DELETE	`/api/v1/transfer/queue`	Remove from transfer queue. Body: FileItem JSON
POST	`/api/v1/transfer/manual`	Manual transfer. Params: `background` . Body: ManualTransferItem JSON
GET	`/api/v1/transfer/now`	Run immediate transfer

方法	路径	说明
GET	`/api/v1/transfer/name`	预览转移后名称。参数： `path` （必填）、 `filetype` （必填）
GET	`/api/v1/transfer/queue`	转移队列
DELETE	`/api/v1/transfer/queue`	从转移队列移除。请求体：FileItem JSON
POST	`/api/v1/transfer/manual`	手动转移。参数： `background` 。请求体：ManualTransferItem JSON
GET	`/api/v1/transfer/now`	立即执行转移

Dashboard (16 endpoints)

仪表盘（16个接口）

Method	Path	Description
GET	`/api/v1/dashboard/statistic`	Media statistics. Params: `name`
GET	`/api/v1/dashboard/statistic2`	Media statistics (API_TOKEN, use `--token-param` )
GET	`/api/v1/dashboard/storage`	Local storage space
GET	`/api/v1/dashboard/storage2`	Local storage space (API_TOKEN)
GET	`/api/v1/dashboard/processes`	Process info
GET	`/api/v1/dashboard/downloader`	Downloader info. Params: `name`
GET	`/api/v1/dashboard/downloader2`	Downloader info (API_TOKEN)
GET	`/api/v1/dashboard/schedule`	Scheduled services
GET	`/api/v1/dashboard/schedule2`	Scheduled services (API_TOKEN)
GET	`/api/v1/dashboard/transfer`	Transfer statistics. Params: `days`
GET	`/api/v1/dashboard/cpu`	CPU usage
GET	`/api/v1/dashboard/cpu2`	CPU usage (API_TOKEN)
GET	`/api/v1/dashboard/memory`	Memory usage
GET	`/api/v1/dashboard/memory2`	Memory usage (API_TOKEN)
GET	`/api/v1/dashboard/network`	Network traffic
GET	`/api/v1/dashboard/network2`	Network traffic (API_TOKEN)

方法	路径	说明
GET	`/api/v1/dashboard/statistic`	媒体统计数据。参数： `name`
GET	`/api/v1/dashboard/statistic2`	媒体统计数据（通过API_TOKEN认证，需使用 `--token-param` ）
GET	`/api/v1/dashboard/storage`	本地存储空间
GET	`/api/v1/dashboard/storage2`	本地存储空间（通过API_TOKEN认证）
GET	`/api/v1/dashboard/processes`	进程信息
GET	`/api/v1/dashboard/downloader`	下载器信息。参数： `name`
GET	`/api/v1/dashboard/downloader2`	下载器信息（通过API_TOKEN认证）
GET	`/api/v1/dashboard/schedule`	定时服务
GET	`/api/v1/dashboard/schedule2`	定时服务（通过API_TOKEN认证）
GET	`/api/v1/dashboard/transfer`	转移统计数据。参数： `days`
GET	`/api/v1/dashboard/cpu`	CPU使用率
GET	`/api/v1/dashboard/cpu2`	CPU使用率（通过API_TOKEN认证）
GET	`/api/v1/dashboard/memory`	内存使用率
GET	`/api/v1/dashboard/memory2`	内存使用率（通过API_TOKEN认证）
GET	`/api/v1/dashboard/network`	网络流量
GET	`/api/v1/dashboard/network2`	网络流量（通过API_TOKEN认证）

Plugin (22 endpoints)

插件（22个接口）

Method	Path	Description
GET	`/api/v1/plugin/`	List plugins. Params: `state` (installed/market/all), `force`
GET	`/api/v1/plugin/installed`	List installed plugins
GET	`/api/v1/plugin/statistic`	Plugin install statistics
GET	`/api/v1/plugin/install/{plugin_id}`	Install plugin. Params: `repo_url` , `force`
GET	`/api/v1/plugin/reload/{plugin_id}`	Reload plugin
GET	`/api/v1/plugin/reset/{plugin_id}`	Reset plugin config & data
GET	`/api/v1/plugin/{plugin_id}`	Get plugin config
PUT	`/api/v1/plugin/{plugin_id}`	Update plugin config. Body: JSON object
DELETE	`/api/v1/plugin/{plugin_id}`	Uninstall plugin
POST	`/api/v1/plugin/clone/{plugin_id}`	Clone plugin. Body: JSON object
GET	`/api/v1/plugin/form/{plugin_id}`	Plugin form page
GET	`/api/v1/plugin/page/{plugin_id}`	Plugin data page
GET	`/api/v1/plugin/remotes`	Plugin federation list. Params: `token` (required)
GET	`/api/v1/plugin/dashboard/meta`	All plugin dashboard metadata
GET	`/api/v1/plugin/dashboard/{plugin_id}/{key}`	Plugin dashboard by key
GET	`/api/v1/plugin/dashboard/{plugin_id}`	Plugin dashboard
GET	`/api/v1/plugin/file/{plugin_id}/{filepath}`	Plugin static file
GET	`/api/v1/plugin/folders`	Plugin folder config
POST	`/api/v1/plugin/folders`	Save plugin folder config
POST	`/api/v1/plugin/folders/{folder_name}`	Create plugin folder
DELETE	`/api/v1/plugin/folders/{folder_name}`	Delete plugin folder
PUT	`/api/v1/plugin/folders/{folder_name}/plugins`	Update folder plugins. Body: array

方法	路径	说明
GET	`/api/v1/plugin/`	列出插件。参数： `state` （installed/market/all）、 `force`
GET	`/api/v1/plugin/installed`	列出已安装插件
GET	`/api/v1/plugin/statistic`	插件安装统计数据
GET	`/api/v1/plugin/install/{plugin_id}`	安装插件。参数： `repo_url` 、 `force`
GET	`/api/v1/plugin/reload/{plugin_id}`	重载插件
GET	`/api/v1/plugin/reset/{plugin_id}`	重置插件配置和数据
GET	`/api/v1/plugin/{plugin_id}`	获取插件配置
PUT	`/api/v1/plugin/{plugin_id}`	更新插件配置。请求体：JSON对象
DELETE	`/api/v1/plugin/{plugin_id}`	卸载插件
POST	`/api/v1/plugin/clone/{plugin_id}`	克隆插件。请求体：JSON对象
GET	`/api/v1/plugin/form/{plugin_id}`	插件表单页
GET	`/api/v1/plugin/page/{plugin_id}`	插件数据页
GET	`/api/v1/plugin/remotes`	插件联邦列表。参数： `token` （必填）
GET	`/api/v1/plugin/dashboard/meta`	所有插件仪表盘元数据
GET	`/api/v1/plugin/dashboard/{plugin_id}/{key}`	按key获取插件仪表盘
GET	`/api/v1/plugin/dashboard/{plugin_id}`	插件仪表盘
GET	`/api/v1/plugin/file/{plugin_id}/{filepath}`	插件静态文件
GET	`/api/v1/plugin/folders`	插件文件夹配置
POST	`/api/v1/plugin/folders`	保存插件文件夹配置
POST	`/api/v1/plugin/folders/{folder_name}`	创建插件文件夹
DELETE	`/api/v1/plugin/folders/{folder_name}`	删除插件文件夹
PUT	`/api/v1/plugin/folders/{folder_name}/plugins`	更新文件夹内插件。请求体：数组

Workflow (16 endpoints)

工作流（16个接口）

Method	Path	Description
GET	`/api/v1/workflow/`	List all workflows
POST	`/api/v1/workflow/`	Create workflow. Body: Workflow JSON
GET	`/api/v1/workflow/{workflow_id}`	Workflow detail
PUT	`/api/v1/workflow/{workflow_id}`	Update workflow. Body: Workflow JSON
DELETE	`/api/v1/workflow/{workflow_id}`	Delete workflow
POST	`/api/v1/workflow/{workflow_id}/run`	Run workflow. Params: `from_begin`
POST	`/api/v1/workflow/{workflow_id}/start`	Enable workflow
POST	`/api/v1/workflow/{workflow_id}/pause`	Disable workflow
POST	`/api/v1/workflow/{workflow_id}/reset`	Reset workflow
GET	`/api/v1/workflow/actions`	List all actions
GET	`/api/v1/workflow/plugin/actions`	Plugin actions. Params: `plugin_id`
GET	`/api/v1/workflow/event_types`	List event types
POST	`/api/v1/workflow/share`	Share workflow. Body: WorkflowShare JSON
DELETE	`/api/v1/workflow/share/{share_id}`	Delete shared workflow
POST	`/api/v1/workflow/fork`	Fork shared workflow. Body: WorkflowShare JSON
GET	`/api/v1/workflow/shares`	List shared workflows. Params: `name` , `page` , `count`

方法	路径	说明
GET	`/api/v1/workflow/`	列出所有工作流
POST	`/api/v1/workflow/`	创建工作流。请求体：Workflow JSON
GET	`/api/v1/workflow/{workflow_id}`	工作流详情
PUT	`/api/v1/workflow/{workflow_id}`	更新工作流。请求体：Workflow JSON
DELETE	`/api/v1/workflow/{workflow_id}`	删除工作流
POST	`/api/v1/workflow/{workflow_id}/run`	运行工作流。参数： `from_begin`
POST	`/api/v1/workflow/{workflow_id}/start`	启用工作流
POST	`/api/v1/workflow/{workflow_id}/pause`	禁用工作流
POST	`/api/v1/workflow/{workflow_id}/reset`	重置工作流
GET	`/api/v1/workflow/actions`	列出所有动作
GET	`/api/v1/workflow/plugin/actions`	插件动作。参数： `plugin_id`
GET	`/api/v1/workflow/event_types`	列出事件类型
POST	`/api/v1/workflow/share`	分享工作流。请求体：WorkflowShare JSON
DELETE	`/api/v1/workflow/share/{share_id}`	删除分享的工作流
POST	`/api/v1/workflow/fork`	复刻分享的工作流。请求体：WorkflowShare JSON
GET	`/api/v1/workflow/shares`	列出分享的工作流。参数： `name` 、 `page` 、 `count`

System (20 endpoints)

系统（20个接口）

Method	Path	Description
GET	`/api/v1/system/env`	Get system configuration
POST	`/api/v1/system/env`	Update system configuration. Body: JSON object
GET	`/api/v1/system/setting/{key}`	Get system setting
POST	`/api/v1/system/setting/{key}`	Update system setting
GET	`/api/v1/system/global`	Non-sensitive settings. Params: `token` (required)
GET	`/api/v1/system/global/user`	User-related settings
GET	`/api/v1/system/restart`	Restart system
GET	`/api/v1/system/runscheduler`	Run scheduled service. Params: `jobid` (required)
GET	`/api/v1/system/runscheduler2`	Run scheduler (API_TOKEN, use `--token-param` ). Params: `jobid`
GET	`/api/v1/system/modulelist`	List loaded modules
GET	`/api/v1/system/moduletest/{moduleid}`	Test module availability
GET	`/api/v1/system/versions`	List all GitHub releases
GET	`/api/v1/system/ruletest`	Test filter rule. Params: `title` (required), `rulegroup_name` (required), `subtitle`
GET	`/api/v1/system/nettest`	Test network connectivity. Params: `url` (required), `proxy` (required), `include`
GET	`/api/v1/system/llm-models`	List LLM models. Params: `provider` (required), `api_key` (required), `base_url`
GET	`/api/v1/system/progress/{process_type}`	Real-time progress (SSE)
GET	`/api/v1/system/message`	Real-time messages (SSE). Params: `role`
GET	`/api/v1/system/logging`	Real-time logs (SSE). Params: `length` , `logfile`
GET	`/api/v1/system/img/{proxy}`	Image proxy. Params: `imgurl` (required), `cache` , `use_cookies`
GET	`/api/v1/system/cache/image`	Cached image. Params: `url` (required)

方法	路径	说明
GET	`/api/v1/system/env`	获取系统配置
POST	`/api/v1/system/env`	更新系统配置。请求体：JSON对象
GET	`/api/v1/system/setting/{key}`	获取系统设置
POST	`/api/v1/system/setting/{key}`	更新系统设置
GET	`/api/v1/system/global`	非敏感设置。参数： `token` （必填）
GET	`/api/v1/system/global/user`	用户相关设置
GET	`/api/v1/system/restart`	重启系统
GET	`/api/v1/system/runscheduler`	运行定时服务。参数： `jobid` （必填）
GET	`/api/v1/system/runscheduler2`	运行定时服务（通过API_TOKEN认证，需使用 `--token-param` ）。参数： `jobid`
GET	`/api/v1/system/modulelist`	列出已加载模块
GET	`/api/v1/system/moduletest/{moduleid}`	测试模块可用性
GET	`/api/v1/system/versions`	列出所有GitHub releases
GET	`/api/v1/system/ruletest`	测试过滤规则。参数： `title` （必填）、 `rulegroup_name` （必填）、 `subtitle`
GET	`/api/v1/system/nettest`	测试网络连通性。参数： `url` （必填）、 `proxy` （必填）、 `include`
GET	`/api/v1/system/llm-models`	列出LLM模型。参数： `provider` （必填）、 `api_key` （必填）、 `base_url`
GET	`/api/v1/system/progress/{process_type}`	实时进度（SSE）
GET	`/api/v1/system/message`	实时消息（SSE）。参数： `role`
GET	`/api/v1/system/logging`	实时日志（SSE）。参数： `length` 、 `logfile`
GET	`/api/v1/system/img/{proxy}`	图片代理。参数： `imgurl` （必填）、 `cache` 、 `use_cookies`
GET	`/api/v1/system/cache/image`	缓存图片。参数： `url` （必填）

Discover (6 endpoints)

发现（6个接口）

Method	Path	Description
GET	`/api/v1/discover/source`	Discover data sources
GET	`/api/v1/discover/bangumi`	Discover Bangumi. Params: `type` , `cat` , `sort` , `year` , `page` , `count`
GET	`/api/v1/discover/douban_movies`	Discover Douban movies. Params: `sort` , `tags` , `page` , `count`
GET	`/api/v1/discover/douban_tvs`	Discover Douban TV. Params: `sort` , `tags` , `page` , `count`
GET	`/api/v1/discover/tmdb_movies`	Discover TMDB movies. Params: `sort_by` , `with_genres` , `with_original_language` , `page`
GET	`/api/v1/discover/tmdb_tvs`	Discover TMDB TV. Params: same as movies

方法	路径	说明
GET	`/api/v1/discover/source`	发现数据源
GET	`/api/v1/discover/bangumi`	发现Bangumi内容。参数： `type` 、 `cat` 、 `sort` 、 `year` 、 `page` 、 `count`
GET	`/api/v1/discover/douban_movies`	发现豆瓣电影。参数： `sort` 、 `tags` 、 `page` 、 `count`
GET	`/api/v1/discover/douban_tvs`	发现豆瓣电视剧。参数： `sort` 、 `tags` 、 `page` 、 `count`
GET	`/api/v1/discover/tmdb_movies`	发现TMDB电影。参数： `sort_by` 、 `with_genres` 、 `with_original_language` 、 `page`
GET	`/api/v1/discover/tmdb_tvs`	发现TMDB电视剧。参数：同电影

Recommend (14 endpoints)

Method	Path	Description
GET	`/api/v1/recommend/source`	Recommendation data sources
GET	`/api/v1/recommend/bangumi_calendar`	Bangumi daily schedule. Params: `page` , `count`
GET	`/api/v1/recommend/douban_showing`	Douban now showing. Params: `page` , `count`
GET	`/api/v1/recommend/douban_movies`	Douban movies. Params: `sort` , `tags` , `page` , `count`
GET	`/api/v1/recommend/douban_tvs`	Douban TV. Params: `sort` , `tags` , `page` , `count`
GET	`/api/v1/recommend/douban_movie_top250`	Douban Top 250 movies. Params: `page` , `count`
GET	`/api/v1/recommend/douban_tv_weekly_chinese`	Douban Chinese TV weekly. Params: `page` , `count`
GET	`/api/v1/recommend/douban_tv_weekly_global`	Douban Global TV weekly. Params: `page` , `count`
GET	`/api/v1/recommend/douban_tv_animation`	Douban animation. Params: `page` , `count`
GET	`/api/v1/recommend/douban_movie_hot`	Douban hot movies. Params: `page` , `count`
GET	`/api/v1/recommend/douban_tv_hot`	Douban hot TV. Params: `page` , `count`
GET	`/api/v1/recommend/tmdb_movies`	TMDB movies. Params: `sort_by` , `with_genres` , `page`
GET	`/api/v1/recommend/tmdb_tvs`	TMDB TV. Params: `sort_by` , `with_genres` , `page`
GET	`/api/v1/recommend/tmdb_trending`	TMDB trending. Params: `page`

方法	路径	说明
GET	`/api/v1/recommend/source`	推荐数据源
GET	`/api/v1/recommend/bangumi_calendar`	Bangumi每日放送表。参数： `page` 、 `count`
GET	`/api/v1/recommend/douban_showing`	豆瓣正在热映。参数： `page` 、 `count`
GET	`/api/v1/recommend/douban_movies`	豆瓣电影。参数： `sort` 、 `tags` 、 `page` 、 `count`
GET	`/api/v1/recommend/douban_tvs`	豆瓣电视剧。参数： `sort` 、 `tags` 、 `page` 、 `count`
GET	`/api/v1/recommend/douban_movie_top250`	豆瓣电影Top250。参数： `page` 、 `count`
GET	`/api/v1/recommend/douban_tv_weekly_chinese`	豆瓣国产电视剧一周口碑榜。参数： `page` 、 `count`
GET	`/api/v1/recommend/douban_tv_weekly_global`	豆瓣全球电视剧一周口碑榜。参数： `page` 、 `count`
GET	`/api/v1/recommend/douban_tv_animation`	豆瓣动画。参数： `page` 、 `count`
GET	`/api/v1/recommend/douban_movie_hot`	豆瓣热门电影。参数： `page` 、 `count`
GET	`/api/v1/recommend/douban_tv_hot`	豆瓣热门电视剧。参数： `page` 、 `count`
GET	`/api/v1/recommend/tmdb_movies`	TMDB电影。参数： `sort_by` 、 `with_genres` 、 `page`
GET	`/api/v1/recommend/tmdb_tvs`	TMDB电视剧。参数： `sort_by` 、 `with_genres` 、 `page`
GET	`/api/v1/recommend/tmdb_trending`	TMDB热门内容。参数： `page`

Torrent Cache (5 endpoints)

种子缓存（5个接口）

Method	Path	Description
GET	`/api/v1/torrent/cache`	Get torrent cache
DELETE	`/api/v1/torrent/cache`	Clear torrent cache
DELETE	`/api/v1/torrent/cache/{domain}/{torrent_hash}`	Delete specific torrent cache
POST	`/api/v1/torrent/cache/refresh`	Refresh torrent cache
POST	`/api/v1/torrent/cache/reidentify/{domain}/{torrent_hash}`	Re-identify torrent. Params: `tmdbid` , `doubanid`

方法	路径	说明
GET	`/api/v1/torrent/cache`	获取种子缓存
DELETE	`/api/v1/torrent/cache`	清空种子缓存
DELETE	`/api/v1/torrent/cache/{domain}/{torrent_hash}`	删除指定种子缓存
POST	`/api/v1/torrent/cache/refresh`	刷新种子缓存
POST	`/api/v1/torrent/cache/reidentify/{domain}/{torrent_hash}`	重新识别种子。参数： `tmdbid` 、 `doubanid`

Message (6 endpoints)

消息（6个接口）

Method	Path	Description
POST	`/api/v1/message/`	Receive user message. Params: `token` , `source`
GET	`/api/v1/message/`	Callback verification. Params: `token` , `echostr` , `msg_signature` , `timestamp` , `nonce` , `source`
POST	`/api/v1/message/web`	Send web message. Params: `text` (required)
GET	`/api/v1/message/web`	Get web messages. Params: `page` , `count`
POST	`/api/v1/message/webpush/subscribe`	WebPush subscribe. Body: Subscription JSON
POST	`/api/v1/message/webpush/send`	Send WebPush notification. Body: SubscriptionMessage JSON

方法	路径	说明
POST	`/api/v1/message/`	接收用户消息。参数： `token` 、 `source`
GET	`/api/v1/message/`	回调校验。参数： `token` 、 `echostr` 、 `msg_signature` 、 `timestamp` 、 `nonce` 、 `source`
POST	`/api/v1/message/web`	发送网页消息。参数： `text` （必填）
GET	`/api/v1/message/web`	获取网页消息。参数： `page` 、 `count`
POST	`/api/v1/message/webpush/subscribe`	WebPush订阅。请求体：Subscription JSON
POST	`/api/v1/message/webpush/send`	发送WebPush通知。请求体：SubscriptionMessage JSON

User (10 endpoints)

用户（10个接口）

Method	Path	Description
GET	`/api/v1/user/`	List all users
POST	`/api/v1/user/`	Create user. Body: UserCreate JSON
PUT	`/api/v1/user/`	Update user. Body: UserUpdate JSON
GET	`/api/v1/user/current`	Current logged-in user
GET	`/api/v1/user/{username}`	User detail
DELETE	`/api/v1/user/id/{user_id}`	Delete user by ID
DELETE	`/api/v1/user/name/{user_name}`	Delete user by username
POST	`/api/v1/user/avatar/{user_id}`	Upload avatar. Body: multipart/form-data
GET	`/api/v1/user/config/{key}`	Get user config
POST	`/api/v1/user/config/{key}`	Update user config

方法	路径	说明
GET	`/api/v1/user/`	列出所有用户
POST	`/api/v1/user/`	创建用户。请求体：UserCreate JSON
PUT	`/api/v1/user/`	更新用户。请求体：UserUpdate JSON
GET	`/api/v1/user/current`	当前登录用户
GET	`/api/v1/user/{username}`	用户详情
DELETE	`/api/v1/user/id/{user_id}`	按ID删除用户
DELETE	`/api/v1/user/name/{user_name}`	按用户名删除用户
POST	`/api/v1/user/avatar/{user_id}`	上传头像。请求体：multipart/form-data
GET	`/api/v1/user/config/{key}`	获取用户配置
POST	`/api/v1/user/config/{key}`	更新用户配置

Login (3 endpoints)

登录（3个接口）

Method	Path	Description
POST	`/api/v1/login/access-token`	Get JWT access token. Body: form (username, password)
GET	`/api/v1/login/wallpaper`	Login page wallpaper
GET	`/api/v1/login/wallpapers`	Login page wallpaper list

方法	路径	说明
POST	`/api/v1/login/access-token`	获取JWT访问令牌。请求体：表单（username, password）
GET	`/api/v1/login/wallpaper`	登录页壁纸
GET	`/api/v1/login/wallpapers`	登录页壁纸列表

MCP Tools (6 endpoints)

MCP工具（6个接口）

Method	Path	Description
POST	`/api/v1/mcp`	MCP JSON-RPC 2.0 endpoint
DELETE	`/api/v1/mcp`	Terminate MCP session
GET	`/api/v1/mcp/tools`	List all exposed tools
POST	`/api/v1/mcp/tools/call`	Call a tool. Body: `{"tool_name":"...","arguments":{...}}`
GET	`/api/v1/mcp/tools/{tool_name}`	Get tool definition
GET	`/api/v1/mcp/tools/{tool_name}/schema`	Get tool input schema

方法	路径	说明
POST	`/api/v1/mcp`	MCP JSON-RPC 2.0接口
DELETE	`/api/v1/mcp`	终止MCP会话
GET	`/api/v1/mcp/tools`	列出所有暴露的工具
POST	`/api/v1/mcp/tools/call`	调用工具。请求体： `{"tool_name":"...","arguments":{...}}`
GET	`/api/v1/mcp/tools/{tool_name}`	获取工具定义
GET	`/api/v1/mcp/tools/{tool_name}/schema`	获取工具输入schema

Webhook (2 endpoints)

Webhook（2个接口）

Method	Path	Description
GET	`/api/v1/webhook/`	Webhook message (GET). Params: `token` , `source`
POST	`/api/v1/webhook/`	Webhook message (POST). Params: `token` , `source`

方法	路径	说明
GET	`/api/v1/webhook/`	Webhook消息（GET请求）。参数： `token` 、 `source`
POST	`/api/v1/webhook/`	Webhook消息（POST请求）。参数： `token` 、 `source`

Servarr Compatibility -- /api/v3 (16 endpoints)

Servarr兼容 -- /api/v3（16个接口）

Radarr/Sonarr compatible API for integration with external tools.

Method	Path	Description
GET	`/api/v3/system/status`	System status
GET	`/api/v3/qualityProfile`	Quality profiles
GET	`/api/v3/rootfolder`	Root folders
GET	`/api/v3/tag`	Tags
GET	`/api/v3/languageprofile`	Languages
GET	`/api/v3/movie`	All subscribed movies
POST	`/api/v3/movie`	Add movie subscription. Body: RadarrMovie JSON
GET	`/api/v3/movie/lookup`	Search movie. Params: `term` (format: `tmdb:123` )
GET	`/api/v3/movie/{mid}`	Movie detail
DELETE	`/api/v3/movie/{mid}`	Delete movie subscription
GET	`/api/v3/series`	All TV series
POST	`/api/v3/series`	Add TV subscription. Body: SonarrSeries JSON
PUT	`/api/v3/series`	Update TV subscription. Body: SonarrSeries JSON
GET	`/api/v3/series/lookup`	Search TV. Params: `term` (format: `tvdb:123` )
GET	`/api/v3/series/{tid}`	TV detail
DELETE	`/api/v3/series/{tid}`	Delete TV subscription

Radarr/Sonarr兼容API，用于与外部工具集成。

方法	路径	说明
GET	`/api/v3/system/status`	系统状态
GET	`/api/v3/qualityProfile`	质量配置文件
GET	`/api/v3/rootfolder`	根文件夹
GET	`/api/v3/tag`	标签
GET	`/api/v3/languageprofile`	语言
GET	`/api/v3/movie`	所有已订阅电影
POST	`/api/v3/movie`	添加电影订阅。请求体：RadarrMovie JSON
GET	`/api/v3/movie/lookup`	搜索电影。参数： `term` （格式： `tmdb:123` ）
GET	`/api/v3/movie/{mid}`	电影详情
DELETE	`/api/v3/movie/{mid}`	删除电影订阅
GET	`/api/v3/series`	所有电视剧
POST	`/api/v3/series`	添加电视剧订阅。请求体：SonarrSeries JSON
PUT	`/api/v3/series`	更新电视剧订阅。请求体：SonarrSeries JSON
GET	`/api/v3/series/lookup`	搜索电视剧。参数： `term` （格式： `tvdb:123` ）
GET	`/api/v3/series/{tid}`	电视剧详情
DELETE	`/api/v3/series/{tid}`	删除电视剧订阅

CookieCloud -- /cookiecloud (5 endpoints)

CookieCloud -- /cookiecloud（5个接口）

Method	Path	Description
GET	`/cookiecloud/`	Root
POST	`/cookiecloud/`	Root
POST	`/cookiecloud/update`	Upload cookie data. Body: CookieData JSON
GET	`/cookiecloud/get/{uuid}`	Download encrypted data
POST	`/cookiecloud/get/{uuid}`	Download encrypted data (POST)

方法	路径	说明
GET	`/cookiecloud/`	根路径
POST	`/cookiecloud/`	根路径
POST	`/cookiecloud/update`	上传Cookie数据。请求体：CookieData JSON
GET	`/cookiecloud/get/{uuid}`	下载加密数据
POST	`/cookiecloud/get/{uuid}`	下载加密数据（POST请求）

Common Workflows

常用工作流

Search and download a movie

搜索并下载电影

bash

undefined

bash

undefined

1. Search TMDB for the movie

1. 在TMDB中搜索电影

python scripts/mp-api.py GET /api/v1/media/search title="Inception" type="movie"

2. Get media detail (replace {tmdbid} with actual ID)

2. 获取媒体详情（将{tmdbid}替换为实际ID）

python scripts/mp-api.py GET /api/v1/media/27205 type_name="movie"

3. Search torrents

3. 搜索种子

python scripts/mp-api.py GET /api/v1/search/media/tmdb:27205 mtype="movie"

4. Get latest search results

4. 获取最新搜索结果

python scripts/mp-api.py GET /api/v1/search/last

5. Add download

5. 添加下载

python scripts/mp-api.py POST /api/v1/download/add --json '{"torrent_url":"<url_from_search>"}'

undefined

python scripts/mp-api.py POST /api/v1/download/add --json '{"torrent_url":"<url_from_search>"}'

undefined

Add a subscription

添加订阅

bash

undefined

bash

undefined

1. Search for the show

1. 搜索剧集

python scripts/mp-api.py GET /api/v1/media/search title="Breaking Bad" type="tv"

2. Check if already subscribed

2. 检查是否已订阅

python scripts/mp-api.py GET /api/v1/subscribe/media/tmdb:1396

3. Check if already in library

3. 检查是否已在媒体库中

python scripts/mp-api.py GET /api/v1/mediaserver/exists tmdbid=1396 mtype="tv"

4. Add subscription

4. 添加订阅

python scripts/mp-api.py POST /api/v1/subscribe/ --json '{"name":"Breaking Bad","year":"2008","type":"tv","tmdbid":1396}'

undefined

python scripts/mp-api.py POST /api/v1/subscribe/ --json '{"name":"Breaking Bad","year":"2008","type":"tv","tmdbid":1396}'

undefined

System monitoring

系统监控

bash

undefined

bash

undefined

CPU, memory, network

CPU、内存、网络

python scripts/mp-api.py GET /api/v1/dashboard/cpu python scripts/mp-api.py GET /api/v1/dashboard/memory python scripts/mp-api.py GET /api/v1/dashboard/network

Storage

存储

python scripts/mp-api.py GET /api/v1/dashboard/storage

Active downloads

活跃下载任务

python scripts/mp-api.py GET /api/v1/download/

Run a scheduled task

运行定时任务

python scripts/mp-api.py GET /api/v1/system/runscheduler jobid="subscribe_search_all"

undefined

python scripts/mp-api.py GET /api/v1/system/runscheduler jobid="subscribe_search_all"

undefined

Site management

站点管理

bash

undefined

bash

undefined

List all sites

列出所有站点

python scripts/mp-api.py GET /api/v1/site/

Test site connectivity

测试站点连通性

python scripts/mp-api.py GET /api/v1/site/test/1

Get site user data

获取站点用户数据

python scripts/mp-api.py GET /api/v1/site/userdata/1

Sync CookieCloud

同步CookieCloud

python scripts/mp-api.py GET /api/v1/site/cookiecloud

undefined

python scripts/mp-api.py GET /api/v1/site/cookiecloud

undefined

Error Handling

错误处理

Scenario	Action
HTTP 401	API key is invalid or missing. Re-run `configure` with correct `--apikey` .
HTTP 403	Insufficient permissions. The API key grants superuser access; check if the endpoint requires special auth.
HTTP 404	Endpoint or resource not found. Verify the path and path parameters.
HTTP 422	Validation error. Check required parameters and JSON body format.
Connection error	Verify `--host` URL is reachable. Check if MoviePilot is running.
Missing config	Run `python scripts/mp-api.py configure --host <HOST> --apikey <KEY>` first.

场景	处理方式
HTTP 401	API密钥无效或缺失，请重新运行 `configure` 命令传入正确的 `--apikey` 。
HTTP 403	权限不足。API密钥需授予超级用户权限，请检查接口是否需要特殊认证。
HTTP 404	接口或资源不存在，请校验路径和路径参数是否正确。
HTTP 422	参数校验错误，请检查必填参数和JSON请求体格式是否正确。
连接错误	请校验 `--host` URL是否可访问，检查MoviePilot是否正在运行。
配置缺失	请先运行 `python scripts/mp-api.py configure --host <HOST> --apikey <KEY>` 完成配置。

moviepilot-api

Original

Translation

MoviePilot REST API

MoviePilot REST API

Setup

配置步骤

How to Call APIs

API调用方法

General syntax

通用语法

Authentication

认证方式

Examples

示例

GET with query params

带查询参数的GET请求

POST with JSON body

带JSON请求体的POST请求

DELETE

DELETE请求

Endpoints that require ?token= auth

需要通过?token=认证的接口

Complete API Reference

完整API参考

Media Search (13 endpoints)

媒体搜索（13个接口）

TMDB (8 endpoints)

TMDB（8个接口）

Douban (5 endpoints)

Douban（5个接口）

Bangumi (5 endpoints)

Bangumi（5个接口）

Search / Torrents (4 endpoints)

搜索/种子（4个接口）

Download (7 endpoints)

下载（7个接口）

Subscribe (28 endpoints)

订阅（28个接口）

Site (24 endpoints)

站点（24个接口）

History (5 endpoints)

历史记录（5个接口）

Media Server (8 endpoints)

媒体服务器（8个接口）

Storage / Files (13 endpoints)

存储/文件（13个接口）

Transfer (5 endpoints)

转移（5个接口）

Dashboard (16 endpoints)

仪表盘（16个接口）

Plugin (22 endpoints)

插件（22个接口）

Workflow (16 endpoints)

工作流（16个接口）

System (20 endpoints)

系统（20个接口）

Discover (6 endpoints)

发现（6个接口）

Recommend (14 endpoints)

推荐（14个接口）

Torrent Cache (5 endpoints)

种子缓存（5个接口）

Message (6 endpoints)

消息（6个接口）

User (10 endpoints)

用户（10个接口）

Login (3 endpoints)

登录（3个接口）

MCP Tools (6 endpoints)

MCP工具（6个接口）

Webhook (2 endpoints)

Webhook（2个接口）

Servarr Compatibility -- /api/v3 (16 endpoints)

Servarr兼容 -- /api/v3（16个接口）

CookieCloud -- /cookiecloud (5 endpoints)

CookieCloud -- /cookiecloud（5个接口）

Common Workflows

常用工作流

Search and download a movie