mirror of
https://github.com/jxxghp/MoviePilot.git
synced 2026-11-21 03:13:51 +08:00
14061 lines
461 KiB
JSON
14061 lines
461 KiB
JSON
{
|
|
"$defs": {
|
|
"Action-Input": {
|
|
"description": "One executable action node in a workflow definition.",
|
|
"properties": {
|
|
"branch_policy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow branch policy controlling selected downstream paths.",
|
|
"title": "Branch Policy"
|
|
},
|
|
"concurrency_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow expression used to serialize actions sharing the same runtime key.",
|
|
"title": "Concurrency Key"
|
|
},
|
|
"data": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Serialized workflow action configuration or runtime payload.",
|
|
"title": "Data"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable media, torrent, or subscription description.",
|
|
"title": "Description"
|
|
},
|
|
"fail_policy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow failure policy controlling stop, continue, or branch behavior.",
|
|
"title": "Fail Policy"
|
|
},
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Persistent database identifier of the supplied record.",
|
|
"title": "Id"
|
|
},
|
|
"inputs": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Named input bindings consumed by this workflow action.",
|
|
"title": "Inputs"
|
|
},
|
|
"join_policy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow fan-in policy controlling when downstream execution may continue.",
|
|
"title": "Join Policy"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"outputs": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Named output mappings produced by this workflow action.",
|
|
"title": "Outputs"
|
|
},
|
|
"position": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/ActionPosition"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow editor coordinates for one action node."
|
|
},
|
|
"retry": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/ActionRetry"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow retry-policy definition for this action."
|
|
},
|
|
"timeout": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Per-request site timeout in seconds.",
|
|
"title": "Timeout"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media or storage item type required by the selected operation.",
|
|
"title": "Type"
|
|
}
|
|
},
|
|
"title": "Action",
|
|
"type": "object"
|
|
},
|
|
"ActionFlow-Input": {
|
|
"description": "One directed connection between workflow action nodes.",
|
|
"properties": {
|
|
"animated": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": true,
|
|
"description": "Whether the workflow connection is rendered as animated in the editor.",
|
|
"title": "Animated"
|
|
},
|
|
"branch_policy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow branch policy controlling selected downstream paths.",
|
|
"title": "Branch Policy"
|
|
},
|
|
"condition": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow branch or flow condition expression evaluated at runtime.",
|
|
"title": "Condition"
|
|
},
|
|
"data": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Serialized workflow action configuration or runtime payload.",
|
|
"title": "Data"
|
|
},
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Persistent database identifier of the supplied record.",
|
|
"title": "Id"
|
|
},
|
|
"join_policy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow fan-in policy controlling when downstream execution may continue.",
|
|
"title": "Join Policy"
|
|
},
|
|
"source": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact metadata or recommendation source selected by the operation.",
|
|
"title": "Source"
|
|
},
|
|
"target": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact target identifier selected by the operation.",
|
|
"title": "Target"
|
|
}
|
|
},
|
|
"title": "ActionFlow",
|
|
"type": "object"
|
|
},
|
|
"ActionPosition": {
|
|
"description": "Editor coordinates for one workflow action node.",
|
|
"properties": {
|
|
"x": {
|
|
"default": 0,
|
|
"description": "Horizontal workflow editor coordinate.",
|
|
"title": "X",
|
|
"type": "number"
|
|
},
|
|
"y": {
|
|
"default": 0,
|
|
"description": "Vertical workflow editor coordinate.",
|
|
"title": "Y",
|
|
"type": "number"
|
|
}
|
|
},
|
|
"title": "ActionPosition",
|
|
"type": "object"
|
|
},
|
|
"ActionRetry": {
|
|
"description": "Retry limits and timing for one workflow action.",
|
|
"properties": {
|
|
"backoff": {
|
|
"default": 1,
|
|
"description": "Retry backoff multiplier applied after each failed workflow action attempt.",
|
|
"minimum": 1.0,
|
|
"title": "Backoff",
|
|
"type": "number"
|
|
},
|
|
"interval": {
|
|
"default": 0,
|
|
"description": "Retry delay in seconds before the next workflow action attempt.",
|
|
"minimum": 0.0,
|
|
"title": "Interval",
|
|
"type": "number"
|
|
},
|
|
"max_attempts": {
|
|
"default": 1,
|
|
"description": "Maximum number of attempts allowed by the workflow retry policy.",
|
|
"minimum": 1.0,
|
|
"title": "Max Attempts",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "ActionRetry",
|
|
"type": "object"
|
|
},
|
|
"AgentCommandRunRequest": {
|
|
"description": "Slash-command execution request.",
|
|
"properties": {
|
|
"command": {
|
|
"description": "Complete slash command, including the leading slash and all arguments.",
|
|
"title": "Command",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"command"
|
|
],
|
|
"title": "AgentCommandRunRequest",
|
|
"type": "object"
|
|
},
|
|
"BatchTransferHistoryRedoRequest": {
|
|
"description": "Explicit transfer-history IDs for AI-assisted batch reorganization.",
|
|
"properties": {
|
|
"history_ids": {
|
|
"description": "Explicit persistent transfer-history IDs included in one batch redo request.",
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"title": "History Ids",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "BatchTransferHistoryRedoRequest",
|
|
"type": "object"
|
|
},
|
|
"Body_add_api_v1_download_add_post": {
|
|
"description": "MoviePilot download submission request.",
|
|
"properties": {
|
|
"allow_unrecognized": {
|
|
"default": false,
|
|
"description": "Allow a download when MoviePilot cannot resolve a canonical media identity.",
|
|
"title": "Allow Unrecognized",
|
|
"type": "boolean"
|
|
},
|
|
"downloader": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Configured downloader instance name.",
|
|
"title": "Downloader"
|
|
},
|
|
"media_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"enum": [
|
|
"recording",
|
|
"album"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
},
|
|
"save_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Configured downloader-side save path for the download or subscription.",
|
|
"title": "Save Path"
|
|
},
|
|
"torrent_in": {
|
|
"$ref": "#/$defs/TorrentInfo",
|
|
"description": "Complete torrent candidate returned by search.results or search.torrents."
|
|
}
|
|
},
|
|
"required": [
|
|
"torrent_in"
|
|
],
|
|
"title": "Body_add_api_v1_download_add_post",
|
|
"type": "object"
|
|
},
|
|
"Body_recommend_search_results_api_v1_search_recommend_post": {
|
|
"description": "Torrent search results and recommendation controls supplied to the configured model.",
|
|
"properties": {
|
|
"check_only": {
|
|
"default": false,
|
|
"description": "Validate or preview the recommendation without applying search-result filtering.",
|
|
"title": "Check Only",
|
|
"type": "boolean"
|
|
},
|
|
"filtered_indices": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Zero-based search-result indices selected by the recommendation model.",
|
|
"title": "Filtered Indices"
|
|
},
|
|
"force": {
|
|
"default": false,
|
|
"description": "Force a marketplace refresh or plugin installation when true.",
|
|
"title": "Force",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"title": "Body_recommend_search_results_api_v1_search_recommend_post",
|
|
"type": "object"
|
|
},
|
|
"CategoryConfig": {
|
|
"description": "Complete automatic media-category strategy configuration.",
|
|
"properties": {
|
|
"movie": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/CategoryRule"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": {},
|
|
"description": "Automatic movie-category rules evaluated in order.",
|
|
"title": "Movie"
|
|
},
|
|
"tv": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/CategoryRule"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": {},
|
|
"description": "Automatic TV-category rules evaluated in order.",
|
|
"title": "Tv"
|
|
}
|
|
},
|
|
"title": "CategoryConfig",
|
|
"type": "object"
|
|
},
|
|
"CategoryRule": {
|
|
"additionalProperties": true,
|
|
"description": "One ordered automatic media-category matching rule.",
|
|
"properties": {
|
|
"genre_ids": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Genre identifiers accepted by the automatic category rule.",
|
|
"title": "Genre Ids"
|
|
},
|
|
"origin_country": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Production-country code matched by an automatic category rule.",
|
|
"title": "Origin Country"
|
|
},
|
|
"original_language": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Original-language code matched by an automatic category rule.",
|
|
"title": "Original Language"
|
|
},
|
|
"production_countries": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Production-country codes matched by an automatic category rule.",
|
|
"title": "Production Countries"
|
|
},
|
|
"release_year": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Release year matched by an automatic category rule.",
|
|
"title": "Release Year"
|
|
}
|
|
},
|
|
"title": "CategoryRule",
|
|
"type": "object"
|
|
},
|
|
"CustomFilterRuleCreateRequest": {
|
|
"description": "Custom filter-rule creation request.",
|
|
"properties": {
|
|
"exclude": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Regular expression or filter expression that rejects matching releases.",
|
|
"title": "Exclude"
|
|
},
|
|
"include": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Regular expression or filter expression that a release must match.",
|
|
"title": "Include"
|
|
},
|
|
"name": {
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"publish_time": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Release-age filter expression for a custom filter rule.",
|
|
"title": "Publish Time"
|
|
},
|
|
"rule_id": {
|
|
"description": "Stable custom filter-rule ID.",
|
|
"title": "Rule Id",
|
|
"type": "string"
|
|
},
|
|
"seeders": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Minimum seeder expression for a filter rule, or the torrent's seeder count.",
|
|
"title": "Seeders"
|
|
},
|
|
"size_range": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Accepted torrent size range expression for a custom filter rule.",
|
|
"title": "Size Range"
|
|
}
|
|
},
|
|
"required": [
|
|
"rule_id",
|
|
"name"
|
|
],
|
|
"title": "CustomFilterRuleCreateRequest",
|
|
"type": "object"
|
|
},
|
|
"CustomFilterRuleUpdateRequest": {
|
|
"description": "Custom filter-rule update request.",
|
|
"properties": {
|
|
"exclude": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Regular expression or filter expression that rejects matching releases.",
|
|
"title": "Exclude"
|
|
},
|
|
"include": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Regular expression or filter expression that a release must match.",
|
|
"title": "Include"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"new_rule_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Replacement stable ID for the existing custom filter rule.",
|
|
"title": "New Rule Id"
|
|
},
|
|
"publish_time": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Release-age filter expression for a custom filter rule.",
|
|
"title": "Publish Time"
|
|
},
|
|
"seeders": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Minimum seeder expression for a filter rule, or the torrent's seeder count.",
|
|
"title": "Seeders"
|
|
},
|
|
"size_range": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Accepted torrent size range expression for a custom filter rule.",
|
|
"title": "Size Range"
|
|
}
|
|
},
|
|
"title": "CustomFilterRuleUpdateRequest",
|
|
"type": "object"
|
|
},
|
|
"CustomIdentifiersUpdateRequest": {
|
|
"description": "Complete custom recognition-identifier replacement request.",
|
|
"properties": {
|
|
"identifiers": {
|
|
"description": "Complete ordered list of custom recognition identifier rules.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "Identifiers",
|
|
"type": "array"
|
|
}
|
|
},
|
|
"title": "CustomIdentifiersUpdateRequest",
|
|
"type": "object"
|
|
},
|
|
"DownloadHistory-Input": {
|
|
"description": "One MoviePilot download-history record.",
|
|
"properties": {
|
|
"channel": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Message channel that originally submitted the download.",
|
|
"title": "Channel"
|
|
},
|
|
"date": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Record creation or completion timestamp used by the history item.",
|
|
"title": "Date"
|
|
},
|
|
"download_hash": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Provider-native torrent hash associated with the record.",
|
|
"title": "Download Hash"
|
|
},
|
|
"episode_group": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "TMDB episode-group identifier used for alternate episode ordering.",
|
|
"title": "Episode Group"
|
|
},
|
|
"episodes": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Episode-number expression recorded in history, such as E01-E03.",
|
|
"title": "Episodes"
|
|
},
|
|
"id": {
|
|
"description": "Persistent database identifier of the supplied record.",
|
|
"title": "Id",
|
|
"type": "integer"
|
|
},
|
|
"image": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Image URL stored with the history record.",
|
|
"title": "Image"
|
|
},
|
|
"media_category": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot library category assigned to the media.",
|
|
"title": "Media Category"
|
|
},
|
|
"media_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
},
|
|
"note": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Structured auxiliary metadata stored with the record."
|
|
},
|
|
"path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Storage or history path represented by this record.",
|
|
"title": "Path"
|
|
},
|
|
"poster": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Poster image URL stored with the media or subscription.",
|
|
"title": "Poster"
|
|
},
|
|
"seasons": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Season-number expression recorded in history.",
|
|
"title": "Seasons"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Media, torrent, subscription, or history title used by the operation.",
|
|
"title": "Title"
|
|
},
|
|
"torrent_description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Torrent release description recorded in download history.",
|
|
"title": "Torrent Description"
|
|
},
|
|
"torrent_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Torrent release name recorded in download history.",
|
|
"title": "Torrent Name"
|
|
},
|
|
"torrent_site": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source site name recorded in download history.",
|
|
"title": "Torrent Site"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media or storage item type required by the selected operation.",
|
|
"title": "Type"
|
|
},
|
|
"userid": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Message-channel user ID recorded with download history.",
|
|
"title": "Userid"
|
|
},
|
|
"username": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot or site username required by the selected operation.",
|
|
"title": "Username"
|
|
},
|
|
"year": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Release or premiere year used to disambiguate the media title.",
|
|
"title": "Year"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
],
|
|
"title": "DownloadHistory",
|
|
"type": "object"
|
|
},
|
|
"EpisodeFormatRecommendItem": {
|
|
"description": "File samples used to infer an episode-number extraction template.",
|
|
"properties": {
|
|
"fileitem": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/FileItem-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "One complete source storage item returned by storage.list."
|
|
},
|
|
"fileitems": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/$defs/FileItem-Input"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Additional source storage items included in the same manual transfer.",
|
|
"title": "Fileitems"
|
|
}
|
|
},
|
|
"title": "EpisodeFormatRecommendItem",
|
|
"type": "object"
|
|
},
|
|
"FileItem-Input": {
|
|
"description": "One file or directory returned by a configured storage provider.",
|
|
"properties": {
|
|
"basename": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Base filename without its parent path.",
|
|
"title": "Basename"
|
|
},
|
|
"children": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/$defs/FileItem-Input"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Child storage items nested below this item.",
|
|
"title": "Children"
|
|
},
|
|
"drive_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Provider-native storage drive identifier.",
|
|
"title": "Drive Id"
|
|
},
|
|
"extension": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Filename extension, including or excluding the leading dot as returned by storage.",
|
|
"title": "Extension"
|
|
},
|
|
"fileid": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Provider-native storage item identifier.",
|
|
"title": "Fileid"
|
|
},
|
|
"modify_time": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Storage item modification timestamp.",
|
|
"title": "Modify Time"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"parent_fileid": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Provider-native identifier of the parent storage directory.",
|
|
"title": "Parent Fileid"
|
|
},
|
|
"path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": "/",
|
|
"description": "Storage or history path represented by this record.",
|
|
"title": "Path"
|
|
},
|
|
"pickcode": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "115 storage pickcode associated with the item.",
|
|
"title": "Pickcode"
|
|
},
|
|
"size": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "File or torrent size in bytes.",
|
|
"title": "Size"
|
|
},
|
|
"storage": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": "local",
|
|
"description": "Configured storage name or storage type used by the operation.",
|
|
"title": "Storage"
|
|
},
|
|
"thumbnail": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Thumbnail URL returned by the storage provider.",
|
|
"title": "Thumbnail"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media or storage item type required by the selected operation.",
|
|
"title": "Type"
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Site, storage, or torrent URL represented by this field.",
|
|
"title": "Url"
|
|
}
|
|
},
|
|
"title": "FileItem",
|
|
"type": "object"
|
|
},
|
|
"FilterRuleGroupCreateRequest": {
|
|
"description": "Filter-rule group creation request.",
|
|
"properties": {
|
|
"category": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media category or filter-group category, depending on the operation.",
|
|
"title": "Category"
|
|
},
|
|
"media_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media type used to filter recommendations or rule groups.",
|
|
"title": "Media Type"
|
|
},
|
|
"name": {
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"rule_string": {
|
|
"description": "Ordered filter-rule expression stored in the group.",
|
|
"title": "Rule String",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"rule_string"
|
|
],
|
|
"title": "FilterRuleGroupCreateRequest",
|
|
"type": "object"
|
|
},
|
|
"FilterRuleGroupUpdateRequest": {
|
|
"description": "Filter-rule group update request.",
|
|
"properties": {
|
|
"category": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media category or filter-group category, depending on the operation.",
|
|
"title": "Category"
|
|
},
|
|
"media_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media type used to filter recommendations or rule groups.",
|
|
"title": "Media Type"
|
|
},
|
|
"new_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Replacement name for the existing filter-rule group.",
|
|
"title": "New Name"
|
|
},
|
|
"rule_string": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Ordered filter-rule expression stored in the group.",
|
|
"title": "Rule String"
|
|
}
|
|
},
|
|
"title": "FilterRuleGroupUpdateRequest",
|
|
"type": "object"
|
|
},
|
|
"JsonData-Input": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"items": {
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Arbitrary JSON-compatible auxiliary data."
|
|
},
|
|
"ManageRequest": {
|
|
"description": "Configured storage target, provider-defined action, and action parameters.",
|
|
"properties": {
|
|
"action": {
|
|
"description": "Exact provider or workflow action identifier required by the selected operation.",
|
|
"title": "Action",
|
|
"type": "string"
|
|
},
|
|
"params": {
|
|
"additionalProperties": true,
|
|
"description": "Provider-defined JSON parameters for the selected authentication or storage action.",
|
|
"title": "Params",
|
|
"type": "object"
|
|
},
|
|
"target": {
|
|
"description": "Exact target identifier selected by the operation.",
|
|
"title": "Target",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"target",
|
|
"action"
|
|
],
|
|
"title": "ManageRequest",
|
|
"type": "object"
|
|
},
|
|
"ManualTransferItem": {
|
|
"description": "Manual file-transfer and organization request.",
|
|
"properties": {
|
|
"episode_detail": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Episode mapping details used by manual transfer.",
|
|
"title": "Episode Detail"
|
|
},
|
|
"episode_format": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Episode-number formatting rule used by manual transfer.",
|
|
"title": "Episode Format"
|
|
},
|
|
"episode_group": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "TMDB episode-group identifier used for alternate episode ordering.",
|
|
"title": "Episode Group"
|
|
},
|
|
"episode_offset": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Integer offset added to detected episode numbers.",
|
|
"title": "Episode Offset"
|
|
},
|
|
"episode_part": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Episode part number used when one episode is split across files.",
|
|
"title": "Episode Part"
|
|
},
|
|
"fileitem": {
|
|
"$ref": "#/$defs/FileItem-Input",
|
|
"description": "One complete source storage item returned by storage.list."
|
|
},
|
|
"fileitems": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/$defs/FileItem-Input"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Additional source storage items included in the same manual transfer.",
|
|
"title": "Fileitems"
|
|
},
|
|
"from_history": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"description": "Treat the transfer input as originating from an existing history record.",
|
|
"title": "From History"
|
|
},
|
|
"library_category_folder": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Create or use a category-level folder in the target library.",
|
|
"title": "Library Category Folder"
|
|
},
|
|
"library_type_folder": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Create or use a media-type folder in the target library.",
|
|
"title": "Library Type Folder"
|
|
},
|
|
"logid": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "One download-history or transfer-log identifier used by manual transfer.",
|
|
"title": "Logid"
|
|
},
|
|
"logids": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Multiple download-history or transfer-log identifiers included in manual transfer.",
|
|
"title": "Logids"
|
|
},
|
|
"media_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"min_filesize": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Minimum source file size accepted by manual transfer, in bytes.",
|
|
"title": "Min Filesize"
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"enum": [
|
|
"recording",
|
|
"album"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
},
|
|
"preview": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"description": "Validate and preview manual-transfer output without committing file changes.",
|
|
"title": "Preview"
|
|
},
|
|
"reorganize": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"description": "Allow manual transfer to organize an item that was already processed.",
|
|
"title": "Reorganize"
|
|
},
|
|
"scrape": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"description": "Generate metadata and images after manual transfer.",
|
|
"title": "Scrape"
|
|
},
|
|
"season": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Season number used by the media, search, subscription, or transfer operation.",
|
|
"title": "Season"
|
|
},
|
|
"target_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Destination path used by manual transfer.",
|
|
"title": "Target Path"
|
|
},
|
|
"target_storage": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Configured storage name receiving the manual transfer.",
|
|
"title": "Target Storage"
|
|
},
|
|
"transfer_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Manual-transfer mode, such as move, copy, link, or softlink.",
|
|
"title": "Transfer Type"
|
|
},
|
|
"type_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Explicit media type name used when source IDs alone are ambiguous.",
|
|
"title": "Type Name"
|
|
}
|
|
},
|
|
"title": "ManualTransferItem",
|
|
"type": "object"
|
|
},
|
|
"MediaSource": {
|
|
"description": "Canonical metadata source identifier paired with a source-native media ID.",
|
|
"examples": [
|
|
"themoviedb",
|
|
"douban",
|
|
"bangumi",
|
|
"anilist",
|
|
"imdb",
|
|
"tvdb",
|
|
"musicbrainz",
|
|
"theaudiodb",
|
|
"doubanmusic",
|
|
"bilibili",
|
|
"mangguodiscover",
|
|
"migu",
|
|
"tencentvideodiscover",
|
|
"iqiyidiscover"
|
|
],
|
|
"pattern": "^[a-z][a-z0-9._-]{0,63}$",
|
|
"title": "MediaSource",
|
|
"type": "string"
|
|
},
|
|
"MediaType": {
|
|
"description": "MoviePilot media type.",
|
|
"enum": [
|
|
"电影",
|
|
"电视剧",
|
|
"音乐",
|
|
"系列",
|
|
"未知"
|
|
],
|
|
"title": "MediaType",
|
|
"type": "string"
|
|
},
|
|
"MusicRecognizeRequest": {
|
|
"description": "Exact source-native recording or album identity to resolve into canonical music metadata.",
|
|
"properties": {
|
|
"media_id": {
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id",
|
|
"type": "string"
|
|
},
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"enum": [
|
|
"recording",
|
|
"album"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_source",
|
|
"media_id"
|
|
],
|
|
"title": "MusicRecognizeRequest",
|
|
"type": "object"
|
|
},
|
|
"PluginCloneRequest": {
|
|
"description": "Plugin clone identifier and optional display-name request.",
|
|
"properties": {
|
|
"description": {
|
|
"default": "",
|
|
"description": "Human-readable media, torrent, or subscription description.",
|
|
"title": "Description",
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Icon name or URL used by a workflow, network target, plugin, or category.",
|
|
"title": "Icon"
|
|
},
|
|
"name": {
|
|
"default": "",
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name",
|
|
"type": "string"
|
|
},
|
|
"suffix": {
|
|
"description": "File suffix or extension matched by an automatic category rule.",
|
|
"maxLength": 20,
|
|
"minLength": 1,
|
|
"pattern": "^[A-Za-z0-9]+$",
|
|
"title": "Suffix",
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Plugin release or schema version selected by the operation.",
|
|
"title": "Version"
|
|
}
|
|
},
|
|
"required": [
|
|
"suffix"
|
|
],
|
|
"title": "PluginCloneRequest",
|
|
"type": "object"
|
|
},
|
|
"PluginFolderConfigData": {
|
|
"description": "One plugin folder's ordered members and optional presentation settings.",
|
|
"properties": {
|
|
"background": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional folder background color or style.",
|
|
"title": "Background"
|
|
},
|
|
"color": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional folder foreground color.",
|
|
"title": "Color"
|
|
},
|
|
"gradient": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional folder gradient definition.",
|
|
"title": "Gradient"
|
|
},
|
|
"icon": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional folder icon name.",
|
|
"title": "Icon"
|
|
},
|
|
"order": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Folder display-order value.",
|
|
"title": "Order"
|
|
},
|
|
"plugins": {
|
|
"description": "Ordered installed plugin IDs assigned to this folder.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "Plugins",
|
|
"type": "array"
|
|
},
|
|
"showIcon": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Whether the frontend should display the folder icon.",
|
|
"title": "Showicon"
|
|
}
|
|
},
|
|
"title": "PluginFolderConfigData",
|
|
"type": "object"
|
|
},
|
|
"PluginFoldersData": {
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"$ref": "#/$defs/PluginFolderConfigData"
|
|
}
|
|
]
|
|
},
|
|
"description": "Complete mapping from plugin folder names to ordered plugin IDs or display configuration.",
|
|
"title": "PluginFoldersData",
|
|
"type": "object"
|
|
},
|
|
"PluginMarketSyncRequest": {
|
|
"description": "Approved Wiki source request for plugin-market synchronization.",
|
|
"properties": {
|
|
"wiki_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": "https://raw.githubusercontent.com/jxxghp/MoviePilot-Wiki/main/plugin.md",
|
|
"description": "Approved MoviePilot Wiki URL used as the plugin-market synchronization source.",
|
|
"title": "Wiki Url"
|
|
}
|
|
},
|
|
"title": "PluginMarketSyncRequest",
|
|
"type": "object"
|
|
},
|
|
"PluginRatingRequest": {
|
|
"description": "Current user's numeric plugin-rating submission.",
|
|
"properties": {
|
|
"rating": {
|
|
"description": "Numeric plugin rating accepted by the endpoint's declared bounds.",
|
|
"maximum": 5.0,
|
|
"minimum": 0.1,
|
|
"multipleOf": 0.1,
|
|
"title": "Rating",
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"rating"
|
|
],
|
|
"title": "PluginRatingRequest",
|
|
"type": "object"
|
|
},
|
|
"PluginSourceChangeRequest": {
|
|
"description": "Explicit online-source change request guarded by the current identity revision.",
|
|
"properties": {
|
|
"expected_revision": {
|
|
"description": "Exact current plugin source-identity revision returned by plugin.source.options.",
|
|
"minimum": 1.0,
|
|
"title": "Expected Revision",
|
|
"type": "integer"
|
|
},
|
|
"release_version": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact plugin release version to install when one is required.",
|
|
"title": "Release Version"
|
|
},
|
|
"repo_url": {
|
|
"description": "Approved plugin repository URL used to resolve the installation source.",
|
|
"minLength": 1,
|
|
"title": "Repo Url",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"repo_url",
|
|
"expected_revision"
|
|
],
|
|
"title": "PluginSourceChangeRequest",
|
|
"type": "object"
|
|
},
|
|
"PluginSourceInstallRequest": {
|
|
"description": "Explicit online-source installation request for an unbound plugin.",
|
|
"properties": {
|
|
"force": {
|
|
"default": false,
|
|
"description": "Force a marketplace refresh or plugin installation when true.",
|
|
"title": "Force",
|
|
"type": "boolean"
|
|
},
|
|
"release_version": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact plugin release version to install when one is required.",
|
|
"title": "Release Version"
|
|
},
|
|
"repo_url": {
|
|
"description": "Approved plugin repository URL used to resolve the installation source.",
|
|
"minLength": 1,
|
|
"title": "Repo Url",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"repo_url"
|
|
],
|
|
"title": "PluginSourceInstallRequest",
|
|
"type": "object"
|
|
},
|
|
"Site-Input": {
|
|
"description": "Complete site configuration and runtime state.",
|
|
"properties": {
|
|
"apikey": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Site API key used by sites that support API-key authentication.",
|
|
"title": "Apikey"
|
|
},
|
|
"cookie": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Site authentication cookie. Treat this value as a secret.",
|
|
"title": "Cookie"
|
|
},
|
|
"domain": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Site hostname or domain used for matching and requests.",
|
|
"title": "Domain"
|
|
},
|
|
"downloader": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Configured downloader instance name.",
|
|
"title": "Downloader"
|
|
},
|
|
"filter": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Named filter rule or rule expression applied to this site or subscription.",
|
|
"title": "Filter"
|
|
},
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Persistent database identifier of the supplied record.",
|
|
"title": "Id"
|
|
},
|
|
"is_active": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": true,
|
|
"description": "Whether the configured site is enabled.",
|
|
"title": "Is Active"
|
|
},
|
|
"limit_count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Maximum number of site requests allowed in one rate-limit interval.",
|
|
"title": "Limit Count"
|
|
},
|
|
"limit_interval": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Number of requests in the site's rate-limit window.",
|
|
"title": "Limit Interval"
|
|
},
|
|
"limit_seconds": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Site rate-limit window length in seconds.",
|
|
"title": "Limit Seconds"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"note": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Structured auxiliary metadata stored with the record."
|
|
},
|
|
"pri": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Site search priority; lower or higher ordering follows the existing site API convention.",
|
|
"title": "Pri"
|
|
},
|
|
"proxy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Whether the site uses MoviePilot's configured proxy.",
|
|
"title": "Proxy"
|
|
},
|
|
"public": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Whether the site is treated as a public indexer.",
|
|
"title": "Public"
|
|
},
|
|
"render": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Whether site requests require browser rendering.",
|
|
"title": "Render"
|
|
},
|
|
"rss": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Site RSS feed URL.",
|
|
"title": "Rss"
|
|
},
|
|
"timeout": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 15,
|
|
"description": "Per-request site timeout in seconds.",
|
|
"title": "Timeout"
|
|
},
|
|
"token": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Site authentication token. Treat this value as a secret.",
|
|
"title": "Token"
|
|
},
|
|
"ua": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Site User-Agent string used for authenticated requests.",
|
|
"title": "Ua"
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Site, storage, or torrent URL represented by this field.",
|
|
"title": "Url"
|
|
}
|
|
},
|
|
"title": "Site",
|
|
"type": "object"
|
|
},
|
|
"SiteAuth": {
|
|
"description": "Supported site-account authentication provider and its exact parameter values.",
|
|
"properties": {
|
|
"params": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Provider-defined JSON parameters for the selected authentication or storage action.",
|
|
"title": "Params"
|
|
},
|
|
"site": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source site identifier associated with the torrent result.",
|
|
"title": "Site"
|
|
}
|
|
},
|
|
"title": "SiteAuth",
|
|
"type": "object"
|
|
},
|
|
"SiteCookieUpdate": {
|
|
"description": "Site login request used to refresh the stored cookie and User-Agent.",
|
|
"properties": {
|
|
"code": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Two-factor verification code or site-specific authentication secret.",
|
|
"title": "Code"
|
|
},
|
|
"password": {
|
|
"description": "Site login password. Treat this value as a secret.",
|
|
"title": "Password",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"description": "MoviePilot or site username required by the selected operation.",
|
|
"title": "Username",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"username",
|
|
"password"
|
|
],
|
|
"title": "SiteCookieUpdate",
|
|
"type": "object"
|
|
},
|
|
"SitePriorityUpdate": {
|
|
"description": "One configured site ID and its replacement search priority.",
|
|
"properties": {
|
|
"id": {
|
|
"description": "Persistent site ID returned by site.list.",
|
|
"title": "Id",
|
|
"type": "integer"
|
|
},
|
|
"pri": {
|
|
"description": "Replacement site search priority value.",
|
|
"title": "Pri",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"pri"
|
|
],
|
|
"title": "SitePriorityUpdate",
|
|
"type": "object"
|
|
},
|
|
"Subscribe": {
|
|
"description": "Movie, TV, or music subscription input model.",
|
|
"properties": {
|
|
"audio_format": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Requested or recorded audio container or codec, such as FLAC or MP3.",
|
|
"title": "Audio Format"
|
|
},
|
|
"audio_quality": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Subscription audio-quality rule, such as hires, lossless, or lossy.",
|
|
"title": "Audio Quality"
|
|
},
|
|
"backdrop": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Backdrop image URL stored with the media or subscription.",
|
|
"title": "Backdrop"
|
|
},
|
|
"best_version": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Enable normal best-version upgrading when set to 1.",
|
|
"title": "Best Version"
|
|
},
|
|
"best_version_full": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Enable full best-version upgrading when set to 1.",
|
|
"title": "Best Version Full"
|
|
},
|
|
"completed_episode": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Highest episode number already completed for the subscription.",
|
|
"title": "Completed Episode"
|
|
},
|
|
"current_audio_format": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Audio format of the best version currently held.",
|
|
"title": "Current Audio Format"
|
|
},
|
|
"current_bit_depth": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Bit depth of the best version currently held.",
|
|
"title": "Current Bit Depth"
|
|
},
|
|
"current_bitrate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Bitrate of the best version currently held.",
|
|
"title": "Current Bitrate"
|
|
},
|
|
"current_priority": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Calculated priority of the best version currently held.",
|
|
"title": "Current Priority"
|
|
},
|
|
"current_sample_rate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Sample rate of the best version currently held.",
|
|
"title": "Current Sample Rate"
|
|
},
|
|
"custom_words": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Custom recognition or rename words applied to this media workflow.",
|
|
"title": "Custom Words"
|
|
},
|
|
"date": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Record creation or completion timestamp used by the history item.",
|
|
"title": "Date"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable media, torrent, or subscription description.",
|
|
"title": "Description"
|
|
},
|
|
"downloader": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Configured downloader instance name.",
|
|
"title": "Downloader"
|
|
},
|
|
"effect": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Video or release-effect filter expression used by the subscription.",
|
|
"title": "Effect"
|
|
},
|
|
"episode_group": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "TMDB episode-group identifier used for alternate episode ordering.",
|
|
"title": "Episode Group"
|
|
},
|
|
"episode_priority": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"type": "integer"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Per-episode best-version priority state.",
|
|
"title": "Episode Priority"
|
|
},
|
|
"exclude": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Regular expression or filter expression that rejects matching releases.",
|
|
"title": "Exclude"
|
|
},
|
|
"execution_status": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/SubscriptionExecutionStatus"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Current subscription execution status returned with the subscription snapshot."
|
|
},
|
|
"filter": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Named filter rule or rule expression applied to this site or subscription.",
|
|
"title": "Filter"
|
|
},
|
|
"filter_groups": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Ordered filter-rule group names applied to the subscription.",
|
|
"title": "Filter Groups"
|
|
},
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Persistent database identifier of the supplied record.",
|
|
"title": "Id"
|
|
},
|
|
"include": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Regular expression or filter expression that a release must match.",
|
|
"title": "Include"
|
|
},
|
|
"keyword": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Case-insensitive substring used to discover settings or filter storage entries.",
|
|
"title": "Keyword"
|
|
},
|
|
"lack_episode": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Number of episodes still missing from the subscription.",
|
|
"title": "Lack Episode"
|
|
},
|
|
"last_update": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Timestamp of the subscription's most recent update.",
|
|
"title": "Last Update"
|
|
},
|
|
"media_category": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot library category assigned to the media.",
|
|
"title": "Media Category"
|
|
},
|
|
"media_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"min_bit_depth": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Minimum acceptable audio bit depth in bits.",
|
|
"title": "Min Bit Depth"
|
|
},
|
|
"min_bitrate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Minimum acceptable audio bitrate in bits per second.",
|
|
"title": "Min Bitrate"
|
|
},
|
|
"min_sample_rate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Minimum acceptable audio sample rate in hertz.",
|
|
"title": "Min Sample Rate"
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"note": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Structured auxiliary metadata stored with the record.",
|
|
"title": "Note"
|
|
},
|
|
"poster": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Poster image URL stored with the media or subscription.",
|
|
"title": "Poster"
|
|
},
|
|
"quality": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Video or release quality filter expression.",
|
|
"title": "Quality"
|
|
},
|
|
"resolution": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Video resolution filter expression, such as 1080p or 2160p.",
|
|
"title": "Resolution"
|
|
},
|
|
"save_path": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Configured downloader-side save path for the download or subscription.",
|
|
"title": "Save Path"
|
|
},
|
|
"search_imdbid": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Use IMDb identity during subscription search when set to 1.",
|
|
"title": "Search Imdbid"
|
|
},
|
|
"season": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Season number used by the media, search, subscription, or transfer operation.",
|
|
"title": "Season"
|
|
},
|
|
"sites": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "integer"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact site IDs included in the search or subscription scope.",
|
|
"title": "Sites"
|
|
},
|
|
"start_episode": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "First episode number requested by the subscription.",
|
|
"title": "Start Episode"
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Current site, subscription, marketplace, or transfer state filter.",
|
|
"title": "State"
|
|
},
|
|
"total_episode": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Expected total episode count for the subscription.",
|
|
"title": "Total Episode"
|
|
},
|
|
"total_tracks": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Expected or recorded track count for a music item.",
|
|
"title": "Total Tracks"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media or storage item type required by the selected operation.",
|
|
"title": "Type"
|
|
},
|
|
"username": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot or site username required by the selected operation.",
|
|
"title": "Username"
|
|
},
|
|
"vote": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0.0,
|
|
"description": "Media vote average stored with the subscription.",
|
|
"title": "Vote"
|
|
},
|
|
"year": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Release or premiere year used to disambiguate the media title.",
|
|
"title": "Year"
|
|
}
|
|
},
|
|
"title": "Subscribe",
|
|
"type": "object"
|
|
},
|
|
"SubscribeShare": {
|
|
"description": "Shared subscription definition or publication metadata.",
|
|
"properties": {
|
|
"audio_format": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Requested or recorded audio container or codec, such as FLAC or MP3.",
|
|
"title": "Audio Format"
|
|
},
|
|
"audio_quality": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Subscription audio-quality rule, such as hires, lossless, or lossy.",
|
|
"title": "Audio Quality"
|
|
},
|
|
"backdrop": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Backdrop image URL stored with the media or subscription.",
|
|
"title": "Backdrop"
|
|
},
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"title": "Count"
|
|
},
|
|
"custom_words": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Custom recognition or rename words applied to this media workflow.",
|
|
"title": "Custom Words"
|
|
},
|
|
"date": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Record creation or completion timestamp used by the history item.",
|
|
"title": "Date"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable media, torrent, or subscription description.",
|
|
"title": "Description"
|
|
},
|
|
"effect": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Video or release-effect filter expression used by the subscription.",
|
|
"title": "Effect"
|
|
},
|
|
"episode_group": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "TMDB episode-group identifier used for alternate episode ordering.",
|
|
"title": "Episode Group"
|
|
},
|
|
"exclude": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Regular expression or filter expression that rejects matching releases.",
|
|
"title": "Exclude"
|
|
},
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Persistent database identifier of the supplied record.",
|
|
"title": "Id"
|
|
},
|
|
"include": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Regular expression or filter expression that a release must match.",
|
|
"title": "Include"
|
|
},
|
|
"keyword": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Case-insensitive substring used to discover settings or filter storage entries.",
|
|
"title": "Keyword"
|
|
},
|
|
"media_category": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot library category assigned to the media.",
|
|
"title": "Media Category"
|
|
},
|
|
"media_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"min_bit_depth": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Minimum acceptable audio bit depth in bits.",
|
|
"title": "Min Bit Depth"
|
|
},
|
|
"min_bitrate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Minimum acceptable audio bitrate in bits per second.",
|
|
"title": "Min Bitrate"
|
|
},
|
|
"min_sample_rate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Minimum acceptable audio sample rate in hertz.",
|
|
"title": "Min Sample Rate"
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"poster": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Poster image URL stored with the media or subscription.",
|
|
"title": "Poster"
|
|
},
|
|
"quality": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Video or release quality filter expression.",
|
|
"title": "Quality"
|
|
},
|
|
"resolution": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Video resolution filter expression, such as 1080p or 2160p.",
|
|
"title": "Resolution"
|
|
},
|
|
"season": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Season number used by the media, search, subscription, or transfer operation.",
|
|
"title": "Season"
|
|
},
|
|
"share_comment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional explanatory comment published with a shared item.",
|
|
"title": "Share Comment"
|
|
},
|
|
"share_title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Public title used when publishing a subscription or workflow.",
|
|
"title": "Share Title"
|
|
},
|
|
"share_uid": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact MoviePilot Server sharing-user ID to follow or unfollow.",
|
|
"title": "Share Uid"
|
|
},
|
|
"share_user": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Public contributor name used when publishing a subscription or workflow.",
|
|
"title": "Share User"
|
|
},
|
|
"subscribe_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Persistent subscription ID returned by subscription.list.",
|
|
"title": "Subscribe Id"
|
|
},
|
|
"total_episode": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Expected total episode count for the subscription.",
|
|
"title": "Total Episode"
|
|
},
|
|
"total_tracks": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Expected or recorded track count for a music item.",
|
|
"title": "Total Tracks"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media or storage item type required by the selected operation.",
|
|
"title": "Type"
|
|
},
|
|
"vote": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0.0,
|
|
"description": "Media vote average stored with the subscription.",
|
|
"title": "Vote"
|
|
},
|
|
"year": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Release or premiere year used to disambiguate the media title.",
|
|
"title": "Year"
|
|
}
|
|
},
|
|
"title": "SubscribeShare",
|
|
"type": "object"
|
|
},
|
|
"SubscriptionExecutionStatus": {
|
|
"description": "Subscription refresh execution status and progress summary.",
|
|
"properties": {
|
|
"batch_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Stable subscription search batch identifier.",
|
|
"title": "Batch Id"
|
|
},
|
|
"can_cancel": {
|
|
"default": false,
|
|
"description": "Whether the current subscription execution can be cancelled.",
|
|
"title": "Can Cancel",
|
|
"type": "boolean"
|
|
},
|
|
"can_retry": {
|
|
"default": false,
|
|
"description": "Whether the current subscription execution can be retried.",
|
|
"title": "Can Retry",
|
|
"type": "boolean"
|
|
},
|
|
"current_site_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Configured site ID currently handling the subscription execution.",
|
|
"title": "Current Site Id"
|
|
},
|
|
"error": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable workflow, provider, or execution error message.",
|
|
"title": "Error"
|
|
},
|
|
"phase": {
|
|
"description": "Current phase of a subscription execution.",
|
|
"title": "Phase",
|
|
"type": "string"
|
|
},
|
|
"requires_reconciliation": {
|
|
"default": false,
|
|
"description": "Whether the execution requires reconciliation before it can continue.",
|
|
"title": "Requires Reconciliation",
|
|
"type": "boolean"
|
|
},
|
|
"source": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact metadata or recommendation source selected by the operation.",
|
|
"title": "Source"
|
|
},
|
|
"state": {
|
|
"description": "Current site, subscription, marketplace, or transfer state filter.",
|
|
"title": "State",
|
|
"type": "string"
|
|
},
|
|
"task_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Stable durable transfer task ID returned by transfer.manual_reviews.",
|
|
"title": "Task Id"
|
|
},
|
|
"updated_at": {
|
|
"description": "Timestamp when the subscription execution status was last updated.",
|
|
"title": "Updated At",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"state",
|
|
"phase",
|
|
"updated_at"
|
|
],
|
|
"title": "SubscriptionExecutionStatus",
|
|
"type": "object"
|
|
},
|
|
"SystemSettingsUpdateRequest": {
|
|
"description": "One registered system-setting update request.",
|
|
"properties": {
|
|
"match_field": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Object field used to match a list item. Downloaders, MediaServers, Notifications, Directories, and Storages default to name; NotificationSwitchs defaults to type. Supply it for other object lists.",
|
|
"title": "Match Field"
|
|
},
|
|
"match_value": {
|
|
"description": "Value compared against match_field. If omitted, use value[match_field]; scalar lists use value directly.",
|
|
"title": "Match Value"
|
|
},
|
|
"operation": {
|
|
"default": "replace",
|
|
"description": "replace overwrites the complete value; merge_dict shallow-merges an object; upsert_list_item inserts or replaces one matched list item; remove_list_item removes one matched list item.",
|
|
"enum": [
|
|
"replace",
|
|
"merge_dict",
|
|
"upsert_list_item",
|
|
"remove_list_item"
|
|
],
|
|
"title": "Operation",
|
|
"type": "string"
|
|
},
|
|
"remove_keys": {
|
|
"description": "Object keys to remove after merge_dict applies the supplied value.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "Remove Keys",
|
|
"type": "array"
|
|
},
|
|
"setting_key": {
|
|
"description": "Exact setting key. Accepts a Settings field name, a SystemConfigKey value or enum name, or an alias that resolves to one unique setting. Call config.system.get with group or keyword first when the key is unknown.",
|
|
"title": "Setting Key",
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"description": "New value or list item. For replace, send the complete value. For merge_dict, send the object fragment to merge. For upsert_list_item or remove_list_item, send one object or scalar item.",
|
|
"title": "Value"
|
|
}
|
|
},
|
|
"required": [
|
|
"setting_key"
|
|
],
|
|
"title": "SystemSettingsUpdateRequest",
|
|
"type": "object"
|
|
},
|
|
"SystemUpdateRequest": {
|
|
"description": "Selected MoviePilot application or site-resource update target.",
|
|
"properties": {
|
|
"target": {
|
|
"default": "application",
|
|
"description": "Exact target identifier selected by the operation.",
|
|
"enum": [
|
|
"application",
|
|
"resources"
|
|
],
|
|
"title": "Target",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"title": "SystemUpdateRequest",
|
|
"type": "object"
|
|
},
|
|
"TorrentInfo": {
|
|
"description": "One torrent candidate returned by MoviePilot search.",
|
|
"properties": {
|
|
"category": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media category or filter-group category, depending on the operation.",
|
|
"title": "Category"
|
|
},
|
|
"date_elapsed": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable age of the torrent publication date.",
|
|
"title": "Date Elapsed"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable media, torrent, or subscription description.",
|
|
"title": "Description"
|
|
},
|
|
"downloadvolumefactor": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Torrent download-volume multiplier reported by the site.",
|
|
"title": "Downloadvolumefactor"
|
|
},
|
|
"enclosure": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Torrent download URL or enclosure supplied by the indexer result.",
|
|
"title": "Enclosure"
|
|
},
|
|
"freedate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Torrent freeleech expiration timestamp reported by the site.",
|
|
"title": "Freedate"
|
|
},
|
|
"freedate_diff": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Seconds remaining until the torrent freeleech period ends.",
|
|
"title": "Freedate Diff"
|
|
},
|
|
"grabs": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Number of completed downloads reported for the torrent.",
|
|
"title": "Grabs"
|
|
},
|
|
"hit_and_run": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"description": "Whether the torrent is subject to hit-and-run requirements.",
|
|
"title": "Hit And Run"
|
|
},
|
|
"labels": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Torrent labels supplied by the site result.",
|
|
"title": "Labels"
|
|
},
|
|
"media_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"page_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Public details page for the torrent result.",
|
|
"title": "Page Url"
|
|
},
|
|
"peers": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Number of downloading peers reported for the torrent.",
|
|
"title": "Peers"
|
|
},
|
|
"pri_order": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Indexer priority order assigned to the torrent result.",
|
|
"title": "Pri Order"
|
|
},
|
|
"pubdate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Torrent publication timestamp.",
|
|
"title": "Pubdate"
|
|
},
|
|
"seeders": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Minimum seeder expression for a filter rule, or the torrent's seeder count.",
|
|
"title": "Seeders"
|
|
},
|
|
"site": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source site identifier associated with the torrent result.",
|
|
"title": "Site"
|
|
},
|
|
"site_cookie": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Site cookie bundled with the torrent result. Treat this value as a secret.",
|
|
"title": "Site Cookie"
|
|
},
|
|
"site_downloader": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Downloader instance selected by the source site.",
|
|
"title": "Site Downloader"
|
|
},
|
|
"site_name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable source site name.",
|
|
"title": "Site Name"
|
|
},
|
|
"site_order": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Source site's configured search order.",
|
|
"title": "Site Order"
|
|
},
|
|
"site_proxy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"description": "Whether the torrent's source site uses the configured proxy.",
|
|
"title": "Site Proxy"
|
|
},
|
|
"site_ua": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "User-Agent associated with the source site.",
|
|
"title": "Site Ua"
|
|
},
|
|
"size": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0.0,
|
|
"description": "File or torrent size in bytes.",
|
|
"title": "Size"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Media, torrent, subscription, or history title used by the operation.",
|
|
"title": "Title"
|
|
},
|
|
"uploadvolumefactor": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Torrent upload-volume multiplier reported by the site.",
|
|
"title": "Uploadvolumefactor"
|
|
},
|
|
"volume_factor": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Combined upload/download volume-factor label shown for the torrent.",
|
|
"title": "Volume Factor"
|
|
}
|
|
},
|
|
"title": "TorrentInfo",
|
|
"type": "object"
|
|
},
|
|
"TransferHistory-Input": {
|
|
"description": "One MoviePilot file-transfer history record.",
|
|
"properties": {
|
|
"audio_format": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Requested or recorded audio container or codec, such as FLAC or MP3.",
|
|
"title": "Audio Format"
|
|
},
|
|
"audio_lossless": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Whether the recorded audio result is lossless.",
|
|
"title": "Audio Lossless"
|
|
},
|
|
"bit_depth": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Recorded audio bit depth in bits.",
|
|
"title": "Bit Depth"
|
|
},
|
|
"bitrate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Recorded audio bitrate in bits per second.",
|
|
"title": "Bitrate"
|
|
},
|
|
"category": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media category or filter-group category, depending on the operation.",
|
|
"title": "Category"
|
|
},
|
|
"date": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Record creation or completion timestamp used by the history item.",
|
|
"title": "Date"
|
|
},
|
|
"dest": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Organized destination path recorded in transfer history.",
|
|
"title": "Dest"
|
|
},
|
|
"dest_fileitem": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Serialized destination storage item recorded by the transfer."
|
|
},
|
|
"dest_storage": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Configured storage name containing the organized destination.",
|
|
"title": "Dest Storage"
|
|
},
|
|
"download_hash": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Provider-native torrent hash associated with the record.",
|
|
"title": "Download Hash"
|
|
},
|
|
"episode_group": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "TMDB episode-group identifier used for alternate episode ordering.",
|
|
"title": "Episode Group"
|
|
},
|
|
"episodes": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Episode-number expression recorded in history, such as E01-E03.",
|
|
"title": "Episodes"
|
|
},
|
|
"errmsg": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Error message recorded for a failed transfer.",
|
|
"title": "Errmsg"
|
|
},
|
|
"files": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Serialized list of files recorded by the history item."
|
|
},
|
|
"id": {
|
|
"description": "Persistent database identifier of the supplied record.",
|
|
"title": "Id",
|
|
"type": "integer"
|
|
},
|
|
"image": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Image URL stored with the history record.",
|
|
"title": "Image"
|
|
},
|
|
"media_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"mode": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Operation mode; music.explore accepts chart or fresh, while transfer history records move, copy, link, or softlink.",
|
|
"title": "Mode"
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
},
|
|
"sample_rate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Recorded audio sample rate in hertz.",
|
|
"title": "Sample Rate"
|
|
},
|
|
"seasons": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Season-number expression recorded in history.",
|
|
"title": "Seasons"
|
|
},
|
|
"src": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source path recorded in transfer history.",
|
|
"title": "Src"
|
|
},
|
|
"src_fileitem": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Serialized source storage item recorded by the transfer."
|
|
},
|
|
"src_storage": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Configured storage name containing the transfer source.",
|
|
"title": "Src Storage"
|
|
},
|
|
"status": {
|
|
"default": true,
|
|
"description": "Transfer success status used to filter history or describe a record.",
|
|
"title": "Status",
|
|
"type": "boolean"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Media, torrent, subscription, or history title used by the operation.",
|
|
"title": "Title"
|
|
},
|
|
"total_tracks": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Expected or recorded track count for a music item.",
|
|
"title": "Total Tracks"
|
|
},
|
|
"transfer_task_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Stable durable transfer-task ID associated with the history record.",
|
|
"title": "Transfer Task Id"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media or storage item type required by the selected operation.",
|
|
"title": "Type"
|
|
},
|
|
"year": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Release or premiere year used to disambiguate the media title.",
|
|
"title": "Year"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
],
|
|
"title": "TransferHistory",
|
|
"type": "object"
|
|
},
|
|
"TransferManualReviewRequest": {
|
|
"additionalProperties": false,
|
|
"description": "Authorized decision and optional result for one durable transfer operation.",
|
|
"properties": {
|
|
"decision": {
|
|
"description": "Manual-review decision selected from the endpoint's declared enum.",
|
|
"enum": [
|
|
"not_applied",
|
|
"applied"
|
|
],
|
|
"title": "Decision",
|
|
"type": "string"
|
|
},
|
|
"operation_id": {
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"minLength": 1,
|
|
"title": "Operation Id",
|
|
"type": "string"
|
|
},
|
|
"reason": {
|
|
"description": "Human-readable justification recorded with a manual-review decision.",
|
|
"maxLength": 2000,
|
|
"minLength": 1,
|
|
"title": "Reason",
|
|
"type": "string"
|
|
},
|
|
"result_payload": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Structured external-operation result recorded with manual review.",
|
|
"title": "Result Payload"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"decision",
|
|
"reason"
|
|
],
|
|
"title": "TransferManualReviewRequest",
|
|
"type": "object"
|
|
},
|
|
"Workflow-Input": {
|
|
"description": "Complete workflow definition accepted by create and update operations.",
|
|
"properties": {
|
|
"actions": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/$defs/Action-Input"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Ordered workflow action definitions executed by this workflow or flow.",
|
|
"title": "Actions"
|
|
},
|
|
"add_time": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Timestamp when the workflow definition was created.",
|
|
"title": "Add Time"
|
|
},
|
|
"current_action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Identifier of the workflow action currently selected or executing.",
|
|
"title": "Current Action"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable media, torrent, or subscription description.",
|
|
"title": "Description"
|
|
},
|
|
"event_conditions": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": {
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Additional workflow event-filter conditions.",
|
|
"title": "Event Conditions"
|
|
},
|
|
"event_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact event type returned by workflow.event_types.",
|
|
"title": "Event Type"
|
|
},
|
|
"execution_config": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/WorkflowExecutionConfig"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow runtime limits, concurrency, and failure-policy configuration."
|
|
},
|
|
"execution_state": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/WorkflowExecutionState-Input"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Persisted resumable workflow execution state."
|
|
},
|
|
"flows": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"$ref": "#/$defs/ActionFlow-Input"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow connection definitions linking action nodes.",
|
|
"title": "Flows"
|
|
},
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Persistent database identifier of the supplied record.",
|
|
"title": "Id"
|
|
},
|
|
"last_time": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Timestamp of the workflow's most recent execution.",
|
|
"title": "Last Time"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"result": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Persisted workflow action result value.",
|
|
"title": "Result"
|
|
},
|
|
"run_count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Number of times the workflow has been executed.",
|
|
"title": "Run Count"
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Current site, subscription, marketplace, or transfer state filter.",
|
|
"title": "State"
|
|
},
|
|
"timer": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow timer or cron expression used for scheduled execution.",
|
|
"title": "Timer"
|
|
},
|
|
"trigger_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": "timer",
|
|
"description": "Workflow trigger filter: timer, event, manual, or all.",
|
|
"title": "Trigger Type"
|
|
}
|
|
},
|
|
"title": "Workflow",
|
|
"type": "object"
|
|
},
|
|
"WorkflowExecutionConfig": {
|
|
"description": "Workflow concurrency, join, branch, and failure policies.",
|
|
"properties": {
|
|
"max_workers": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1.0,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Maximum concurrent workflow actions allowed by the execution configuration.",
|
|
"title": "Max Workers"
|
|
}
|
|
},
|
|
"title": "WorkflowExecutionConfig",
|
|
"type": "object"
|
|
},
|
|
"WorkflowExecutionState-Input": {
|
|
"description": "Persisted resumable workflow execution state.",
|
|
"properties": {
|
|
"errors": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "Workflow execution errors keyed or ordered by action identity.",
|
|
"title": "Errors",
|
|
"type": "object"
|
|
},
|
|
"nodes": {
|
|
"additionalProperties": {
|
|
"$ref": "#/$defs/WorkflowNodeState"
|
|
},
|
|
"description": "Persisted workflow node runtime states keyed by action identity.",
|
|
"title": "Nodes",
|
|
"type": "object"
|
|
},
|
|
"outputs": {
|
|
"additionalProperties": {
|
|
"$ref": "#/$defs/JsonData-Input"
|
|
},
|
|
"description": "Named output mappings produced by this workflow action.",
|
|
"title": "Outputs",
|
|
"type": "object"
|
|
},
|
|
"runtime": {
|
|
"$ref": "#/$defs/WorkflowRuntimeState",
|
|
"description": "Persisted workflow runtime metadata used for safe resume."
|
|
},
|
|
"version": {
|
|
"default": 1,
|
|
"description": "Plugin release or schema version selected by the operation.",
|
|
"title": "Version",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "WorkflowExecutionState",
|
|
"type": "object"
|
|
},
|
|
"WorkflowNodeState": {
|
|
"description": "Persisted runtime state for one workflow action node.",
|
|
"properties": {
|
|
"attempt": {
|
|
"default": 0,
|
|
"description": "Current execution-attempt number for this workflow node.",
|
|
"title": "Attempt",
|
|
"type": "integer"
|
|
},
|
|
"finished_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Timestamp when the workflow node or execution finished.",
|
|
"title": "Finished At"
|
|
},
|
|
"message": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable workflow runtime or provider result message.",
|
|
"title": "Message"
|
|
},
|
|
"started_at": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Timestamp when the workflow node or execution started.",
|
|
"title": "Started At"
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Current site, subscription, marketplace, or transfer state filter.",
|
|
"title": "State"
|
|
}
|
|
},
|
|
"title": "WorkflowNodeState",
|
|
"type": "object"
|
|
},
|
|
"WorkflowRuntimeState": {
|
|
"description": "Complete persisted workflow runtime and progress state.",
|
|
"properties": {
|
|
"attempts": {
|
|
"additionalProperties": {
|
|
"type": "integer"
|
|
},
|
|
"description": "Attempt counters keyed by workflow node or operation identity.",
|
|
"title": "Attempts",
|
|
"type": "object"
|
|
},
|
|
"errors": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "Workflow execution errors keyed or ordered by action identity.",
|
|
"title": "Errors",
|
|
"type": "object"
|
|
},
|
|
"finished_actions": {
|
|
"default": 0,
|
|
"description": "Workflow action IDs already completed in the persisted execution state.",
|
|
"title": "Finished Actions",
|
|
"type": "integer"
|
|
},
|
|
"node_states": {
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
},
|
|
"description": "Persisted runtime states keyed by workflow node identity.",
|
|
"title": "Node States",
|
|
"type": "object"
|
|
},
|
|
"progress": {
|
|
"default": 0,
|
|
"description": "Current numeric or structured workflow execution progress.",
|
|
"title": "Progress",
|
|
"type": "integer"
|
|
},
|
|
"running_tasks": {
|
|
"default": 0,
|
|
"description": "Workflow task IDs currently executing.",
|
|
"title": "Running Tasks",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"title": "WorkflowRuntimeState",
|
|
"type": "object"
|
|
},
|
|
"WorkflowShare": {
|
|
"description": "Shared workflow definition or publication metadata.",
|
|
"properties": {
|
|
"actions": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Ordered workflow action definitions executed by this workflow or flow.",
|
|
"title": "Actions"
|
|
},
|
|
"context": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Persisted workflow execution context available to later actions.",
|
|
"title": "Context"
|
|
},
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"title": "Count"
|
|
},
|
|
"date": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Record creation or completion timestamp used by the history item.",
|
|
"title": "Date"
|
|
},
|
|
"description": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable media, torrent, or subscription description.",
|
|
"title": "Description"
|
|
},
|
|
"event_conditions": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Additional workflow event-filter conditions.",
|
|
"title": "Event Conditions"
|
|
},
|
|
"event_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact event type returned by workflow.event_types.",
|
|
"title": "Event Type"
|
|
},
|
|
"flows": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow connection definitions linking action nodes.",
|
|
"title": "Flows"
|
|
},
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Persistent database identifier of the supplied record.",
|
|
"title": "Id"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"share_comment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional explanatory comment published with a shared item.",
|
|
"title": "Share Comment"
|
|
},
|
|
"share_title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Public title used when publishing a subscription or workflow.",
|
|
"title": "Share Title"
|
|
},
|
|
"share_uid": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact MoviePilot Server sharing-user ID to follow or unfollow.",
|
|
"title": "Share Uid"
|
|
},
|
|
"share_user": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Public contributor name used when publishing a subscription or workflow.",
|
|
"title": "Share User"
|
|
},
|
|
"timer": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow timer or cron expression used for scheduled execution.",
|
|
"title": "Timer"
|
|
},
|
|
"trigger_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Workflow trigger filter: timer, event, manual, or all.",
|
|
"title": "Trigger Type"
|
|
}
|
|
},
|
|
"title": "WorkflowShare",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"description": "Select the oneOf branch matching operation_id and send exactly its documented fields. Collection branches also describe their additive output metadata in x-moviepilot-collection.",
|
|
"oneOf": [
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the complete custom media-recognition identifier list. Method: GET. Path: /api/v1/system/identifiers. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "config.identifiers.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "config.identifiers.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Replace the complete custom media-recognition identifier list. Method: POST. Path: /api/v1/system/identifiers. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/CustomIdentifiersUpdateRequest",
|
|
"description": "Request value for config.identifiers.update. Replace the complete custom media-recognition identifier list. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "config.identifiers.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "config.identifiers.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read one explicitly public system setting by exact key. Method: GET. Path: /api/v1/system/setting/public/{key}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "config.public.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for config.public.get. Read one explicitly public system setting by exact key. Use only the named fields below.",
|
|
"properties": {
|
|
"key": {
|
|
"description": "Optional exact plugin data key used to narrow the returned preview.",
|
|
"title": "Key",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"key"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "config.public.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Discover registered system settings or read one exact setting. Method: GET. Path: /api/v1/system/settings. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "config.system.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for config.system.get. Discover registered system settings or read one exact setting. Use only the named fields below.",
|
|
"properties": {
|
|
"group": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": "all",
|
|
"description": "Discovery group used when setting_key is omitted. Supported groups are all, settings, systemconfig, downloaders, media_servers, notifications, notification_switches, storages, directories, search_sites, subscribe_sites, site_auth, ai_agent, filter_rules, subscribe_defaults, plugins, customization, transfer, scraping, and misc.",
|
|
"title": "Group"
|
|
},
|
|
"include_values": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Return full values. Defaults to true for one exact key and false for discovery results.",
|
|
"title": "Include Values"
|
|
},
|
|
"keyword": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Case-insensitive substring used to discover matching keys, groups, or labels.",
|
|
"title": "Keyword"
|
|
},
|
|
"setting_key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact setting key. Accepts Settings field names such as APP_DOMAIN or LLM_MODEL, SystemConfigKey values or enum names such as Downloaders or MediaServers, and aliases that resolve to one unique setting. Omit it to discover settings.",
|
|
"title": "Setting Key"
|
|
},
|
|
"show_secrets": {
|
|
"default": false,
|
|
"description": "Return unredacted secret values. Defaults to false and remains confirmation-protected.",
|
|
"title": "Show Secrets",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "config.system.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Update one exact registered system setting. Method: POST. Path: /api/v1/system/settings. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/SystemSettingsUpdateRequest",
|
|
"description": "Request value for config.system.update. Update one exact registered system setting. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "config.system.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "config.system.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read current-user feature flags, runtime capabilities, and effective permissions. Method: GET. Path: /api/v1/system/global/user. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "config.user.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "config.user.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the current host CPU utilization percentage. Method: GET. Path: /api/v1/dashboard/cpu. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "dashboard.cpu",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "dashboard.cpu",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read aggregate downloader task counts, speeds, and free-space information. Method: GET. Path: /api/v1/dashboard/downloader. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "dashboard.downloader",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for dashboard.downloader. Read aggregate downloader task counts, speeds, and free-space information. Use only the named fields below.",
|
|
"properties": {
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "dashboard.downloader",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read aggregate movie, TV, episode, and music library counts. Method: GET. Path: /api/v1/dashboard/statistic. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "dashboard.media.statistics",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for dashboard.media.statistics. Read aggregate movie, TV, episode, and music library counts. Use only the named fields below.",
|
|
"properties": {
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "dashboard.media.statistics",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read current MoviePilot process and host memory utilization. Method: GET. Path: /api/v1/dashboard/memory. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "dashboard.memory",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "dashboard.memory",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the current host network receive and transmit counters. Method: GET. Path: /api/v1/dashboard/network. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "dashboard.network",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for dashboard.network. Read the current host network receive and transmit counters. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "dashboard.network",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List host processes visible to the MoviePilot runtime. Method: GET. Path: /api/v1/dashboard/processes. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "dashboard.processes",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for dashboard.processes. List host processes visible to the MoviePilot runtime. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "dashboard.processes",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read local filesystem capacity and free-space information. Method: GET. Path: /api/v1/dashboard/storage. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "dashboard.storage",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "dashboard.storage",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read MoviePilot host, runtime, platform, and uptime summary information. Method: GET. Path: /api/v1/dashboard/system. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "dashboard.system",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "dashboard.system",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read aggregate file-transfer counts grouped by time period. Method: GET. Path: /api/v1/dashboard/transfer. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "dashboard.transfer.statistics",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for dashboard.transfer.statistics. Read aggregate file-transfer counts grouped by time period. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"days": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 7,
|
|
"description": "Recommendation time window in days.",
|
|
"title": "Days"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "dashboard.transfer.statistics",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Create, verify, and atomically publish a managed database backup. Method: POST. Path: /api/v1/system/database/backups. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "database.backups.create",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "database.backups.create",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one exact managed database backup artifact. Method: DELETE. Path: /api/v1/system/database/backups/{name}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "database.backups.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for database.backups.delete. Delete one exact managed database backup artifact. Use only the named fields below.",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "database.backups.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List managed database backup artifacts without exposing host paths. Method: GET. Path: /api/v1/system/database/backups. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "database.backups.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for database.backups.list. List managed database backup artifacts without exposing host paths. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "database.backups.list",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Verify the integrity of one exact managed database backup artifact. Method: POST. Path: /api/v1/system/database/backups/{name}/verify. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "database.backups.verify",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for database.backups.verify. Verify the integrity of one exact managed database backup artifact. Use only the named fields below.",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "database.backups.verify",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Submit one torrent to MoviePilot's normal download workflow. Method: POST. Path: /api/v1/download/add. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/Body_add_api_v1_download_add_post",
|
|
"description": "Request value for download.add. Submit one torrent to MoviePilot's normal download workflow. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "download.add",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "download.add",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List enabled downloader instance names and provider types without credentials. Method: GET. Path: /api/v1/download/clients. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "download.clients",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for download.clients. List enabled downloader instance names and provider types without credentials. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "download.clients",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one MoviePilot download-history record. Method: DELETE. Path: /api/v1/history/download. Effect: destructive_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/DownloadHistory-Input",
|
|
"description": "Request value for download.history.delete. Delete one MoviePilot download-history record. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "download.history.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "download.history.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Page MoviePilot download-history records in reverse chronological order. Method: GET. Path: /api/v1/history/download. Effect: safe_read. Collection response: data remains a list and the endpoint's documented pagination or limit defaults remain in effect. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count-only request, use the smallest valid page and read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "download.history.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for download.history.list. Page MoviePilot download-history records in reverse chronological order. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 30,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "download.history.list",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List configured downloader save-path URIs that may be passed to download.add. Method: GET. Path: /api/v1/download/paths. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "download.paths",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for download.paths. List configured downloader save-path URIs that may be passed to download.add. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "download.paths",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List currently downloading MoviePilot tasks with their canonical media context. Method: GET. Path: /api/v1/download/. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "download.tasks.active",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for download.tasks.active. List currently downloading MoviePilot tasks with their canonical media context. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "download.tasks.active",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List built-in torrent filter rules. Method: GET. Path: /api/v1/rule/builtin. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "filter.builtin",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for filter.builtin. List built-in torrent filter rules. Use only the named fields below.",
|
|
"properties": {
|
|
"rule_ids": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact built-in rule IDs to return. Repeat rule_ids in the query string; omit it to list every built-in rule.",
|
|
"title": "Rule Ids"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "filter.builtin",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List user-defined torrent filter rules. Method: GET. Path: /api/v1/rule/custom. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "filter.custom",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for filter.custom. List user-defined torrent filter rules. Use only the named fields below.",
|
|
"properties": {
|
|
"include_group_refs": {
|
|
"default": true,
|
|
"description": "Include custom rules referenced only through rule groups.",
|
|
"title": "Include Group Refs",
|
|
"type": "boolean"
|
|
},
|
|
"rule_ids": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact custom rule IDs to return. Repeat rule_ids in the query string; omit it to list every custom rule.",
|
|
"title": "Rule Ids"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "filter.custom",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Create one user-defined torrent filter rule. Method: POST. Path: /api/v1/rule/custom. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/CustomFilterRuleCreateRequest",
|
|
"description": "Request value for filter.custom.add. Create one user-defined torrent filter rule. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "filter.custom.add",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "filter.custom.add",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one user-defined torrent filter rule. Method: DELETE. Path: /api/v1/rule/custom/{rule_id}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "filter.custom.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for filter.custom.delete. Delete one user-defined torrent filter rule. Use only the named fields below.",
|
|
"properties": {
|
|
"rule_id": {
|
|
"description": "Stable custom filter-rule ID.",
|
|
"title": "Rule Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"rule_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "filter.custom.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Update one user-defined torrent filter rule. Method: PUT. Path: /api/v1/rule/custom/{rule_id}. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/CustomFilterRuleUpdateRequest",
|
|
"description": "Request value for filter.custom.update. Update one user-defined torrent filter rule. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "filter.custom.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for filter.custom.update. Update one user-defined torrent filter rule. Use only the named fields below.",
|
|
"properties": {
|
|
"rule_id": {
|
|
"description": "Stable custom filter-rule ID.",
|
|
"title": "Rule Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"rule_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "filter.custom.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Create one named filter-rule group. Method: POST. Path: /api/v1/rule/groups. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/FilterRuleGroupCreateRequest",
|
|
"description": "Request value for filter.group.add. Create one named filter-rule group. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "filter.group.add",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "filter.group.add",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one named filter-rule group. Method: DELETE. Path: /api/v1/rule/groups/{name}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "filter.group.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for filter.group.delete. Delete one named filter-rule group. Use only the named fields below.",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "filter.group.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Update or rename one named filter-rule group. Method: PUT. Path: /api/v1/rule/groups/{name}. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/FilterRuleGroupUpdateRequest",
|
|
"description": "Request value for filter.group.update. Update or rename one named filter-rule group. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "filter.group.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for filter.group.update. Update or rename one named filter-rule group. Use only the named fields below.",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "filter.group.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List named filter-rule groups. Method: GET. Path: /api/v1/rule/groups. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "filter.groups",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for filter.groups. List named filter-rule groups. Use only the named fields below.",
|
|
"properties": {
|
|
"group_names": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact rule-group names to return. Repeat group_names in the query string; omit it to list every group.",
|
|
"title": "Group Names"
|
|
},
|
|
"include_usage": {
|
|
"default": true,
|
|
"description": "Include the subscriptions or defaults that reference each rule group.",
|
|
"title": "Include Usage",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "filter.groups",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Test one title and optional subtitle against an exact named filter-rule group. Method: GET. Path: /api/v1/system/ruletest. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "filter.test",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for filter.test. Test one title and optional subtitle against an exact named filter-rule group. Use only the named fields below.",
|
|
"properties": {
|
|
"rulegroup_name": {
|
|
"description": "Exact filter-rule group name returned by filter.groups.",
|
|
"title": "Rulegroup Name",
|
|
"type": "string"
|
|
},
|
|
"subtitle": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional subtitle text used together with title during media recognition.",
|
|
"title": "Subtitle"
|
|
},
|
|
"title": {
|
|
"description": "Media, torrent, subscription, or history title used by the operation.",
|
|
"title": "Title",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"title",
|
|
"rulegroup_name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query"
|
|
],
|
|
"title": "filter.test",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Check configured media servers for one canonical media identity. Method: GET. Path: /api/v1/mediaserver/exists. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "library.exists",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for library.exists. Check configured media servers for one canonical media identity. Use only the named fields below.",
|
|
"properties": {
|
|
"media_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id.",
|
|
"title": "Media Source"
|
|
},
|
|
"mtype": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media type or subscription-history category required by the operation.",
|
|
"title": "Mtype"
|
|
},
|
|
"season": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Season number used by the media, search, subscription, or transfer operation.",
|
|
"title": "Season"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Media, torrent, subscription, or history title used by the operation.",
|
|
"title": "Title"
|
|
},
|
|
"year": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Release or premiere year used to disambiguate the media title.",
|
|
"title": "Year"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "library.exists",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List recently added items from one configured media-server instance for the current user. Method: GET. Path: /api/v1/mediaserver/latest. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "library.latest",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for library.latest. List recently added items from one configured media-server instance for the current user. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 20,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"title": "Count"
|
|
},
|
|
"server": {
|
|
"description": "Exact configured media-server instance name returned by the media-server instance list.",
|
|
"title": "Server",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"server"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query"
|
|
],
|
|
"title": "library.latest",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the resolved automatic media-category mapping. Method: GET. Path: /api/v1/media/category. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.categories",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "media.categories",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the complete automatic media-category strategy configuration. Method: GET. Path: /api/v1/media/category/config. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.category.config.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "media.category.config.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Replace the complete automatic media-category strategy configuration. Method: POST. Path: /api/v1/media/category/config. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/CategoryConfig",
|
|
"description": "Request value for media.category.config.update. Replace the complete automatic media-category strategy configuration. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "media.category.config.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "media.category.config.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read canonical media details from one selected metadata source. Method: GET. Path: /api/v1/media/{media_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.detail",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for media.detail. Read canonical media details from one selected metadata source. Use only the named fields below.",
|
|
"properties": {
|
|
"media_id": {
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.detail. Read canonical media details from one selected metadata source. Use only the named fields below.",
|
|
"properties": {
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"type_name": {
|
|
"description": "Explicit media type name used when source IDs alone are ambiguous.",
|
|
"title": "Type Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_source",
|
|
"type_name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"query"
|
|
],
|
|
"title": "media.detail",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List seasons defined by one exact TMDB episode-group identity. Method: GET. Path: /api/v1/media/group/seasons/{episode_group}. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.episode_group.seasons",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for media.episode_group.seasons. List seasons defined by one exact TMDB episode-group identity. Use only the named fields below.",
|
|
"properties": {
|
|
"episode_group": {
|
|
"description": "TMDB episode-group identifier used for alternate episode ordering.",
|
|
"title": "Episode Group",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"episode_group"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.episode_group.seasons. List seasons defined by one exact TMDB episode-group identity. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "media.episode_group.seasons",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List alternate TMDB episode groups available for one TV media identity. Method: GET. Path: /api/v1/media/groups/{tmdbid}. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.episode_groups",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for media.episode_groups. List alternate TMDB episode groups available for one TV media identity. Use only the named fields below.",
|
|
"properties": {
|
|
"tmdbid": {
|
|
"description": "TMDB media ID returned by media search or detail.",
|
|
"title": "Tmdbid",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"tmdbid"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.episode_groups. List alternate TMDB episode groups available for one TV media identity. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "media.episode_groups",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read TMDB episode release information for one season. Method: GET. Path: /api/v1/tmdb/{tmdbid}/{season}. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.episode_schedule",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for media.episode_schedule. Read TMDB episode release information for one season. Use only the named fields below.",
|
|
"properties": {
|
|
"season": {
|
|
"description": "Season number used by the media, search, subscription, or transfer operation.",
|
|
"title": "Season",
|
|
"type": "integer"
|
|
},
|
|
"tmdbid": {
|
|
"description": "TMDB media ID returned by media search or detail.",
|
|
"title": "Tmdbid",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"tmdbid",
|
|
"season"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.episode_schedule. Read TMDB episode release information for one season. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"episode_group": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "TMDB episode-group identifier used for alternate episode ordering.",
|
|
"title": "Episode Group"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "media.episode_schedule",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read one person's credits from the selected metadata source. Method: GET. Path: /api/v1/{source}/person/credits/{person_id}. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.person.credits",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for media.person.credits. Read one person's credits from the selected metadata source. Use only the named fields below.",
|
|
"properties": {
|
|
"person_id": {
|
|
"description": "Source-native person ID.",
|
|
"type": "integer"
|
|
},
|
|
"source": {
|
|
"description": "Metadata source that owns the person ID.",
|
|
"enum": [
|
|
"douban",
|
|
"tmdb",
|
|
"bangumi",
|
|
"anilist"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"source",
|
|
"person_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.person.credits. Read one person's credits from the selected metadata source. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"default": 20,
|
|
"description": "Page size used by Bangumi and AniList; other sources ignore it.",
|
|
"maximum": 50,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
"page": {
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "media.person.credits",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Search people across selected metadata sources. Method: GET. Path: /api/v1/media/search. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.person.search",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.person.search. Search people across selected metadata sources. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"default": 8,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"title": "Count",
|
|
"type": "integer"
|
|
},
|
|
"media_source": {
|
|
"default": [],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id.",
|
|
"items": {
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
"title": "Media Source",
|
|
"type": "array"
|
|
},
|
|
"page": {
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"title": "Page",
|
|
"type": "integer"
|
|
},
|
|
"title": {
|
|
"description": "Media, torrent, subscription, or history title used by the operation.",
|
|
"title": "Title",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"const": "person",
|
|
"description": "Literal person, selecting person search instead of media search.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"title",
|
|
"type"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query"
|
|
],
|
|
"title": "media.person.search",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Recognize media identity from a title, subtitle, or custom rule context. Method: GET. Path: /api/v1/media/recognize. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.recognize",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.recognize. Recognize media identity from a title, subtitle, or custom rule context. Use only the named fields below.",
|
|
"properties": {
|
|
"custom_words": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Custom recognition or rename words applied to this media workflow.",
|
|
"title": "Custom Words"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id.",
|
|
"title": "Media Source"
|
|
},
|
|
"subtitle": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional subtitle text used together with title during media recognition.",
|
|
"title": "Subtitle"
|
|
},
|
|
"title": {
|
|
"description": "Media, torrent, subscription, or history title used by the operation.",
|
|
"title": "Title",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"title"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query"
|
|
],
|
|
"title": "media.recognize",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Recognize canonical media identity from one exact filename and optional path context. Method: GET. Path: /api/v1/media/recognize_file. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.recognize_file",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.recognize_file. Recognize canonical media identity from one exact filename and optional path context. Use only the named fields below.",
|
|
"properties": {
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id.",
|
|
"title": "Media Source"
|
|
},
|
|
"path": {
|
|
"description": "Storage or history path represented by this record.",
|
|
"title": "Path",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query"
|
|
],
|
|
"title": "media.recognize_file",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Generate or refresh metadata for one storage item. Method: POST. Path: /api/v1/media/scrape/{storage}. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/FileItem-Input",
|
|
"description": "Request value for media.scrape. Generate or refresh metadata for one storage item. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "media.scrape",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for media.scrape. Generate or refresh metadata for one storage item. Use only the named fields below.",
|
|
"properties": {
|
|
"storage": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Configured storage name or storage type used by the operation.",
|
|
"title": "Storage"
|
|
}
|
|
},
|
|
"required": [
|
|
"storage"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.scrape. Generate or refresh metadata for one storage item. Use only the named fields below.",
|
|
"properties": {
|
|
"media_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id.",
|
|
"title": "Media Source"
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
},
|
|
"type_name": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaType"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Explicit media type name used when source IDs alone are ambiguous.",
|
|
"title": "Type Name"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "media.scrape",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Search canonical media across selected metadata sources. Method: GET. Path: /api/v1/media/search. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.search",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.search. Search canonical media across selected metadata sources. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"default": 8,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"title": "Count",
|
|
"type": "integer"
|
|
},
|
|
"media_source": {
|
|
"default": [],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id.",
|
|
"items": {
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
"title": "Media Source",
|
|
"type": "array"
|
|
},
|
|
"page": {
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"title": "Page",
|
|
"type": "integer"
|
|
},
|
|
"title": {
|
|
"description": "Media, torrent, subscription, or history title used by the operation.",
|
|
"title": "Title",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": "media",
|
|
"description": "MoviePilot media or storage item type required by the selected operation.",
|
|
"title": "Type"
|
|
}
|
|
},
|
|
"required": [
|
|
"title"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query"
|
|
],
|
|
"title": "media.search",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List seasons for one exact media identity or a title-and-year fallback. Method: GET. Path: /api/v1/media/seasons. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.seasons",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.seasons. List seasons for one exact media identity or a title-and-year fallback. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"media_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id.",
|
|
"title": "Media Source"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
},
|
|
"season": {
|
|
"description": "Season number used by the media, search, subscription, or transfer operation.",
|
|
"title": "Season",
|
|
"type": "integer"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Media, torrent, subscription, or history title used by the operation.",
|
|
"title": "Title"
|
|
},
|
|
"year": {
|
|
"description": "Release or premiere year used to disambiguate the media title.",
|
|
"title": "Year",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "media.seasons",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List metadata sources currently registered for MoviePilot media operations. Method: GET. Path: /api/v1/media/source. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "media.sources",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for media.sources. List metadata sources currently registered for MoviePilot media operations. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "media.sources",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read one album's details, tracks, releases, and aligned artist names and IDs. Method: GET. Path: /api/v1/music/album/{album_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "music.album.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for music.album.get. Read one album's details, tracks, releases, and aligned artist names and IDs. Use only the named fields below.",
|
|
"properties": {
|
|
"album_id": {
|
|
"description": "Source-native album ID returned by music search, exploration, or artist-album browsing.",
|
|
"title": "Album Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"album_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for music.album.get. Read one album's details, tracks, releases, and aligned artist names and IDs. Use only the named fields below.",
|
|
"properties": {
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "music.album.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Browse albums related to one source-native album identity. Method: GET. Path: /api/v1/music/album/{album_id}/related. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "music.album.related",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for music.album.related. Browse albums related to one source-native album identity. Use only the named fields below.",
|
|
"properties": {
|
|
"album_id": {
|
|
"description": "Source-native album ID returned by music search, exploration, or artist-album browsing.",
|
|
"title": "Album Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"album_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for music.album.related. Browse albums related to one source-native album identity. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"default": 24,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"maximum": 100,
|
|
"minimum": 1,
|
|
"title": "Count",
|
|
"type": "integer"
|
|
},
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "music.album.related",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Browse one artist's albums, singles, EPs, or another exact release-group type. Method: GET. Path: /api/v1/music/artist/{artist_id}/albums. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "music.artist.albums",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for music.artist.albums. Browse one artist's albums, singles, EPs, or another exact release-group type. Use only the named fields below.",
|
|
"properties": {
|
|
"artist_id": {
|
|
"description": "Source-native artist ID returned by music search or an album detail response.",
|
|
"title": "Artist Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"artist_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for music.artist.albums. Browse one artist's albums, singles, EPs, or another exact release-group type. Use only the named fields below.",
|
|
"properties": {
|
|
"album_type": {
|
|
"anyOf": [
|
|
{
|
|
"pattern": "^(album|single|ep|broadcast|other|compilation|soundtrack|live|remix)$",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MusicBrainz release-group type filter: album, single, ep, broadcast, other, compilation, soundtrack, live, or remix.",
|
|
"title": "Album Type"
|
|
},
|
|
"count": {
|
|
"default": 30,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"maximum": 100,
|
|
"minimum": 1,
|
|
"title": "Count",
|
|
"type": "integer"
|
|
},
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"page": {
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"minimum": 1,
|
|
"title": "Page",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "music.artist.albums",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read one artist's canonical details from the selected music metadata source. Method: GET. Path: /api/v1/music/artist/{artist_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "music.artist.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for music.artist.get. Read one artist's canonical details from the selected music metadata source. Use only the named fields below.",
|
|
"properties": {
|
|
"artist_id": {
|
|
"description": "Source-native artist ID returned by music search or an album detail response.",
|
|
"title": "Artist Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"artist_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for music.artist.get. Read one artist's canonical details from the selected music metadata source. Use only the named fields below.",
|
|
"properties": {
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "music.artist.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Browse artists related to one source-native artist identity. Method: GET. Path: /api/v1/music/artist/{artist_id}/related. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "music.artist.related",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for music.artist.related. Browse artists related to one source-native artist identity. Use only the named fields below.",
|
|
"properties": {
|
|
"artist_id": {
|
|
"description": "Source-native artist ID returned by music search or an album detail response.",
|
|
"title": "Artist Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"artist_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for music.artist.related. Browse artists related to one source-native artist identity. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"default": 24,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"maximum": 100,
|
|
"minimum": 1,
|
|
"title": "Count",
|
|
"type": "integer"
|
|
},
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "music.artist.related",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Clear the complete administrator-only MusicBrainz recognition cache. Method: DELETE. Path: /api/v1/music/cache. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "music.cache.clear",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "music.cache.clear",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one administrator-only MusicBrainz recognition-cache entry by exact key. Method: DELETE. Path: /api/v1/music/cache/{cache_key}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "music.cache.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for music.cache.delete. Delete one administrator-only MusicBrainz recognition-cache entry by exact key. Use only the named fields below.",
|
|
"properties": {
|
|
"cache_key": {
|
|
"description": "Exact recognition-cache key returned by music.cache.get.",
|
|
"title": "Cache Key",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"cache_key"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "music.cache.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Inspect the administrator-only MusicBrainz recognition cache and summary counts. Method: GET. Path: /api/v1/music/cache. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "music.cache.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "music.cache.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Browse MusicBrainz charts or fresh releases, or Douban Music tag categories. Method: GET. Path: /api/v1/music/explore. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "music.explore",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for music.explore. Browse MusicBrainz charts or fresh releases, or Douban Music tag categories. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"default": 30,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"maximum": 100,
|
|
"minimum": 1,
|
|
"title": "Count",
|
|
"type": "integer"
|
|
},
|
|
"days": {
|
|
"default": 14,
|
|
"description": "Fresh-release lookback/lookahead window, from 1 through the endpoint maximum.",
|
|
"maximum": 90,
|
|
"minimum": 1,
|
|
"title": "Days",
|
|
"type": "integer"
|
|
},
|
|
"douban_sort": {
|
|
"default": "U",
|
|
"description": "Douban Music order: U comprehensive, S rating, R newest, or O hottest.",
|
|
"pattern": "^(U|S|R|O)$",
|
|
"title": "Douban Sort",
|
|
"type": "string"
|
|
},
|
|
"entity": {
|
|
"default": "recording",
|
|
"description": "Chart entity: recording for tracks or album for release groups. Fresh results are albums.",
|
|
"pattern": "^(recording|album)$",
|
|
"title": "Entity",
|
|
"type": "string"
|
|
},
|
|
"future": {
|
|
"default": true,
|
|
"description": "Include releases after today in fresh mode.",
|
|
"title": "Future",
|
|
"type": "boolean"
|
|
},
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Music exploration source. Use musicbrainz for chart/fresh modes or doubanmusic for tag browsing."
|
|
},
|
|
"min_listen_count": {
|
|
"default": 0,
|
|
"description": "Minimum ListenBrainz listen count in chart mode.",
|
|
"minimum": 0,
|
|
"title": "Min Listen Count",
|
|
"type": "integer"
|
|
},
|
|
"mode": {
|
|
"default": "chart",
|
|
"description": "MusicBrainz mode: chart reads listening charts; fresh reads new album releases.",
|
|
"pattern": "^(chart|fresh)$",
|
|
"title": "Mode",
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"minimum": 1,
|
|
"title": "Page",
|
|
"type": "integer"
|
|
},
|
|
"past": {
|
|
"default": true,
|
|
"description": "Include releases before today in fresh mode.",
|
|
"title": "Past",
|
|
"type": "boolean"
|
|
},
|
|
"range_name": {
|
|
"default": "this_month",
|
|
"description": "ListenBrainz chart range: this_week, this_month, this_year, week, month, or year.",
|
|
"pattern": "^(this_week|this_month|this_year|week|month|quarter|half_yearly|year|all_time)$",
|
|
"title": "Range Name",
|
|
"type": "string"
|
|
},
|
|
"sort": {
|
|
"default": "release_date",
|
|
"description": "Fresh-release order accepted by the current ListenBrainz implementation.",
|
|
"pattern": "^(release_date|artist_credit_name|release_name)$",
|
|
"title": "Sort",
|
|
"type": "string"
|
|
},
|
|
"sort_by": {
|
|
"default": "listen_count.desc",
|
|
"description": "ListenBrainz chart order: listen_count.desc or listen_count.asc.",
|
|
"pattern": "^listen_count\\.(desc|asc)$",
|
|
"title": "Sort By",
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"default": "",
|
|
"description": "Comma-separated Douban Music tags used only when media_source is doubanmusic.",
|
|
"title": "Tags",
|
|
"type": "string"
|
|
},
|
|
"with_cover": {
|
|
"default": false,
|
|
"description": "Keep only results with cover artwork when true.",
|
|
"title": "With Cover",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "music.explore",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Resolve one recording or album from an exact music source and source-native ID. Method: POST. Path: /api/v1/music/recognize. Effect: safe_read.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/MusicRecognizeRequest",
|
|
"description": "Request value for music.recognize. Resolve one recording or album from an exact music source and source-native ID. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "music.recognize",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "music.recognize",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Inspect the runtime capabilities exposed by installed plugins. Method: GET. Path: /api/v1/plugin/runtime/capabilities. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.capabilities",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for plugin.capabilities. Inspect the runtime capabilities exposed by installed plugins. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "plugin.capabilities",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Create a configurable clone of one installed plugin. Method: POST. Path: /api/v1/plugin/clone/{plugin_id}. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/PluginCloneRequest",
|
|
"description": "Request value for plugin.clone. Create a configurable clone of one installed plugin. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "plugin.clone",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.clone. Create a configurable clone of one installed plugin. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "plugin.clone",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read one loaded plugin's configuration form and its defaults merged with saved values. Method: GET. Path: /api/v1/plugin/form/{plugin_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.config.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.config.get. Read one loaded plugin's configuration form and its defaults merged with saved values. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.config.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Replace one installed plugin's complete configuration and apply it immediately. Method: PUT. Path: /api/v1/plugin/{plugin_id}. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"additionalProperties": true,
|
|
"description": "Complete plugin configuration object. First call plugin.config.get, copy its returned model, change only the intended keys, and submit the full resulting object. Omit a key only when it must be removed. A successful update reinitializes the plugin and refreshes commands, jobs, and routes.",
|
|
"minProperties": 1,
|
|
"title": "Conf",
|
|
"type": "object"
|
|
},
|
|
"operation_id": {
|
|
"const": "plugin.config.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.config.update. Replace one installed plugin's complete configuration and apply it immediately. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "plugin.config.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read a bounded preview of one plugin's persisted data. Method: GET. Path: /api/v1/plugin/runtime/{plugin_id}/data. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.data",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.data. Read a bounded preview of one plugin's persisted data. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for plugin.data. Read a bounded preview of one plugin's persisted data. Use only the named fields below.",
|
|
"properties": {
|
|
"key": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional exact plugin data key used to narrow the returned preview.",
|
|
"title": "Key"
|
|
},
|
|
"max_chars": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Maximum number of serialized plugin-data characters to return.",
|
|
"title": "Max Chars"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.data",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Create one named plugin folder. Method: POST. Path: /api/v1/plugin/folders/{folder_name}. Effect: reversible_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.folder.create",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.folder.create. Create one named plugin folder. Use only the named fields below.",
|
|
"properties": {
|
|
"folder_name": {
|
|
"description": "Exact plugin folder name returned by plugin.folders.get.",
|
|
"title": "Folder Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"folder_name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.folder.create",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one named plugin folder without uninstalling its plugins. Method: DELETE. Path: /api/v1/plugin/folders/{folder_name}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.folder.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.folder.delete. Delete one named plugin folder without uninstalling its plugins. Use only the named fields below.",
|
|
"properties": {
|
|
"folder_name": {
|
|
"description": "Exact plugin folder name returned by plugin.folders.get.",
|
|
"title": "Folder Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"folder_name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.folder.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Replace the ordered plugin IDs assigned to one named plugin folder. Method: PUT. Path: /api/v1/plugin/folders/{folder_name}/plugins. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"description": "Request value for plugin.folder.plugins.update. Replace the ordered plugin IDs assigned to one named plugin folder. Use the exact type and fields below.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "Plugin Ids",
|
|
"type": "array"
|
|
},
|
|
"operation_id": {
|
|
"const": "plugin.folder.plugins.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.folder.plugins.update. Replace the ordered plugin IDs assigned to one named plugin folder. Use only the named fields below.",
|
|
"properties": {
|
|
"folder_name": {
|
|
"description": "Exact plugin folder name returned by plugin.folders.get.",
|
|
"title": "Folder Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"folder_name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "plugin.folder.plugins.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the complete administrator plugin-folder grouping configuration. Method: GET. Path: /api/v1/plugin/folders. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.folders.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "plugin.folders.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Replace the complete administrator plugin-folder grouping configuration. Method: POST. Path: /api/v1/plugin/folders. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/PluginFoldersData",
|
|
"description": "Request value for plugin.folders.update. Replace the complete administrator plugin-folder grouping configuration. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "plugin.folders.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "plugin.folders.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read marketplace update notes and history for one plugin. Method: GET. Path: /api/v1/plugin/history/{plugin_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.history",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.history. Read marketplace update notes and history for one plugin. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for plugin.history. Read marketplace update notes and history for one plugin. Use only the named fields below.",
|
|
"properties": {
|
|
"force": {
|
|
"default": true,
|
|
"description": "Force a marketplace refresh or plugin installation when true.",
|
|
"title": "Force",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.history",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Install or update one plugin from an approved source. Method: GET. Path: /api/v1/plugin/install/{plugin_id}. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.install",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.install. Install or update one plugin from an approved source. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for plugin.install. Install or update one plugin from an approved source. Use only the named fields below.",
|
|
"properties": {
|
|
"force": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"description": "Force a marketplace refresh or plugin installation when true.",
|
|
"title": "Force"
|
|
},
|
|
"release_version": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact plugin release version to install when one is required.",
|
|
"title": "Release Version"
|
|
},
|
|
"repo_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": "",
|
|
"description": "Approved plugin repository URL used to resolve the installation source.",
|
|
"title": "Repo Url"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.install",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List installed plugins and their runtime status. Method: GET. Path: /api/v1/plugin/. Effect: safe_read. Collection response: data remains a list and the endpoint's documented pagination or limit defaults remain in effect. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count-only request, use the smallest valid page and read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.installed",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for plugin.installed. List installed plugins and their runtime status. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"force": {
|
|
"default": false,
|
|
"description": "Force a marketplace refresh or plugin installation when true.",
|
|
"title": "Force",
|
|
"type": "boolean"
|
|
},
|
|
"max_results": {
|
|
"default": 50,
|
|
"description": "Maximum number of plugin catalog results to return, from 1 to 200.",
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"title": "Max Results",
|
|
"type": "integer"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
},
|
|
"query": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional case-insensitive keyword matched against plugin ID, name, description, and author.",
|
|
"title": "Query"
|
|
},
|
|
"state": {
|
|
"const": "installed",
|
|
"description": "Literal installed, selecting only installed plugin catalog entries.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"state"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query"
|
|
],
|
|
"title": "plugin.installed",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List plugins available from configured marketplaces. Method: GET. Path: /api/v1/plugin/. Effect: safe_read. Collection response: data remains a list and the endpoint's documented pagination or limit defaults remain in effect. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count-only request, use the smallest valid page and read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.market",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for plugin.market. List plugins available from configured marketplaces. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"force": {
|
|
"default": false,
|
|
"description": "Force a marketplace refresh or plugin installation when true.",
|
|
"title": "Force",
|
|
"type": "boolean"
|
|
},
|
|
"max_results": {
|
|
"default": 50,
|
|
"description": "Maximum number of plugin catalog results to return, from 1 to 200.",
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"title": "Max Results",
|
|
"type": "integer"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
},
|
|
"query": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional case-insensitive keyword matched against plugin ID, name, description, and author.",
|
|
"title": "Query"
|
|
},
|
|
"state": {
|
|
"const": "market",
|
|
"description": "Literal market, selecting only market plugin catalog entries.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"state"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query"
|
|
],
|
|
"title": "plugin.market",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Refresh the configured plugin marketplace repositories from the MoviePilot Wiki. Method: POST. Path: /api/v1/system/setting/PLUGIN_MARKET/sync-wiki. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/PluginMarketSyncRequest"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Request value for plugin.market.sync_wiki. Refresh the configured plugin marketplace repositories from the MoviePilot Wiki. Use the exact type and fields below.",
|
|
"title": "Request"
|
|
},
|
|
"operation_id": {
|
|
"const": "plugin.market.sync_wiki",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "plugin.market.sync_wiki",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the current aggregate rating for one plugin. Method: GET. Path: /api/v1/plugin/rating/{plugin_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.rating",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.rating. Read the current aggregate rating for one plugin. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.rating",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Submit or replace the current user's rating for one plugin. Method: POST. Path: /api/v1/plugin/rating/{plugin_id}. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/PluginRatingRequest",
|
|
"description": "Request value for plugin.rating.submit. Submit or replace the current user's rating for one plugin. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "plugin.rating.submit",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.rating.submit. Submit or replace the current user's rating for one plugin. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "plugin.rating.submit",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read aggregate ratings for a requested plugin set. Method: GET. Path: /api/v1/plugin/rating. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.ratings",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for plugin.ratings. Read aggregate ratings for a requested plugin set. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_ids": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact plugin IDs whose aggregate ratings should be returned.",
|
|
"title": "Plugin Ids"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "plugin.ratings",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List available release versions for one plugin source. Method: GET. Path: /api/v1/plugin/releases/{plugin_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.releases",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.releases. List available release versions for one plugin source. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for plugin.releases. List available release versions for one plugin source. Use only the named fields below.",
|
|
"properties": {
|
|
"force": {
|
|
"default": false,
|
|
"description": "Force a marketplace refresh or plugin installation when true.",
|
|
"title": "Force",
|
|
"type": "boolean"
|
|
},
|
|
"repo_url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": "",
|
|
"description": "Approved plugin repository URL used to resolve the installation source.",
|
|
"title": "Repo Url"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.releases",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Reload one installed plugin into the running process. Method: GET. Path: /api/v1/plugin/reload/{plugin_id}. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.reload",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.reload. Reload one installed plugin into the running process. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.reload",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one plugin's saved configuration and data, then restore its default runtime state. Method: GET. Path: /api/v1/plugin/reset/{plugin_id}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.reset",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.reset. Delete one plugin's saved configuration and data, then restore its default runtime state. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.reset",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read plugin runtime convergence, loading, and failure state. Method: GET. Path: /api/v1/plugin/runtime. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.runtime.status",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "plugin.runtime.status",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Switch an installed plugin to one explicitly selected online source revision. Method: POST. Path: /api/v1/plugin/source/{plugin_id}. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/PluginSourceChangeRequest",
|
|
"description": "Request value for plugin.source.change. Switch an installed plugin to one explicitly selected online source revision. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "plugin.source.change",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.source.change. Switch an installed plugin to one explicitly selected online source revision. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "plugin.source.change",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Install an unbound plugin from one explicitly selected online source. Method: POST. Path: /api/v1/plugin/source/{plugin_id}/install. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/PluginSourceInstallRequest",
|
|
"description": "Request value for plugin.source.install. Install an unbound plugin from one explicitly selected online source. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "plugin.source.install",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.source.install. Install an unbound plugin from one explicitly selected online source. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "plugin.source.install",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Inspect source candidates and the current immutable source identity before installation or source change. Method: GET. Path: /api/v1/plugin/source/{plugin_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.source.options",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.source.options. Inspect source candidates and the current immutable source identity before installation or source change. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.source.options",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read public installation statistics for plugins. Method: GET. Path: /api/v1/plugin/statistic. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.statistics",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "plugin.statistics",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Uninstall one plugin and remove it from the installed set. Method: DELETE. Path: /api/v1/plugin/{plugin_id}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "plugin.uninstall",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for plugin.uninstall. Uninstall one plugin and remove it from the installed set. Use only the named fields below.",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "plugin.uninstall",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read personalized media or music recommendations. Method: GET. Path: /api/v1/recommend/agent. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "recommendation.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for recommendation.list. Read personalized media or music recommendations. Use only the named fields below.",
|
|
"properties": {
|
|
"days": {
|
|
"default": 14,
|
|
"description": "Recommendation time window in days.",
|
|
"title": "Days",
|
|
"type": "integer"
|
|
},
|
|
"fresh_sort": {
|
|
"default": "release_date",
|
|
"description": "Freshness ordering used by the recommendation source.",
|
|
"title": "Fresh Sort",
|
|
"type": "string"
|
|
},
|
|
"future": {
|
|
"default": true,
|
|
"description": "Include future recommendation periods when supported.",
|
|
"title": "Future",
|
|
"type": "boolean"
|
|
},
|
|
"media_type": {
|
|
"default": "all",
|
|
"description": "MoviePilot media type used to filter recommendations or rule groups.",
|
|
"title": "Media Type",
|
|
"type": "string"
|
|
},
|
|
"min_listen_count": {
|
|
"default": 0,
|
|
"description": "Minimum listen count required for a music recommendation.",
|
|
"title": "Min Listen Count",
|
|
"type": "integer"
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
},
|
|
"page": {
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"title": "Page",
|
|
"type": "integer"
|
|
},
|
|
"past": {
|
|
"default": true,
|
|
"description": "Include past recommendation periods when supported.",
|
|
"title": "Past",
|
|
"type": "boolean"
|
|
},
|
|
"range_name": {
|
|
"default": "this_month",
|
|
"description": "Named recommendation time range.",
|
|
"title": "Range Name",
|
|
"type": "string"
|
|
},
|
|
"sort_by": {
|
|
"default": "listen_count.desc",
|
|
"description": "Recommendation field used for ordering results.",
|
|
"title": "Sort By",
|
|
"type": "string"
|
|
},
|
|
"source": {
|
|
"default": "tmdb_trending",
|
|
"description": "Exact metadata or recommendation source selected by the operation.",
|
|
"title": "Source",
|
|
"type": "string"
|
|
},
|
|
"with_cover": {
|
|
"default": false,
|
|
"description": "Require recommendation results to include cover artwork.",
|
|
"title": "With Cover",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "recommendation.list",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List registered scheduler jobs and their current state. Method: GET. Path: /api/v1/dashboard/schedule. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "scheduler.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for scheduler.list. List registered scheduler jobs and their current state. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "scheduler.list",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read current progress for one exact scheduler job. Method: GET. Path: /api/v1/dashboard/schedule/{job_id}/progress. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "scheduler.progress",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for scheduler.progress. Read current progress for one exact scheduler job. Use only the named fields below.",
|
|
"properties": {
|
|
"job_id": {
|
|
"description": "Exact scheduler job ID returned by scheduler.list.",
|
|
"title": "Job Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"job_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "scheduler.progress",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Run one registered scheduler job immediately. Method: GET. Path: /api/v1/system/runscheduler. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "scheduler.run",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for scheduler.run. Run one registered scheduler job immediately. Use only the named fields below.",
|
|
"properties": {
|
|
"jobid": {
|
|
"description": "Exact scheduler job ID returned by scheduler.list.",
|
|
"title": "Jobid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"jobid"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query"
|
|
],
|
|
"title": "scheduler.run",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Use the configured recommendation model to rank or recommend torrent search results. Method: POST. Path: /api/v1/search/recommend. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/Body_recommend_search_results_api_v1_search_recommend_post",
|
|
"description": "Request value for search.recommend. Use the configured recommendation model to rank or recommend torrent search results. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "search.recommend",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "search.recommend",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the most recent torrent-search context and result set. Method: GET. Path: /api/v1/search/last/context. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "search.results",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "search.results",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Search torrent sites directly from a free-form title and optional media filters. Method: GET. Path: /api/v1/search/title. Effect: external_side_effect. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "search.title",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for search.title. Search torrent sites directly from a free-form title and optional media filters. Use only the named fields below.",
|
|
"properties": {
|
|
"keyword": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Case-insensitive substring used to discover settings or filter storage entries.",
|
|
"title": "Keyword"
|
|
},
|
|
"mtype": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media type or subscription-history category required by the operation.",
|
|
"title": "Mtype"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "One-based result page number.",
|
|
"title": "Page"
|
|
},
|
|
"sites": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact site IDs included in the search or subscription scope.",
|
|
"title": "Sites"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "search.title",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Search torrent sites for one canonical media identity. Method: GET. Path: /api/v1/search/media/{media_id}. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "search.torrents",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for search.torrents. Search torrent sites for one canonical media identity. Use only the named fields below.",
|
|
"properties": {
|
|
"media_id": {
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for search.torrents. Search torrent sites for one canonical media identity. Use only the named fields below.",
|
|
"properties": {
|
|
"area": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": "title",
|
|
"description": "Optional region filter applied by the torrent search workflow.",
|
|
"title": "Area"
|
|
},
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"mtype": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media type or subscription-history category required by the operation.",
|
|
"title": "Mtype"
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
},
|
|
"season": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Season number used by the media, search, subscription, or transfer operation.",
|
|
"title": "Season"
|
|
},
|
|
"sites": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact site IDs included in the search or subscription scope.",
|
|
"title": "Sites"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_source"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"query"
|
|
],
|
|
"title": "search.torrents",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Create one configured site with its complete authentication and search settings. Method: POST. Path: /api/v1/site/. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/Site-Input",
|
|
"description": "Request value for site.add. Create one configured site with its complete authentication and search settings. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "site.add",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "site.add",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List site-account authentication providers and their required input definitions. Method: GET. Path: /api/v1/site/auth. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.auth.options",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "site.auth.options",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Authenticate a supported site account and persist the resulting site authorization state. Method: POST. Path: /api/v1/site/auth. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/SiteAuth",
|
|
"description": "Request value for site.authenticate. Authenticate a supported site account and persist the resulting site authorization state. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "site.authenticate",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "site.authenticate",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List torrent categories supported by one configured site. Method: GET. Path: /api/v1/site/category/{site_id}. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.category",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for site.category. List torrent categories supported by one configured site. Use only the named fields below.",
|
|
"properties": {
|
|
"site_id": {
|
|
"description": "Persistent site ID returned by site.list.",
|
|
"title": "Site Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"site_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for site.category. List torrent categories supported by one configured site. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "site.category",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Log in to one site and refresh its stored authentication cookie. Method: POST. Path: /api/v1/site/cookie/{site_id}. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/SiteCookieUpdate",
|
|
"description": "Request value for site.cookie.update. Log in to one site and refresh its stored authentication cookie. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "site.cookie.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for site.cookie.update. Log in to one site and refresh its stored authentication cookie. Use only the named fields below.",
|
|
"properties": {
|
|
"site_id": {
|
|
"description": "Persistent site ID returned by site.list.",
|
|
"title": "Site Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"site_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "site.cookie.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Start a CookieCloud synchronization of configured sites. Method: GET. Path: /api/v1/site/cookiecloud. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.cookiecloud.sync",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "site.cookiecloud.sync",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one configured site by persistent site ID. Method: DELETE. Path: /api/v1/site/{site_id}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for site.delete. Delete one configured site by persistent site ID. Use only the named fields below.",
|
|
"properties": {
|
|
"site_id": {
|
|
"description": "Persistent site ID returned by site.list.",
|
|
"title": "Site Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"site_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "site.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List configured sites with status/name filters; authentication fields are returned only to a superuser. Method: GET. Path: /api/v1/site/agent. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for site.list. List configured sites with status/name filters; authentication fields are returned only to a superuser. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
},
|
|
"status": {
|
|
"default": "all",
|
|
"description": "Transfer success status used to filter history or describe a record.",
|
|
"enum": [
|
|
"active",
|
|
"inactive",
|
|
"all"
|
|
],
|
|
"title": "Status",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "site.list",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the configured site-domain to site-name mapping. Method: GET. Path: /api/v1/site/mapping. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.mapping",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "site.mapping",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Replace priorities for the supplied configured site IDs. Method: POST. Path: /api/v1/site/priorities. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"description": "Request value for site.priorities.update. Replace priorities for the supplied configured site IDs. Use the exact type and fields below.",
|
|
"items": {
|
|
"$ref": "#/$defs/SitePriorityUpdate"
|
|
},
|
|
"title": "Priorities",
|
|
"type": "array"
|
|
},
|
|
"operation_id": {
|
|
"const": "site.priorities.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "site.priorities.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete all configured sites and start a fresh CookieCloud synchronization. Method: GET. Path: /api/v1/site/reset. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.reset",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "site.reset",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Browse torrent resources from one configured site with category and keyword filters. Method: GET. Path: /api/v1/site/resource/{site_id}. Effect: external_side_effect. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.resource",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for site.resource. Browse torrent resources from one configured site with category and keyword filters. Use only the named fields below.",
|
|
"properties": {
|
|
"site_id": {
|
|
"description": "Persistent site ID returned by site.list.",
|
|
"title": "Site Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"site_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for site.resource. Browse torrent resources from one configured site with category and keyword filters. Use only the named fields below.",
|
|
"properties": {
|
|
"cat": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact site category identifier returned by site.category.",
|
|
"title": "Cat"
|
|
},
|
|
"keyword": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Case-insensitive substring used to discover settings or filter storage entries.",
|
|
"title": "Keyword"
|
|
},
|
|
"mtype": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media type or subscription-history category required by the operation.",
|
|
"title": "Mtype"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "One-based result page number.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "site.resource",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List configured sites selected for RSS subscription processing. Method: GET. Path: /api/v1/site/rss. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.rss",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for site.rss. List configured sites selected for RSS subscription processing. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "site.rss",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List active configured sites supporting one exact media type. Method: GET. Path: /api/v1/site/media/{media_type}. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.searchable",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for site.searchable. List active configured sites supporting one exact media type. Use only the named fields below.",
|
|
"properties": {
|
|
"media_type": {
|
|
"description": "MoviePilot media type used to filter recommendations or rule groups.",
|
|
"title": "Media Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_type"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for site.searchable. List active configured sites supporting one exact media type. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "site.searchable",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read account and traffic statistics for one exact configured site domain. Method: GET. Path: /api/v1/site/statistic/{site_url}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.statistic",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for site.statistic. Read account and traffic statistics for one exact configured site domain. Use only the named fields below.",
|
|
"properties": {
|
|
"site_url": {
|
|
"description": "Configured site URL or hostname used to select one site's statistics.",
|
|
"title": "Site Url",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"site_url"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "site.statistic",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the latest account and traffic statistics for all configured sites. Method: GET. Path: /api/v1/site/statistic. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.statistics",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for site.statistics. Read the latest account and traffic statistics for all configured sites. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "site.statistics",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List indexer definitions supported by the installed MoviePilot resources. Method: GET. Path: /api/v1/site/supporting. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.supporting",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "site.supporting",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Test connectivity and authentication for one configured site. Method: GET. Path: /api/v1/site/test/{site_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.test",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for site.test. Test connectivity and authentication for one configured site. Use only the named fields below.",
|
|
"properties": {
|
|
"site_id": {
|
|
"description": "Persistent site ID returned by site.list.",
|
|
"title": "Site Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"site_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "site.test",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Update one configured site's complete settings. Method: PUT. Path: /api/v1/site/. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/Site-Input",
|
|
"description": "Request value for site.update. Update one configured site's complete settings. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "site.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "site.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the latest account statistics collected from one site. Method: GET. Path: /api/v1/site/userdata/{site_id}. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.userdata",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for site.userdata. Read the latest account statistics collected from one site. Use only the named fields below.",
|
|
"properties": {
|
|
"site_id": {
|
|
"description": "Persistent site ID returned by site.list.",
|
|
"title": "Site Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"site_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for site.userdata. Read the latest account statistics collected from one site. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
},
|
|
"workdate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Date used when retrieving one site's historical user statistics.",
|
|
"title": "Workdate"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "site.userdata",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the latest collected account statistics for every configured site. Method: GET. Path: /api/v1/site/userdata/latest. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.userdata.latest",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for site.userdata.latest. Read the latest collected account statistics for every configured site. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "site.userdata.latest",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Refresh and return account statistics for one configured site. Method: POST. Path: /api/v1/site/userdata/{site_id}. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "site.userdata.refresh",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for site.userdata.refresh. Refresh and return account statistics for one configured site. Use only the named fields below.",
|
|
"properties": {
|
|
"site_id": {
|
|
"description": "Persistent site ID returned by site.list.",
|
|
"title": "Site Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"site_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "site.userdata.refresh",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List slash commands that the Agent may dispatch. Method: GET. Path: /api/v1/message/agent/commands. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "slash.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for slash.list. List slash commands that the Agent may dispatch. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "slash.list",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Execute one complete slash command through MoviePilot messaging. Method: POST. Path: /api/v1/message/agent/commands/run. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/AgentCommandRunRequest",
|
|
"description": "Request value for slash.run. Execute one complete slash command through MoviePilot messaging. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "slash.run",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "slash.run",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one exact file or directory from a configured storage provider. Method: POST. Path: /api/v1/storage/delete. Effect: destructive_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/FileItem-Input",
|
|
"description": "Request value for storage.delete. Delete one exact file or directory from a configured storage provider. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "storage.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "storage.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List files or directories from one configured storage location. Method: POST. Path: /api/v1/storage/agent/list. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/FileItem-Input",
|
|
"description": "Request value for storage.list. List files or directories from one configured storage location. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "storage.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for storage.list. List files or directories from one configured storage location. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"keyword": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Case-insensitive substring used to discover settings or filter storage entries.",
|
|
"title": "Keyword"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
},
|
|
"sort": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": "updated_at",
|
|
"description": "Storage-list sort field or ordering expression.",
|
|
"title": "Sort"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "storage.list",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Run one provider-defined management action against an exact configured storage target. Method: POST. Path: /api/v1/storage/manage. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/ManageRequest",
|
|
"description": "Request value for storage.manage. Run one provider-defined management action against an exact configured storage target. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "storage.manage",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "storage.manage",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Create a named child directory below one exact storage directory item. Method: POST. Path: /api/v1/storage/mkdir. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/FileItem-Input",
|
|
"description": "Request value for storage.mkdir. Create a named child directory below one exact storage directory item. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "storage.mkdir",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for storage.mkdir. Create a named child directory below one exact storage directory item. Use only the named fields below.",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query",
|
|
"body"
|
|
],
|
|
"title": "storage.mkdir",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Rename one exact storage item, optionally applying media-aware recursive renaming. Method: POST. Path: /api/v1/storage/rename. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/FileItem-Input",
|
|
"description": "Request value for storage.rename. Rename one exact storage item, optionally applying media-aware recursive renaming. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "storage.rename",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for storage.rename. Rename one exact storage item, optionally applying media-aware recursive renaming. Use only the named fields below.",
|
|
"properties": {
|
|
"new_name": {
|
|
"description": "Replacement name for the existing filter-rule group.",
|
|
"title": "New Name",
|
|
"type": "string"
|
|
},
|
|
"recursive": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"description": "Apply media-aware renaming recursively to child files when true.",
|
|
"title": "Recursive"
|
|
}
|
|
},
|
|
"required": [
|
|
"new_name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query",
|
|
"body"
|
|
],
|
|
"title": "storage.rename",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read configured directory or storage settings. Method: GET. Path: /api/v1/storage/directories. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "storage.settings",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for storage.settings. Read configured directory or storage settings. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"directory_type": {
|
|
"default": "all",
|
|
"description": "Directory configuration subtype to return.",
|
|
"title": "Directory Type",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
},
|
|
"storage_type": {
|
|
"default": "all",
|
|
"description": "Configured storage provider type to return.",
|
|
"title": "Storage Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "storage.settings",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Create one movie, TV, or music subscription. Method: POST. Path: /api/v1/subscribe/. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/Subscribe",
|
|
"description": "Request value for subscription.add. Create one movie, TV, or music subscription. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "subscription.add",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "subscription.add",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one active subscription. Method: DELETE. Path: /api/v1/subscribe/{subscribe_id}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.delete. Delete one active subscription. Use only the named fields below.",
|
|
"properties": {
|
|
"subscribe_id": {
|
|
"description": "Persistent subscription ID returned by subscription.list.",
|
|
"title": "Subscribe Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"subscribe_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "subscription.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete accessible subscriptions matching one canonical media identity. Method: DELETE. Path: /api/v1/subscribe/media/{media_id}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.delete_by_media",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.delete_by_media. Delete accessible subscriptions matching one canonical media identity. Use only the named fields below.",
|
|
"properties": {
|
|
"media_id": {
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.delete_by_media. Delete accessible subscriptions matching one canonical media identity. Use only the named fields below.",
|
|
"properties": {
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
},
|
|
"season": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Season number used by the media, search, subscription, or transfer operation.",
|
|
"title": "Season"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_source"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"query"
|
|
],
|
|
"title": "subscription.delete_by_media",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read local library and transfer-file coverage for one accessible subscription. Method: GET. Path: /api/v1/subscribe/files/{subscribe_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.files",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.files. Read local library and transfer-file coverage for one accessible subscription. Use only the named fields below.",
|
|
"properties": {
|
|
"subscribe_id": {
|
|
"description": "Persistent subscription ID returned by subscription.list.",
|
|
"title": "Subscribe Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"subscribe_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "subscription.files",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Find one accessible subscription by canonical media identity and optional season. Method: GET. Path: /api/v1/subscribe/media/{media_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.find",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.find. Find one accessible subscription by canonical media identity and optional season. Use only the named fields below.",
|
|
"properties": {
|
|
"media_id": {
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.find. Find one accessible subscription by canonical media identity and optional season. Use only the named fields below.",
|
|
"properties": {
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
},
|
|
"season": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Season number used by the media, search, subscription, or transfer operation.",
|
|
"title": "Season"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Media, torrent, subscription, or history title used by the operation.",
|
|
"title": "Title"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_source"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"query"
|
|
],
|
|
"title": "subscription.find",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Follow one subscription-sharing user by exact share user ID. Method: POST. Path: /api/v1/subscribe/follow. Effect: reversible_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.follow.add",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.follow.add. Follow one subscription-sharing user by exact share user ID. Use only the named fields below.",
|
|
"properties": {
|
|
"share_uid": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact MoviePilot Server sharing-user ID to follow or unfollow.",
|
|
"title": "Share Uid"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "subscription.follow.add",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Stop following one subscription-sharing user by exact share user ID. Method: DELETE. Path: /api/v1/subscribe/follow. Effect: reversible_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.follow.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.follow.delete. Stop following one subscription-sharing user by exact share user ID. Use only the named fields below.",
|
|
"properties": {
|
|
"share_uid": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact MoviePilot Server sharing-user ID to follow or unfollow.",
|
|
"title": "Share Uid"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "subscription.follow.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List subscription-sharing user IDs followed by the current user. Method: GET. Path: /api/v1/subscribe/follow. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.follow.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.follow.list. List subscription-sharing user IDs followed by the current user. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "subscription.follow.list",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Create a local subscription from one shared subscription definition. Method: POST. Path: /api/v1/subscribe/fork. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/SubscribeShare",
|
|
"description": "Request value for subscription.fork. Create a local subscription from one shared subscription definition. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "subscription.fork",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "subscription.fork",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read one accessible subscription by persistent subscription ID. Method: GET. Path: /api/v1/subscribe/{subscribe_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.get. Read one accessible subscription by persistent subscription ID. Use only the named fields below.",
|
|
"properties": {
|
|
"subscribe_id": {
|
|
"description": "Persistent subscription ID returned by subscription.list.",
|
|
"title": "Subscribe Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"subscribe_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "subscription.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List completed or archived subscription records. Method: GET. Path: /api/v1/subscribe/history/{mtype}. Effect: safe_read. Collection response: data remains a list and the endpoint's documented pagination or limit defaults remain in effect. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count-only request, use the smallest valid page and read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.history",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.history. List completed or archived subscription records. Use only the named fields below.",
|
|
"properties": {
|
|
"mtype": {
|
|
"description": "MoviePilot media type or subscription-history category required by the operation.",
|
|
"title": "Mtype",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"mtype"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.history. List completed or archived subscription records. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 30,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "subscription.history",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one accessible subscription-history record. Method: DELETE. Path: /api/v1/subscribe/history/{history_id}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.history.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.history.delete. Delete one accessible subscription-history record. Use only the named fields below.",
|
|
"properties": {
|
|
"history_id": {
|
|
"description": "Persistent transfer- or subscription-history ID returned by a history operation.",
|
|
"title": "History Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"history_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "subscription.history.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List active subscriptions. Method: GET. Path: /api/v1/subscribe/. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.list. List active subscriptions. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "subscription.list",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Start a system-wide refresh of subscription TMDB metadata. Method: GET. Path: /api/v1/subscribe/check. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.metadata.refresh",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "subscription.metadata.refresh",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List globally popular subscriptions with filters and pagination. Method: GET. Path: /api/v1/subscribe/popular. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.popular",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.popular. List globally popular subscriptions with filters and pagination. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 30,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"title": "Count"
|
|
},
|
|
"genre_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Genre identifier used to filter shared or popular subscriptions.",
|
|
"title": "Genre Id"
|
|
},
|
|
"max_rating": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Maximum rating used to filter shared or popular subscriptions.",
|
|
"title": "Max Rating"
|
|
},
|
|
"min_rating": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Minimum rating used to filter shared or popular subscriptions.",
|
|
"title": "Min Rating"
|
|
},
|
|
"min_sub": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Minimum subscriber count used to filter popular subscriptions.",
|
|
"title": "Min Sub"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"title": "Page"
|
|
},
|
|
"sort_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Ascending or descending order used by shared or popular subscriptions.",
|
|
"title": "Sort Type"
|
|
},
|
|
"stype": {
|
|
"description": "Popular-subscription category requested by the endpoint.",
|
|
"title": "Stype",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"stype"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query"
|
|
],
|
|
"title": "subscription.popular",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Start the configured system-wide subscription refresh job. Method: GET. Path: /api/v1/subscribe/refresh. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.refresh",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "subscription.refresh",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Reset one accessible subscription so it can be processed again. Method: GET. Path: /api/v1/subscribe/reset/{subid}. Effect: reversible_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.reset",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.reset. Reset one accessible subscription so it can be processed again. Use only the named fields below.",
|
|
"properties": {
|
|
"subid": {
|
|
"description": "Persistent subscription ID whose status or processing state will change.",
|
|
"title": "Subid",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"subid"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "subscription.reset",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Run an immediate search for one existing subscription. Method: GET. Path: /api/v1/subscribe/search/{subscribe_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.search",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.search. Run an immediate search for one existing subscription. Use only the named fields below.",
|
|
"properties": {
|
|
"subscribe_id": {
|
|
"description": "Persistent subscription ID returned by subscription.list.",
|
|
"title": "Subscribe Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"subscribe_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "subscription.search",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Start immediate searches for all subscriptions accessible to the current user. Method: GET. Path: /api/v1/subscribe/search. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.search_all",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "subscription.search_all",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Publish one accessible subscription to the MoviePilot sharing service. Method: POST. Path: /api/v1/subscribe/share. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/SubscribeShare",
|
|
"description": "Request value for subscription.share. Publish one accessible subscription to the MoviePilot sharing service. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "subscription.share",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "subscription.share",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one shared-subscription publication by share ID. Method: DELETE. Path: /api/v1/subscribe/share/{share_id}. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.share.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.share.delete. Delete one shared-subscription publication by share ID. Use only the named fields below.",
|
|
"properties": {
|
|
"share_id": {
|
|
"description": "Persistent MoviePilot Server share ID returned by a share-list operation.",
|
|
"title": "Share Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"share_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "subscription.share.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read aggregate contribution and reuse counts for subscription sharers. Method: GET. Path: /api/v1/subscribe/share/statistics. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.share.statistics",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.share.statistics. Read aggregate contribution and reuse counts for subscription sharers. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "subscription.share.statistics",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List shared subscriptions with filters and pagination. Method: GET. Path: /api/v1/subscribe/shares. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.shares",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.shares. List shared subscriptions with filters and pagination. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 30,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"title": "Count"
|
|
},
|
|
"genre_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Genre identifier used to filter shared or popular subscriptions.",
|
|
"title": "Genre Id"
|
|
},
|
|
"max_rating": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Maximum rating used to filter shared or popular subscriptions.",
|
|
"title": "Max Rating"
|
|
},
|
|
"min_rating": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Minimum rating used to filter shared or popular subscriptions.",
|
|
"title": "Min Rating"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"title": "Page"
|
|
},
|
|
"sort_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Ascending or descending order used by shared or popular subscriptions.",
|
|
"title": "Sort Type"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "subscription.shares",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Set one accessible subscription to running, paused, or stopped state. Method: PUT. Path: /api/v1/subscribe/status/{subid}. Effect: reversible_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.status.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.status.update. Set one accessible subscription to running, paused, or stopped state. Use only the named fields below.",
|
|
"properties": {
|
|
"subid": {
|
|
"description": "Persistent subscription ID whose status or processing state will change.",
|
|
"title": "Subid",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"subid"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.status.update. Set one accessible subscription to running, paused, or stopped state. Use only the named fields below.",
|
|
"properties": {
|
|
"state": {
|
|
"description": "Current site, subscription, marketplace, or transfer state filter.",
|
|
"title": "State",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"state"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"query"
|
|
],
|
|
"title": "subscription.status.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Update one existing movie, TV, or music subscription. Method: PUT. Path: /api/v1/subscribe/. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/Subscribe",
|
|
"description": "Request value for subscription.update. Update one existing movie, TV, or music subscription. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "subscription.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "subscription.update",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List public subscriptions owned by one accessible MoviePilot username. Method: GET. Path: /api/v1/subscribe/user/{username}. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subscription.user.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subscription.user.list. List public subscriptions owned by one accessible MoviePilot username. Use only the named fields below.",
|
|
"properties": {
|
|
"username": {
|
|
"description": "MoviePilot or site username required by the selected operation.",
|
|
"title": "Username",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subscription.user.list. List public subscriptions owned by one accessible MoviePilot username. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "subscription.user.list",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Search subtitle providers for one canonical media identity and optional season or episode. Method: GET. Path: /api/v1/search/subtitle/media/{media_id}. Effect: external_side_effect. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subtitle.search.media",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for subtitle.search.media. Search subtitle providers for one canonical media identity and optional season or episode. Use only the named fields below.",
|
|
"properties": {
|
|
"media_id": {
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subtitle.search.media. Search subtitle providers for one canonical media identity and optional season or episode. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"episode": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Episode number used to narrow a subtitle or media search.",
|
|
"title": "Episode"
|
|
},
|
|
"media_source": {
|
|
"$ref": "#/$defs/MediaSource",
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id."
|
|
},
|
|
"mtype": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "MoviePilot media type or subscription-history category required by the operation.",
|
|
"title": "Mtype"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
},
|
|
"season": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Season number used by the media, search, subscription, or transfer operation.",
|
|
"title": "Season"
|
|
},
|
|
"sites": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact site IDs included in the search or subscription scope.",
|
|
"title": "Sites"
|
|
}
|
|
},
|
|
"required": [
|
|
"media_source"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"query"
|
|
],
|
|
"title": "subtitle.search.media",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Search subtitle providers from a free-form title and optional media filters. Method: GET. Path: /api/v1/search/subtitle/title. Effect: external_side_effect. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "subtitle.search.title",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for subtitle.search.title. Search subtitle providers from a free-form title and optional media filters. Use only the named fields below.",
|
|
"properties": {
|
|
"keyword": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Case-insensitive substring used to discover settings or filter storage entries.",
|
|
"title": "Keyword"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 0,
|
|
"description": "One-based result page number.",
|
|
"title": "Page"
|
|
},
|
|
"sites": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Exact site IDs included in the search or subscription scope.",
|
|
"title": "Sites"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "subtitle.search.title",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List loaded MoviePilot module IDs and localized names. Method: GET. Path: /api/v1/system/modulelist. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "system.module.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "system.module.list",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Run the built-in availability test for one loaded MoviePilot module. Method: GET. Path: /api/v1/system/moduletest/{moduleid}. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "system.module.test",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for system.module.test. Run the built-in availability test for one loaded MoviePilot module. Use only the named fields below.",
|
|
"properties": {
|
|
"moduleid": {
|
|
"description": "Exact loaded module ID returned by system.module.list.",
|
|
"title": "Moduleid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"moduleid"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "system.module.test",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List approved built-in network-test targets without exposing their request URLs. Method: GET. Path: /api/v1/system/nettest/targets. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "system.network.targets",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for system.network.targets. List approved built-in network-test targets without exposing their request URLs. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "system.network.targets",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Test connectivity to one approved target or the legacy constrained URL input. Method: GET. Path: /api/v1/system/nettest. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "system.network.test",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for system.network.test. Test connectivity to one approved target or the legacy constrained URL input. Use only the named fields below.",
|
|
"properties": {
|
|
"include": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Regular expression or filter expression that a release must match.",
|
|
"title": "Include"
|
|
},
|
|
"target_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Approved built-in network-test target ID returned by system.network.targets.",
|
|
"title": "Target Id"
|
|
},
|
|
"url": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Site, storage, or torrent URL represented by this field.",
|
|
"title": "Url"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "system.network.test",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Restart the running MoviePilot process. Method: GET. Path: /api/v1/system/restart. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "system.restart",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "system.restart",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Check for the latest stable MoviePilot v3 application release and current-platform site resources. Method: POST. Path: /api/v1/system/update/check. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "system.update.check",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "system.update.check",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Start downloading and verifying one selected application or site-resource update in the background. Method: POST. Path: /api/v1/system/update/download. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/SystemUpdateRequest"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Request value for system.update.download. Start downloading and verifying one selected application or site-resource update in the background. Use the exact type and fields below.",
|
|
"title": "Request"
|
|
},
|
|
"operation_id": {
|
|
"const": "system.update.download",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "system.update.download",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Install one selected already downloaded and verified application or site-resource update, then restart MoviePilot. Method: POST. Path: /api/v1/system/update/install. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/SystemUpdateRequest"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Request value for system.update.install. Install one selected already downloaded and verified application or site-resource update, then restart MoviePilot. Use the exact type and fields below.",
|
|
"title": "Request"
|
|
},
|
|
"operation_id": {
|
|
"const": "system.update.install",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "system.update.install",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read application and site-resource update checks, downloads, verification, or install state. Method: GET. Path: /api/v1/system/update/status. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "system.update.status",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "system.update.status",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Update to the current v3 development branch and restart MoviePilot. Method: POST. Path: /api/v1/system/upgrade. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"const": "dev",
|
|
"description": "Literal dev. Release updates must use the separate check, download, and install operations.",
|
|
"type": "string"
|
|
},
|
|
"operation_id": {
|
|
"const": "system.upgrade.dev",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "system.upgrade.dev",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read the installation version and runtime usage report available to the current user. Method: GET. Path: /api/v1/system/usage/statistic. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "system.usage.statistics",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "system.usage.statistics",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List available MoviePilot GitHub releases. Method: GET. Path: /api/v1/system/versions. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "system.versions",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for system.versions. List available MoviePilot GitHub releases. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "system.versions",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete every cached torrent context. Method: DELETE. Path: /api/v1/torrent/cache. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "torrent.cache.clear",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "torrent.cache.clear",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one cached torrent context by site domain and cache hash. Method: DELETE. Path: /api/v1/torrent/cache/{domain}/{torrent_hash}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "torrent.cache.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for torrent.cache.delete. Delete one cached torrent context by site domain and cache hash. Use only the named fields below.",
|
|
"properties": {
|
|
"domain": {
|
|
"description": "Site hostname or domain used for matching and requests.",
|
|
"title": "Domain",
|
|
"type": "string"
|
|
},
|
|
"torrent_hash": {
|
|
"description": "Cache hash returned by torrent.cache.get for one exact site-domain entry.",
|
|
"title": "Torrent Hash",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"domain",
|
|
"torrent_hash"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "torrent.cache.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Inspect cached torrent contexts and their recognized media identities. Method: GET. Path: /api/v1/torrent/cache. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "torrent.cache.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "torrent.cache.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Refresh torrent caches from configured RSS or spider sources. Method: POST. Path: /api/v1/torrent/cache/refresh. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "torrent.cache.refresh",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "torrent.cache.refresh",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Replace or recompute the media identity for one cached torrent context. Method: POST. Path: /api/v1/torrent/cache/reidentify/{domain}/{torrent_hash}. Effect: reversible_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "torrent.cache.reidentify",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for torrent.cache.reidentify. Replace or recompute the media identity for one cached torrent context. Use only the named fields below.",
|
|
"properties": {
|
|
"domain": {
|
|
"description": "Site hostname or domain used for matching and requests.",
|
|
"title": "Domain",
|
|
"type": "string"
|
|
},
|
|
"torrent_hash": {
|
|
"description": "Cache hash returned by torrent.cache.get for one exact site-domain entry.",
|
|
"title": "Torrent Hash",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"domain",
|
|
"torrent_hash"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for torrent.cache.reidentify. Replace or recompute the media identity for one cached torrent context. Use only the named fields below.",
|
|
"properties": {
|
|
"media_id": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Source-native media ID. Always pair it with the exact media_source returned by search.",
|
|
"title": "Media Id"
|
|
},
|
|
"media_source": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/$defs/MediaSource"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Metadata source identifier. Preserve the exact value returned with media_id.",
|
|
"title": "Media Source"
|
|
},
|
|
"music_type": {
|
|
"anyOf": [
|
|
{
|
|
"enum": [
|
|
"recording",
|
|
"album"
|
|
],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Music identity level: recording, album, or artist where supported.",
|
|
"title": "Music Type"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "torrent.cache.reidentify",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Recommend an episode-number extraction template from supplied file samples. Method: POST. Path: /api/v1/transfer/episode-format/recommend. Effect: safe_read.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/EpisodeFormatRecommendItem",
|
|
"description": "Request value for transfer.episode_format.recommend. Recommend an episode-number extraction template from supplied file samples. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "transfer.episode_format.recommend",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "transfer.episode_format.recommend",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Run MoviePilot's manual file-transfer and organization workflow. Method: POST. Path: /api/v1/transfer/manual. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/ManualTransferItem",
|
|
"description": "Request value for transfer.file. Run MoviePilot's manual file-transfer and organization workflow. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "transfer.file",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for transfer.file. Run MoviePilot's manual file-transfer and organization workflow. Use only the named fields below.",
|
|
"properties": {
|
|
"background": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"description": "Run the transfer asynchronously and return before completion.",
|
|
"title": "Background"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "transfer.file",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List file-transfer history with filters and pagination. Method: GET. Path: /api/v1/history/transfer. Effect: safe_read. Collection response: items stay in data.list and the exact total stays in data.total. For a count-only request, use the smallest documented page and read that total; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "transfer.history",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for transfer.history. List file-transfer history with filters and pagination. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 30,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"title": "Page"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Transfer success status used to filter history or describe a record.",
|
|
"title": "Status"
|
|
},
|
|
"title": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Media, torrent, subscription, or history title used by the operation.",
|
|
"title": "Title"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "transfer.history",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "page_object",
|
|
"default_pagination": "endpoint-defined",
|
|
"items_field": "data.list",
|
|
"total_count_field": "data.total"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete every transfer-history record while leaving transferred files untouched. Method: GET. Path: /api/v1/history/empty/transfer. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "transfer.history.clear",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "transfer.history.clear",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one transfer-history record and optionally remove files. Method: DELETE. Path: /api/v1/history/transfer. Effect: destructive_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/TransferHistory-Input",
|
|
"description": "Request value for transfer.history.delete. Delete one transfer-history record and optionally remove files. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "transfer.history.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for transfer.history.delete. Delete one transfer-history record and optionally remove files. Use only the named fields below.",
|
|
"properties": {
|
|
"deletedest": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"description": "Also delete the organized destination files when deleting transfer history.",
|
|
"title": "Deletedest"
|
|
},
|
|
"deletesrc": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": false,
|
|
"description": "Also delete the recorded source files when deleting transfer history.",
|
|
"title": "Deletesrc"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "transfer.history.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Start AI-assisted reorganization for one transfer-history record. Method: POST. Path: /api/v1/history/transfer/{history_id}/ai-redo. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "transfer.history.redo",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for transfer.history.redo. Start AI-assisted reorganization for one transfer-history record. Use only the named fields below.",
|
|
"properties": {
|
|
"history_id": {
|
|
"description": "Persistent transfer- or subscription-history ID returned by a history operation.",
|
|
"title": "History Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"history_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "transfer.history.redo",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Start AI-assisted reorganization for an explicit list of transfer-history records. Method: POST. Path: /api/v1/history/transfer/ai-redo. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/BatchTransferHistoryRedoRequest",
|
|
"description": "Request value for transfer.history.redo_batch. Start AI-assisted reorganization for an explicit list of transfer-history records. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "transfer.history.redo_batch",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "transfer.history.redo_batch",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Check whether supplied storage items already have successful transfer history. Method: POST. Path: /api/v1/transfer/manual/history. Effect: safe_read.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/ManualTransferItem",
|
|
"description": "Request value for transfer.manual_history. Check whether supplied storage items already have successful transfer history. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "transfer.manual_history",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "transfer.manual_history",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read one durable transfer task awaiting manual review. Method: GET. Path: /api/v1/transfer/tasks/{task_id}/manual-review. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "transfer.manual_review",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for transfer.manual_review. Read one durable transfer task awaiting manual review. Use only the named fields below.",
|
|
"properties": {
|
|
"task_id": {
|
|
"description": "Stable durable transfer task ID returned by transfer.manual_reviews.",
|
|
"title": "Task Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "transfer.manual_review",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Record the authorized decision for one durable transfer manual-review operation. Method: POST. Path: /api/v1/transfer/tasks/{task_id}/manual-review. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/TransferManualReviewRequest",
|
|
"description": "Request value for transfer.manual_review.resolve. Record the authorized decision for one durable transfer manual-review operation. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "transfer.manual_review.resolve",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for transfer.manual_review.resolve. Record the authorized decision for one durable transfer manual-review operation. Use only the named fields below.",
|
|
"properties": {
|
|
"task_id": {
|
|
"description": "Stable durable transfer task ID returned by transfer.manual_reviews.",
|
|
"title": "Task Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"task_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "transfer.manual_review.resolve",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Page durable transfer tasks awaiting manual review or retry recovery. Method: GET. Path: /api/v1/transfer/tasks/manual-reviews. Effect: safe_read. Collection response: items stay in data.items and the exact total stays in data.total. For a count-only request, use the smallest documented page and read that total; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "transfer.manual_reviews",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for transfer.manual_reviews. Page durable transfer tasks awaiting manual review or retry recovery. Use only the named fields below.",
|
|
"properties": {
|
|
"page": {
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"minimum": 1,
|
|
"title": "Page",
|
|
"type": "integer"
|
|
},
|
|
"page_size": {
|
|
"default": 30,
|
|
"description": "Maximum records returned on one page.",
|
|
"maximum": 100,
|
|
"minimum": 1,
|
|
"title": "Page Size",
|
|
"type": "integer"
|
|
},
|
|
"state": {
|
|
"default": "manual_review",
|
|
"description": "Current site, subscription, marketplace, or transfer state filter.",
|
|
"enum": [
|
|
"manual_review",
|
|
"retry_wait"
|
|
],
|
|
"title": "State",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "transfer.manual_reviews",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "page_object",
|
|
"default_pagination": "endpoint-defined",
|
|
"items_field": "data.items",
|
|
"total_count_field": "data.total"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Preview the organized destination name for one source path and media identity. Method: GET. Path: /api/v1/transfer/name. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "transfer.name",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for transfer.name. Preview the organized destination name for one source path and media identity. Use only the named fields below.",
|
|
"properties": {
|
|
"filetype": {
|
|
"description": "Media file type used to preview the organized destination name.",
|
|
"title": "Filetype",
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"description": "Storage or history path represented by this record.",
|
|
"title": "Path",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"path",
|
|
"filetype"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"query"
|
|
],
|
|
"title": "transfer.name",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List items waiting in the file-transfer queue. Method: GET. Path: /api/v1/transfer/queue. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "transfer.queue",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for transfer.queue. List items waiting in the file-transfer queue. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "transfer.queue",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Remove one exact storage item from the file-transfer queue and stop its transfer. Method: DELETE. Path: /api/v1/transfer/queue. Effect: destructive_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/FileItem-Input",
|
|
"description": "Request value for transfer.queue.delete. Remove one exact storage item from the file-transfer queue and stop its transfer. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "transfer.queue.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "transfer.queue.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Resolve the configured transfer destination for supplied source storage items. Method: POST. Path: /api/v1/transfer/manual/target-path. Effect: safe_read.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/ManualTransferItem",
|
|
"description": "Request value for transfer.target_path. Resolve the configured transfer destination for supplied source storage items. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "transfer.target_path",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "transfer.target_path",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List built-in workflow action definitions and their parameter contracts. Method: GET. Path: /api/v1/workflow/actions. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.actions",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for workflow.actions. List built-in workflow action definitions and their parameter contracts. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "workflow.actions",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Create one workflow from a complete workflow definition. Method: POST. Path: /api/v1/workflow/. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/Workflow-Input",
|
|
"description": "Request value for workflow.create. Create one workflow from a complete workflow definition. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "workflow.create",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "workflow.create",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one configured workflow by persistent workflow ID. Method: DELETE. Path: /api/v1/workflow/{workflow_id}. Effect: destructive_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for workflow.delete. Delete one configured workflow by persistent workflow ID. Use only the named fields below.",
|
|
"properties": {
|
|
"workflow_id": {
|
|
"description": "Persistent workflow ID returned by workflow.list.",
|
|
"title": "Workflow Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"workflow_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "workflow.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List event types that can trigger workflows. Method: GET. Path: /api/v1/workflow/event_types. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.event_types",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for workflow.event_types. List event types that can trigger workflows. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "workflow.event_types",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Create a local workflow from one shared workflow definition. Method: POST. Path: /api/v1/workflow/fork. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/WorkflowShare",
|
|
"description": "Request value for workflow.fork. Create a local workflow from one shared workflow definition. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "workflow.fork",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "workflow.fork",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Read one complete configured workflow definition. Method: GET. Path: /api/v1/workflow/{workflow_id}. Effect: safe_read.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.get",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for workflow.get. Read one complete configured workflow definition. Use only the named fields below.",
|
|
"properties": {
|
|
"workflow_id": {
|
|
"description": "Persistent workflow ID returned by workflow.list.",
|
|
"title": "Workflow Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"workflow_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "workflow.get",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List configured workflows and their execution state. Method: GET. Path: /api/v1/workflow/agent. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.list",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for workflow.list. List configured workflows and their execution state. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
},
|
|
"state": {
|
|
"default": "all",
|
|
"description": "Current site, subscription, marketplace, or transfer state filter.",
|
|
"enum": [
|
|
"W",
|
|
"R",
|
|
"P",
|
|
"S",
|
|
"F",
|
|
"all"
|
|
],
|
|
"title": "State",
|
|
"type": "string"
|
|
},
|
|
"trigger_type": {
|
|
"default": "all",
|
|
"description": "Workflow trigger filter: timer, event, manual, or all.",
|
|
"enum": [
|
|
"timer",
|
|
"event",
|
|
"manual",
|
|
"all"
|
|
],
|
|
"title": "Trigger Type",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "workflow.list",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Disable automatic execution of one configured workflow. Method: POST. Path: /api/v1/workflow/{workflow_id}/pause. Effect: reversible_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.pause",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for workflow.pause. Disable automatic execution of one configured workflow. Use only the named fields below.",
|
|
"properties": {
|
|
"workflow_id": {
|
|
"description": "Persistent workflow ID returned by workflow.list.",
|
|
"title": "Workflow Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"workflow_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "workflow.pause",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List workflow actions contributed by installed plugins, optionally filtered by plugin ID. Method: GET. Path: /api/v1/workflow/plugin/actions. Effect: safe_read. Collection response: data remains a list; omit both page and count to preserve the legacy complete result. Successful gateway output adds collection.result_count and the exact collection.total_count. For a count or summary, send page=1 and count=1, then read collection.total_count; do not query the database merely because item data is truncated.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.plugin.actions",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for workflow.plugin.actions. List workflow actions contributed by installed plugins, optionally filtered by plugin ID. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"maximum": 200,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional page size for a legacy full-list endpoint. Supplying page or count activates pagination; an omitted count then uses 50.",
|
|
"title": "Count"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Optional one-based page for a legacy full-list endpoint. Omit both page and count to keep the original unpaginated full result.",
|
|
"title": "Page"
|
|
},
|
|
"plugin_id": {
|
|
"description": "Exact installed or marketplace plugin ID.",
|
|
"title": "Plugin Id",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "workflow.plugin.actions",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "unpaginated",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": "collection.total_count"
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Reset one configured workflow definition and execution state. Method: POST. Path: /api/v1/workflow/{workflow_id}/reset. Effect: reversible_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.reset",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for workflow.reset. Reset one configured workflow definition and execution state. Use only the named fields below.",
|
|
"properties": {
|
|
"workflow_id": {
|
|
"description": "Persistent workflow ID returned by workflow.list.",
|
|
"title": "Workflow Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"workflow_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "workflow.reset",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Run one configured workflow from the beginning or resume point. Method: POST. Path: /api/v1/workflow/{workflow_id}/run. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.run",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for workflow.run. Run one configured workflow from the beginning or resume point. Use only the named fields below.",
|
|
"properties": {
|
|
"workflow_id": {
|
|
"description": "Persistent workflow ID returned by workflow.list.",
|
|
"title": "Workflow Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"workflow_id"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for workflow.run. Run one configured workflow from the beginning or resume point. Use only the named fields below.",
|
|
"properties": {
|
|
"from_begin": {
|
|
"anyOf": [
|
|
{
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": true,
|
|
"description": "Restart the workflow from its first action instead of resuming progress.",
|
|
"title": "From Begin"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "workflow.run",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Publish one configured workflow to the MoviePilot sharing service. Method: POST. Path: /api/v1/workflow/share. Effect: external_side_effect.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/WorkflowShare",
|
|
"description": "Request value for workflow.share. Publish one configured workflow to the MoviePilot sharing service. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "workflow.share",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"body"
|
|
],
|
|
"title": "workflow.share",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Delete one shared-workflow publication by share ID. Method: DELETE. Path: /api/v1/workflow/share/{share_id}. Effect: external_side_effect.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.share.delete",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for workflow.share.delete. Delete one shared-workflow publication by share ID. Use only the named fields below.",
|
|
"properties": {
|
|
"share_id": {
|
|
"description": "Persistent MoviePilot Server share ID returned by a share-list operation.",
|
|
"title": "Share Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"share_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "workflow.share.delete",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "List shared workflows with name and pagination filters. Method: GET. Path: /api/v1/workflow/shares. Effect: safe_read. Collection response: data remains a list and successful gateway output adds collection.result_count. collection.total_count is omitted when the endpoint or its upstream source does not expose a total.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.shares",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"query": {
|
|
"additionalProperties": false,
|
|
"description": "Filters and control values for workflow.shares. List shared workflows with name and pagination filters. Use only the named fields below.",
|
|
"properties": {
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 30,
|
|
"description": "Maximum number of records to return on the requested page.",
|
|
"title": "Count"
|
|
},
|
|
"name": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Human-readable name of the site, storage item, subscription, or rule group.",
|
|
"title": "Name"
|
|
},
|
|
"page": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"default": 1,
|
|
"description": "One-based result page number.",
|
|
"title": "Page"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "workflow.shares",
|
|
"type": "object",
|
|
"x-moviepilot-collection": {
|
|
"body_shape": "list",
|
|
"default_pagination": "endpoint-defined",
|
|
"result_count_field": "collection.result_count",
|
|
"total_count_field": null
|
|
}
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Enable automatic execution of one configured workflow. Method: POST. Path: /api/v1/workflow/{workflow_id}/start. Effect: reversible_write.",
|
|
"properties": {
|
|
"operation_id": {
|
|
"const": "workflow.start",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for workflow.start. Enable automatic execution of one configured workflow. Use only the named fields below.",
|
|
"properties": {
|
|
"workflow_id": {
|
|
"description": "Persistent workflow ID returned by workflow.list.",
|
|
"title": "Workflow Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"workflow_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params"
|
|
],
|
|
"title": "workflow.start",
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"description": "Replace one configured workflow definition. Method: PUT. Path: /api/v1/workflow/{workflow_id}. Effect: reversible_write.",
|
|
"properties": {
|
|
"body": {
|
|
"$ref": "#/$defs/Workflow-Input",
|
|
"description": "Request value for workflow.update. Replace one configured workflow definition. Use the exact type and fields below."
|
|
},
|
|
"operation_id": {
|
|
"const": "workflow.update",
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"additionalProperties": false,
|
|
"description": "Resource identity placeholders for workflow.update. Replace one configured workflow definition. Use only the named fields below.",
|
|
"properties": {
|
|
"workflow_id": {
|
|
"description": "Persistent workflow ID returned by workflow.list.",
|
|
"title": "Workflow Id",
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"workflow_id"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id",
|
|
"path_params",
|
|
"body"
|
|
],
|
|
"title": "workflow.update",
|
|
"type": "object"
|
|
}
|
|
],
|
|
"properties": {
|
|
"body": {
|
|
"description": "Request value for the selected operation. Match the exact operation oneOf branch; scalar and object request bodies are not interchangeable."
|
|
},
|
|
"operation_id": {
|
|
"description": "Exact allowlisted MoviePilot operation ID selecting this oneOf branch.",
|
|
"enum": [
|
|
"config.identifiers.get",
|
|
"config.identifiers.update",
|
|
"config.public.get",
|
|
"config.system.get",
|
|
"config.system.update",
|
|
"config.user.get",
|
|
"dashboard.cpu",
|
|
"dashboard.downloader",
|
|
"dashboard.media.statistics",
|
|
"dashboard.memory",
|
|
"dashboard.network",
|
|
"dashboard.processes",
|
|
"dashboard.storage",
|
|
"dashboard.system",
|
|
"dashboard.transfer.statistics",
|
|
"database.backups.create",
|
|
"database.backups.delete",
|
|
"database.backups.list",
|
|
"database.backups.verify",
|
|
"download.add",
|
|
"download.clients",
|
|
"download.history.delete",
|
|
"download.history.list",
|
|
"download.paths",
|
|
"download.tasks.active",
|
|
"filter.builtin",
|
|
"filter.custom",
|
|
"filter.custom.add",
|
|
"filter.custom.delete",
|
|
"filter.custom.update",
|
|
"filter.group.add",
|
|
"filter.group.delete",
|
|
"filter.group.update",
|
|
"filter.groups",
|
|
"filter.test",
|
|
"library.exists",
|
|
"library.latest",
|
|
"media.categories",
|
|
"media.category.config.get",
|
|
"media.category.config.update",
|
|
"media.detail",
|
|
"media.episode_group.seasons",
|
|
"media.episode_groups",
|
|
"media.episode_schedule",
|
|
"media.person.credits",
|
|
"media.person.search",
|
|
"media.recognize",
|
|
"media.recognize_file",
|
|
"media.scrape",
|
|
"media.search",
|
|
"media.seasons",
|
|
"media.sources",
|
|
"music.album.get",
|
|
"music.album.related",
|
|
"music.artist.albums",
|
|
"music.artist.get",
|
|
"music.artist.related",
|
|
"music.cache.clear",
|
|
"music.cache.delete",
|
|
"music.cache.get",
|
|
"music.explore",
|
|
"music.recognize",
|
|
"plugin.capabilities",
|
|
"plugin.clone",
|
|
"plugin.config.get",
|
|
"plugin.config.update",
|
|
"plugin.data",
|
|
"plugin.folder.create",
|
|
"plugin.folder.delete",
|
|
"plugin.folder.plugins.update",
|
|
"plugin.folders.get",
|
|
"plugin.folders.update",
|
|
"plugin.history",
|
|
"plugin.install",
|
|
"plugin.installed",
|
|
"plugin.market",
|
|
"plugin.market.sync_wiki",
|
|
"plugin.rating",
|
|
"plugin.rating.submit",
|
|
"plugin.ratings",
|
|
"plugin.releases",
|
|
"plugin.reload",
|
|
"plugin.reset",
|
|
"plugin.runtime.status",
|
|
"plugin.source.change",
|
|
"plugin.source.install",
|
|
"plugin.source.options",
|
|
"plugin.statistics",
|
|
"plugin.uninstall",
|
|
"recommendation.list",
|
|
"scheduler.list",
|
|
"scheduler.progress",
|
|
"scheduler.run",
|
|
"search.recommend",
|
|
"search.results",
|
|
"search.title",
|
|
"search.torrents",
|
|
"site.add",
|
|
"site.auth.options",
|
|
"site.authenticate",
|
|
"site.category",
|
|
"site.cookie.update",
|
|
"site.cookiecloud.sync",
|
|
"site.delete",
|
|
"site.list",
|
|
"site.mapping",
|
|
"site.priorities.update",
|
|
"site.reset",
|
|
"site.resource",
|
|
"site.rss",
|
|
"site.searchable",
|
|
"site.statistic",
|
|
"site.statistics",
|
|
"site.supporting",
|
|
"site.test",
|
|
"site.update",
|
|
"site.userdata",
|
|
"site.userdata.latest",
|
|
"site.userdata.refresh",
|
|
"slash.list",
|
|
"slash.run",
|
|
"storage.delete",
|
|
"storage.list",
|
|
"storage.manage",
|
|
"storage.mkdir",
|
|
"storage.rename",
|
|
"storage.settings",
|
|
"subscription.add",
|
|
"subscription.delete",
|
|
"subscription.delete_by_media",
|
|
"subscription.files",
|
|
"subscription.find",
|
|
"subscription.follow.add",
|
|
"subscription.follow.delete",
|
|
"subscription.follow.list",
|
|
"subscription.fork",
|
|
"subscription.get",
|
|
"subscription.history",
|
|
"subscription.history.delete",
|
|
"subscription.list",
|
|
"subscription.metadata.refresh",
|
|
"subscription.popular",
|
|
"subscription.refresh",
|
|
"subscription.reset",
|
|
"subscription.search",
|
|
"subscription.search_all",
|
|
"subscription.share",
|
|
"subscription.share.delete",
|
|
"subscription.share.statistics",
|
|
"subscription.shares",
|
|
"subscription.status.update",
|
|
"subscription.update",
|
|
"subscription.user.list",
|
|
"subtitle.search.media",
|
|
"subtitle.search.title",
|
|
"system.module.list",
|
|
"system.module.test",
|
|
"system.network.targets",
|
|
"system.network.test",
|
|
"system.restart",
|
|
"system.update.check",
|
|
"system.update.download",
|
|
"system.update.install",
|
|
"system.update.status",
|
|
"system.upgrade.dev",
|
|
"system.usage.statistics",
|
|
"system.versions",
|
|
"torrent.cache.clear",
|
|
"torrent.cache.delete",
|
|
"torrent.cache.get",
|
|
"torrent.cache.refresh",
|
|
"torrent.cache.reidentify",
|
|
"transfer.episode_format.recommend",
|
|
"transfer.file",
|
|
"transfer.history",
|
|
"transfer.history.clear",
|
|
"transfer.history.delete",
|
|
"transfer.history.redo",
|
|
"transfer.history.redo_batch",
|
|
"transfer.manual_history",
|
|
"transfer.manual_review",
|
|
"transfer.manual_review.resolve",
|
|
"transfer.manual_reviews",
|
|
"transfer.name",
|
|
"transfer.queue",
|
|
"transfer.queue.delete",
|
|
"transfer.target_path",
|
|
"workflow.actions",
|
|
"workflow.create",
|
|
"workflow.delete",
|
|
"workflow.event_types",
|
|
"workflow.fork",
|
|
"workflow.get",
|
|
"workflow.list",
|
|
"workflow.pause",
|
|
"workflow.plugin.actions",
|
|
"workflow.reset",
|
|
"workflow.run",
|
|
"workflow.share",
|
|
"workflow.share.delete",
|
|
"workflow.shares",
|
|
"workflow.start",
|
|
"workflow.update"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"path_params": {
|
|
"description": "Resource identities inserted only into the selected operation's fixed route placeholders. Use the exact names and types in its oneOf branch.",
|
|
"type": "object"
|
|
},
|
|
"query": {
|
|
"description": "Filters and control values sent in the query string. Use the exact names, types, defaults, and enums in the selected operation's oneOf branch.",
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"operation_id"
|
|
],
|
|
"title": "moviepilot_api",
|
|
"type": "object"
|
|
}
|