### All-in-one Setup for MoviePilot

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Performs a complete setup of MoviePilot, including initialization and dependency installation. Options for wizard mode, recreation, and superuser setup are available.

```bash
moviepilot setup
moviepilot setup --wizard
moviepilot setup --recreate
moviepilot setup --superuser admin --superuser-password 'ChangeMe123!'
```

--------------------------------

### Install Resource Files

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Installs necessary resource files for MoviePilot.

```bash
moviepilot install resources
```

--------------------------------

### Install pip-tools and Project Dependencies

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Installs pip-tools for dependency management and then installs project dependencies from requirements.txt.

```bash
pip install pip-tools
pip install -r requirements.txt
```

--------------------------------

### GET Request with Query Parameters

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Example of a GET request to search for media by title and type. Parameters are appended to the URL.

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

--------------------------------

### Install Frontend Release

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Installs the MoviePilot frontend, with options to specify the version, including the latest release.

```bash
moviepilot install frontend
moviepilot install frontend --version latest
moviepilot install frontend --version v2.9.31
```

--------------------------------

### Install MoviePilot Locally

Source: https://github.com/jxxghp/moviepilot/blob/v2/README_EN.md

Installs MoviePilot locally using a shell script. This is an alternative to Docker deployment.

```shell
curl -fsSL https://raw.githubusercontent.com/jxxghp/MoviePilot/v2/scripts/bootstrap-local.sh | bash
```

--------------------------------

### Install Backend Dependencies

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Installs backend dependencies for MoviePilot. Options include specifying the Python version or a virtual environment path, and recreating the environment.

```bash
moviepilot install deps
moviepilot install deps --python python3.11
moviepilot install deps --venv /path/to/venv
moviepilot install deps --recreate
```

--------------------------------

### Start MoviePilot Service

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Starts the MoviePilot service. An optional timeout can be specified in seconds.

```bash
moviepilot start
moviepilot start --timeout 60
```

--------------------------------

### MoviePilot Skill Frontmatter Example

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/create-moviepilot-skill/SKILL.md

An example of the frontmatter for the create-moviepilot-skill, specifying its name, version, a descriptive trigger, and the tools it utilizes.

```markdown
---
name: create-moviepilot-skill
version: 1
description: >-
  Use this skill when the user asks to create, scaffold, update, or review a
  MoviePilot agent skill. This includes adding a new built-in skill under the
  repository `skills/` directory, editing an existing built-in skill, writing
  `SKILL.md` frontmatter and workflow instructions, choosing `allowed-tools`,
  adding helper scripts when needed, and bumping the built-in skill `version`
  so changes can sync into `config/agent/skills`.
allowed-tools: list_directory read_file write_file edit_file execute_command
---
```

--------------------------------

### Configure MoviePilot API Client

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-update/SKILL.md

Configure the host and API key for the moviepilot-api client. This is a one-time setup.

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

--------------------------------

### GET /api/v1/user/config/{key}

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Get a user configuration value by key. Requires 'key' in the path.

```APIDOC
## GET /api/v1/user/config/{key}

### Description
Get user config.

### Method
GET

### Endpoint
/api/v1/user/config/{key}

### Parameters
#### Path Parameters
- **key** (string) - Required - The configuration key.

```

--------------------------------

### GET /api/v1/webhook/

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Webhook message endpoint (GET). Requires 'token' and 'source' parameters.

```APIDOC
## GET /api/v1/webhook/

### Description
Webhook message (GET).

### Method
GET

### Endpoint
/api/v1/webhook/

### Parameters
#### Query Parameters
- **token** (string) - Required - Webhook token.
- **source** (string) - Required - Message source.

```

--------------------------------

### GET /api/v1/mcp/tools/{tool_name}

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Get the definition of a specific MCP tool. Requires 'tool_name' in the path.

```APIDOC
## GET /api/v1/mcp/tools/{tool_name}

### Description
Get tool definition.

### Method
GET

### Endpoint
/api/v1/mcp/tools/{tool_name}

### Parameters
#### Path Parameters
- **tool_name** (string) - Required - The name of the tool.

```

--------------------------------

### Get MoviePilot Service Version

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Displays the version information for the MoviePilot service.

```bash
moviepilot version
```

--------------------------------

### Get Bangumi Recommendations

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve media recommendations from Bangumi. Supports pagination with optional page and count parameters.

```bash
python scripts/mp-api.py GET /api/v1/bangumi/recommend/{bangumiid} page=1 count=20
```

--------------------------------

### GET /api/v1/mcp/tools

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

List all exposed MCP tools. No parameters required.

```APIDOC
## GET /api/v1/mcp/tools

### Description
List all exposed tools.

### Method
GET

### Endpoint
/api/v1/mcp/tools

```

--------------------------------

### Get Bangumi Detail

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve detailed information for a Bangumi entry using its Bangumi ID. This is a GET request.

```bash
python scripts/mp-api.py GET /api/v1/bangumi/{bangumiid}
```

--------------------------------

### Get Douban Media Detail

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve detailed information for a media item from Douban using its Douban ID. This is a GET request.

```bash
python scripts/mp-api.py GET /api/v1/douban/{doubanid}
```

--------------------------------

### Get MoviePilot Configuration Path

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Retrieves the file path to the current MoviePilot configuration.

```bash
moviepilot config path
```

--------------------------------

### Manage MoviePilot Startup on Boot

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Controls whether MoviePilot starts automatically on system boot. Commands check status, enable, or disable the startup service. Can specify a venv path.

```bash
moviepilot startup status
moviepilot startup enable
moviepilot startup disable
moviepilot startup enable --venv /path/to/venv
```

--------------------------------

### GET /api/v1/login/wallpaper

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve the login page wallpaper. No parameters required.

```APIDOC
## GET /api/v1/login/wallpaper

### Description
Login page wallpaper.

### Method
GET

### Endpoint
/api/v1/login/wallpaper

```

--------------------------------

### GET /cookiecloud/

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Root endpoint for CookieCloud. No parameters specified.

```APIDOC
## GET /cookiecloud/

### Description
Root.

### Method
GET

### Endpoint
/cookiecloud/

```

--------------------------------

### GET /api/v1/login/wallpapers

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve a list of login page wallpapers. No parameters required.

```APIDOC
## GET /api/v1/login/wallpapers

### Description
Login page wallpaper list.

### Method
GET

### Endpoint
/api/v1/login/wallpapers

```

--------------------------------

### Direct API Calls for Restart and Upgrade

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-update/SKILL.md

Examples of directly calling the MoviePilot API endpoints for restart and upgrade operations using the mp-api script.

```bash
python ../moviepilot-api/scripts/mp-api.py GET /api/v1/system/restart
```

```bash
python ../moviepilot-api/scripts/mp-api.py POST /api/v1/system/upgrade --json '"release"'
```

```bash
python ../moviepilot-api/scripts/mp-api.py POST /api/v1/system/upgrade --json '"dev"'
```

--------------------------------

### GET /api/v3/system/status

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve the system status. Compatible with Radarr/Sonarr API.

```APIDOC
## GET /api/v3/system/status

### Description
System status.

### Method
GET

### Endpoint
/api/v3/system/status

```

--------------------------------

### GET /api/v1/user/

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

List all users. No parameters required.

```APIDOC
## GET /api/v1/user/

### Description
List all users.

### Method
GET

### Endpoint
/api/v1/user/

```

--------------------------------

### UserConfig - Get and Set Per-User Settings

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/10-data-and-persistent.md

Manage user-specific configuration settings using UserConfigOper. Requires user ID and a key for the setting.

```python
from app.db.userconfig_oper import UserConfigOper

oper = UserConfigOper()
value = oper.get(user_id=1, key="notification_enabled")
oper.set(user_id=1, key="notification_enabled", value=True)
```

--------------------------------

### Get Specific MoviePilot Configuration Value

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Retrieves the value of a specific configuration setting, like PORT.

```bash
moviepilot config get PORT
```

--------------------------------

### Get Media Season Info

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve media season information. Requires media ID and optionally title, year, and season number.

```bash
python scripts/mp-api.py GET /api/v1/media/seasons mediaid=123 title="The Office" year=2005 season=1
```

--------------------------------

### GET /api/v3/rootfolder

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve a list of root folders. Compatible with Radarr/Sonarr API.

```APIDOC
## GET /api/v3/rootfolder

### Description
Root folders.

### Method
GET

### Endpoint
/api/v3/rootfolder

```

--------------------------------

### Get Douban Recommendations

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve media recommendations from Douban. Requires Douban ID and media type name (movie/tv).

```bash
python scripts/mp-api.py GET /api/v1/douban/recommend/{doubanid}/{type_name}
```

--------------------------------

### Get Media Detail

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve detailed information for a specific media. Requires media type name (movie/tv) and optionally title and year.

```bash
python scripts/mp-api.py GET /api/v1/media/{mediaid} type_name=movie title="Avatar" year=2009
```

--------------------------------

### Search and Download a Movie Workflow

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

This workflow demonstrates how to search for a movie on TMDB, retrieve its details, search for torrents, get the latest search results, and add a download using the moviepilot-api script.

```bash
# 1. Search TMDB for the movie
python scripts/mp-api.py GET /api/v1/media/search title="Inception" type="movie"
```

```bash
# 2. Get media detail (replace {tmdbid} with actual ID)
python scripts/mp-api.py GET /api/v1/media/27205 type_name="movie"
```

```bash
# 3. Search torrents
python scripts/mp-api.py GET /api/v1/search/media/tmdb:27205 mtype="movie"
```

```bash
# 4. Get latest search results
python scripts/mp-api.py GET /api/v1/search/last
```

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

--------------------------------

### POST Request with JSON Body

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Example of a POST request to add a download, including a JSON body with the torrent URL. The `--json` flag is used to pass the body.

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

--------------------------------

### Check MoviePilot Versions

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-update/SKILL.md

Use this command to check the current versions of MoviePilot components. It calls the GET /api/v1/system/versions endpoint.

```bash
python scripts/mp-update.py versions
```

--------------------------------

### GET /api/v1/message/

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Callback verification endpoint. Requires 'token', 'echostr', 'msg_signature', 'timestamp', 'nonce', and 'source' parameters.

```APIDOC
## GET /api/v1/message/

### Description
Callback verification.

### Method
GET

### Endpoint
/api/v1/message/

### Parameters
#### Query Parameters
- **token** (string) - Required - User token.
- **echostr** (string) - Required - Echo string for verification.
- **msg_signature** (string) - Required - Message signature.
- **timestamp** (string) - Required - Timestamp of the message.
- **nonce** (string) - Required - Nonce for verification.
- **source** (string) - Required - Message source.

```

--------------------------------

### DELETE Request

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Example of a DELETE request to remove a subscription. This demonstrates a simple DELETE operation with a path parameter.

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

--------------------------------

### Show command parameters and usage

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-cli/SKILL.md

Before executing any command, use this to understand its parameters and how to use it. Parameter names are not inferable.

```bash
node scripts/mp-cli.js show <command>
```

--------------------------------

### API Endpoint Requiring Token Parameter Authentication

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Example of calling an endpoint that requires the API key to be sent as a query parameter (`?token=`) instead of a header. Use the `--token-param` flag for such endpoints.

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

--------------------------------

### Add Subscription from Specific Episode

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-cli/SKILL.md

Subscribe to a TV show starting from a particular season and episode. Useful for shows with multiple parts or delayed releases.

```bash
node scripts/mp-cli.js add_subscribe title="..." year="2024" media_type="tv" tmdb_id=12345 season=1 start_episode=13
```

--------------------------------

### Show Tool Parameters

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Displays the parameters and expected arguments for a specific MoviePilot tool.

```bash
moviepilot tool show query_schedulers
moviepilot tool show search_torrents
```

--------------------------------

### GET /api/v1/user/{username}

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Get details for a specific user by username. Requires 'username' in the path.

```APIDOC
## GET /api/v1/user/{username}

### Description
User detail.

### Method
GET

### Endpoint
/api/v1/user/{username}

### Parameters
#### Path Parameters
- **username** (string) - Required - The username of the user.

```

--------------------------------

### Create and Activate Virtual Environment

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Sets up a Python virtual environment for project isolation. Activate it using the appropriate command for your operating system.

```bash
python3 -m venv venv
source venv/bin/activate          # macOS / Linux
.\venv\Scripts\activate           # Windows
```

--------------------------------

### Initialize Local Configuration

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Initializes the local configuration for MoviePilot. Options include using a wizard, forcing a token, or setting superuser credentials.

```bash
moviepilot init
moviepilot init --wizard
moviepilot init --force-token
moviepilot init --superuser admin --superuser-password 'ChangeMe123!'
```

--------------------------------

### Get TMDB Seasons for a Title

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve all seasons for a given TMDB title ID. This is a GET request.

```bash
python scripts/mp-api.py GET /api/v1/tmdb/seasons/{tmdbid}
```

--------------------------------

### List All MoviePilot Tools

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Displays a list of all available tools that can be managed or run through the MoviePilot CLI.

```bash
moviepilot tool list
```

--------------------------------

### GET /api/v1/mcp/tools/{tool_name}/schema

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Get the input schema for a specific MCP tool. Requires 'tool_name' in the path.

```APIDOC
## GET /api/v1/mcp/tools/{tool_name}/schema

### Description
Get tool input schema.

### Method
GET

### Endpoint
/api/v1/mcp/tools/{tool_name}/schema

### Parameters
#### Path Parameters
- **tool_name** (string) - Required - The name of the tool.

```

--------------------------------

### List all available commands

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-cli/SKILL.md

Use this command to see all the commands supported by the MoviePilot CLI.

```bash
node scripts/mp-cli.js list
```

--------------------------------

### Compile requirements.txt from requirements.in

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Recompiles the entire requirements.txt file from requirements.in. This command should be run after editing requirements.in.

```bash
pip-compile requirements.in
```

--------------------------------

### Get Media Episode Groups

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve media episode groups based on a TMDB ID. This is a GET request.

```bash
python scripts/mp-api.py GET /api/v1/media/groups/{tmdbid}
```

--------------------------------

### Get Bangumi Person Detail

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve detailed information for a person from Bangumi using their person ID. This is a GET request.

```bash
python scripts/mp-api.py GET /api/v1/bangumi/person/{person_id}
```

--------------------------------

### List All MoviePilot Configuration Settings

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Displays all current configuration settings for MoviePilot. Use --show-secrets to include sensitive values.

```bash
moviepilot config list
moviepilot config list --show-secrets
```

--------------------------------

### Get Douban Person Detail

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve detailed information for a person from Douban using their person ID. This is a GET request.

```bash
python scripts/mp-api.py GET /api/v1/douban/person/{person_id}
```

--------------------------------

### List MoviePilot Configuration Keys

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Lists available configuration keys. Can filter by a prefix and show current values.

```bash
moviepilot config keys
moviepilot config keys DB_
moviepilot config keys --show-current
```

--------------------------------

### Get TMDB Person Details

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve detailed information for a specific person based on their TMDB ID. This is a GET request.

```bash
python scripts/mp-api.py GET /api/v1/tmdb/person/{person_id}
```

--------------------------------

### Recognize Media from File Path (Token Auth)

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Recognize media from a file path using token parameter authentication. Requires API key as a query parameter.

```bash
python scripts/mp-api.py GET /api/v1/media/recognize_file2 --token-param path="/path/to/movie.mkv"
```

--------------------------------

### Configure Backend Host and API Key

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-cli/SKILL.md

Set the backend host and API key for the moviepilot-cli tool. This configuration is saved persistently for future commands.

```bash
node scripts/mp-cli.js -h <HOST> -k <KEY>
```

--------------------------------

### Get TMDB Recommended Movies/TV Shows

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve recommended movies or TV shows based on a TMDB ID and media type name. This is a GET request.

```bash
python scripts/mp-api.py GET /api/v1/tmdb/recommend/{tmdbid}/{type_name}
```

--------------------------------

### Access Environment Settings

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/10-data-and-persistent.md

Retrieve deployment and environment configuration values like host and port from settings. These are read-only at runtime.

```python
from app.core.config import settings

host = settings.QB_HOST
port = settings.QB_PORT
```

--------------------------------

### Get Similar Movies/TV Shows from TMDB

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve similar movies or TV shows based on a TMDB ID and media type name. This is a GET request.

```bash
python scripts/mp-api.py GET /api/v1/tmdb/similar/{tmdbid}/{type_name}
```

--------------------------------

### Run Full Test Suite

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/11-quality-and-security.md

Execute all tests when changes affect core application components or runtime.

```bash
pytest
```

--------------------------------

### Go to URL with browse_webpage

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/browser-use/SKILL.md

Use this action to navigate to a specific URL when provided by the user.

```text
browse_webpage action="goto" url="https://example.com"
```

--------------------------------

### GET /api/v3/tag

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve a list of tags. Compatible with Radarr/Sonarr API.

```APIDOC
## GET /api/v3/tag

### Description
Tags.

### Method
GET

### Endpoint
/api/v3/tag

```

--------------------------------

### Configure MoviePilot API

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Configure the backend host and API key for the MoviePilot API. This command persists the configuration to `~/.config/moviepilot_api/config`.

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

--------------------------------

### Add torrent download

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-cli/SKILL.md

Initiate a download for one or more torrents. The `torrent_url` is obtained from the output of `get_search_results`.

```bash
node scripts/mp-cli.js add_download torrent_url="abc1234:1,def5678:2"
```

--------------------------------

### Get Latest Search Results

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieves the most recent search results.

```APIDOC
## GET /api/v1/search/last

### Description
Get latest search results.

### Method
GET

### Endpoint
`/api/v1/search/last`
```

--------------------------------

### GET /api/v3/movie

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve a list of all subscribed movies. Compatible with Radarr/Sonarr API.

```APIDOC
## GET /api/v3/movie

### Description
All subscribed movies.

### Method
GET

### Endpoint
/api/v3/movie

```

--------------------------------

### List Available Download Clients

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieves a list of all available download clients that can be used with the system.

```APIDOC
## GET /api/v1/download/clients

### Description
List available download clients.

### Method
GET

### Endpoint
`/api/v1/download/clients`
```

--------------------------------

### GET /api/v3/languageprofile

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve a list of language profiles. Compatible with Radarr/Sonarr API.

```APIDOC
## GET /api/v3/languageprofile

### Description
Languages.

### Method
GET

### Endpoint
/api/v3/languageprofile

```

--------------------------------

### Recognize Media from File Path

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Recognize media from a given file path. This is a required parameter.

```bash
python scripts/mp-api.py GET /api/v1/media/recognize_file path="/path/to/movie.mkv"
```

--------------------------------

### Add MoviePilot Skills to an Environment

Source: https://github.com/jxxghp/moviepilot/blob/v2/README_EN.md

Adds MoviePilot operation capabilities to other agents by importing its skills repository. Requires an environment that supports the 'skills' CLI.

```shell
npx skills add https://github.com/jxxghp/MoviePilot
```

--------------------------------

### GET /api/v3/qualityProfile

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve a list of quality profiles. Compatible with Radarr/Sonarr API.

```APIDOC
## GET /api/v3/qualityProfile

### Description
Quality profiles.

### Method
GET

### Endpoint
/api/v3/qualityProfile

```

--------------------------------

### Describe MoviePilot Configuration Setting

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Provides a description for a specific configuration setting, with an option to show secrets.

```bash
moviepilot config describe PORT
moviepilot config describe API_TOKEN --show-secrets
```

--------------------------------

### Manage Sites

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Provides endpoints for managing connected sites, including listing all sites, testing connectivity, retrieving user data, and syncing with CookieCloud.

```bash
# List all sites
python scripts/mp-api.py GET /api/v1/site/
```

```bash
# Test site connectivity
python scripts/mp-api.py GET /api/v1/site/test/1
```

```bash
# Get site user data
python scripts/mp-api.py GET /api/v1/site/userdata/1
```

```bash
# Sync CookieCloud
python scripts/mp-api.py GET /api/v1/site/cookiecloud
```

--------------------------------

### GET /api/v1/user/current

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve details for the currently logged-in user. No parameters required.

```APIDOC
## GET /api/v1/user/current

### Description
Current logged-in user.

### Method
GET

### Endpoint
/api/v1/user/current

```

--------------------------------

### GET /cookiecloud/get/{uuid}

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Download encrypted data by UUID. Requires 'uuid' in the path.

```APIDOC
## GET /cookiecloud/get/{uuid}

### Description
Download encrypted data.

### Method
GET

### Endpoint
/cookiecloud/get/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The UUID of the data to download.

```

--------------------------------

### GET /api/v3/series

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve a list of all subscribed TV series. Compatible with Radarr/Sonarr API.

```APIDOC
## GET /api/v3/series

### Description
All TV series.

### Method
GET

### Endpoint
/api/v3/series

```

--------------------------------

### Standard Data Access Oper Methods

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/10-data-and-persistent.md

Demonstrates common CRUD operations using the Oper pattern for data access. These methods abstract direct SQLAlchemy queries.

```python
oper = SubscribeOper()
subscribe = oper.get(sid=1)           # Get by primary key or filter
subscribes = oper.list()              # List all
oper.add(Subscribe(...))              # Insert
oper.update(sid=1, name="New Name")   # Update by key
oper.delete(sid=1)                    # Delete by key
```

--------------------------------

### Query available sites

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-cli/SKILL.md

Retrieve a list of available sites and their IDs. This is often a prerequisite for searching torrents on specific sites.

```bash
node scripts/mp-cli.js query_sites
```

--------------------------------

### GET /api/v1/message/web

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve web messages. Supports pagination with 'page' and 'count' parameters.

```APIDOC
## GET /api/v1/message/web

### Description
Get web messages.

### Method
GET

### Endpoint
/api/v1/message/web

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number for pagination.
- **count** (integer) - Optional - Number of messages per page.

```

--------------------------------

### Get MoviePilot Service Status

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Checks and displays the current status of the MoviePilot service.

```bash
moviepilot status
```

--------------------------------

### Restart MoviePilot

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-update/SKILL.md

Initiates a restart of the MoviePilot service. This operation calls the GET /api/v1/system/restart endpoint.

```bash
python scripts/mp-update.py restart
```

--------------------------------

### Query Downloading Tasks

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-cli/SKILL.md

List active download tasks. This command is useful for monitoring download progress and obtaining hashes for further operations.

```bash
node scripts/mp-cli.js query_download_tasks status=downloading
```

--------------------------------

### Restart MoviePilot Service

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Restarts the MoviePilot service, allowing for separate timeout configurations for stopping and starting.

```bash
moviepilot restart
moviepilot restart --start-timeout 60 --stop-timeout 30
```

--------------------------------

### Recognize Media from Torrent Title (Token Auth)

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Recognize media from a torrent title using token parameter authentication. Requires API key as a query parameter.

```bash
python scripts/mp-api.py GET /api/v1/media/recognize2 --token-param title="The.Matrix.1999.1080p.BluRay.x264-YTS" subtitle="The Matrix"
```

--------------------------------

### GET /api/v3/movie/lookup

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Search for a movie. Requires a 'term' query parameter (e.g., 'tmdb:123'). Compatible with Radarr/Sonarr API.

```APIDOC
## GET /api/v3/movie/lookup

### Description
Search movie.

### Method
GET

### Endpoint
/api/v3/movie/lookup

### Parameters
#### Query Parameters
- **term** (string) - Required - Search term (format: `tmdb:123`).

```

--------------------------------

### Check Dependencies for Vulnerabilities

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/11-quality-and-security.md

Scan project dependencies against a policy file to identify high-severity vulnerabilities.

```bash
safety check -r requirements.txt --policy-file=safety.policy.yml
```

--------------------------------

### Run MoviePilot Tool Directly

Source: https://github.com/jxxghp/moviepilot/blob/v2/docs/rules/03-commands.md

Executes a specific MoviePilot tool. Arguments can be passed to the tool as needed.

```bash
moviepilot tool run query_schedulers
moviepilot tool run search_torrents media_type=movie tmdb_id=12345
```

--------------------------------

### Search and Download Subtitles Workflow

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

This workflow shows how to search for subtitles by keyword and site, and how to restore the last subtitle search with replayable parameters.

```bash
# 1. Search site subtitles by keyword
python scripts/mp-api.py GET /api/v1/search/subtitle/title keyword="Inception" sites="1,2"
```

```bash
# 2. Restore the last subtitle search with replayable params
python scripts/mp-api.py GET /api/v1/search/last/context
```

--------------------------------

### GET /api/v3/series/lookup

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Search for a TV series. Requires a 'term' query parameter (e.g., 'tvdb:123'). Compatible with Radarr/Sonarr API.

```APIDOC
## GET /api/v3/series/lookup

### Description
Search TV.

### Method
GET

### Endpoint
/api/v3/series/lookup

### Parameters
#### Query Parameters
- **term** (string) - Required - Search term (format: `tvdb:123`).

```

--------------------------------

### GET /api/v3/movie/{mid}

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve details for a specific movie by its ID. Requires 'mid' in the path. Compatible with Radarr/Sonarr API.

```APIDOC
## GET /api/v3/movie/{mid}

### Description
Movie detail.

### Method
GET

### Endpoint
/api/v3/movie/{mid}

### Parameters
#### Path Parameters
- **mid** (string) - Required - The movie ID.

```

--------------------------------

### POST /api/v1/user/config/{key}

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Update a user configuration value by key. Requires 'key' in the path.

```APIDOC
## POST /api/v1/user/config/{key}

### Description
Update user config.

### Method
POST

### Endpoint
/api/v1/user/config/{key}

### Parameters
#### Path Parameters
- **key** (string) - Required - The configuration key.

```

--------------------------------

### Get Bangumi Cast

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieve cast information for a Bangumi entry. Supports pagination with optional page and count parameters.

```bash
python scripts/mp-api.py GET /api/v1/bangumi/credits/{bangumiid} page=1 count=20
```

--------------------------------

### Monitor System Resources

Source: https://github.com/jxxghp/moviepilot/blob/v2/skills/moviepilot-api/SKILL.md

Retrieves system monitoring data including CPU, memory, network, and storage usage. Also allows checking active downloads and running scheduled tasks.

```bash
# CPU, memory, network
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
```

```bash
# Storage
python scripts/mp-api.py GET /api/v1/dashboard/storage
```

```bash
# Active downloads
python scripts/mp-api.py GET /api/v1/download/
```

```bash
# Run a scheduled task
python scripts/mp-api.py GET /api/v1/system/runscheduler jobid="subscribe_search_all"
```