Plugin API

APIs to list and execute Plugins.

🔑 List available plugins

get

List all plugins of the given type.

Authorizations

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Path parameters

typestring · enumRequired

Type of plugins you want to list. You can use "all" to get all types at once.

Possible values:

Responses

200

Array of plugins

application/json

Metadata payload for a LRR Plugin.

authorstringOptional

Author of the plugin

descriptionstringOptional

Description of the plugin

namestringOptional

Name of the plugin

iconstringOptional

Base64 image of the plugin icon

typestring · enumOptional

Type of the plugin

Possible values:

namespacestringOptional

Unique namespace for the plugin

versionstringOptional

Version of the plugin

oneshot_argstring · nullableOptional

Description of the manual one-shot argument users can fill in for manual plugin calls

url_regexstring · nullableOptional

For downloader plugins, regex where it should be used

login_fromstring · nullableOptional

Namespace of the login plugin this plugin depends on

get/plugins/{type}

GET /api/plugins/{type} HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

200

Array of plugins

[
  {
    "author": "Difegue",
    "description": "Searches chaika.moe for tags matching your archive.",
    "icon": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAAUCAYAAACNiR0NAAAACXBIWXMAAAsTAAALEwEAmpwYAAAA\\nB3RJTUUH4wYCFQocjU4r+QAAAB1pVFh0Q29tbWVudAAAAAAAQ3JlYXRlZCB3aXRoIEdJTVBkLmUH\\nAAAEZElEQVQ4y42T3WtTdxzGn/M7J+fk5SRpTk7TxMZkXU84tTbVNrUT3YxO7HA4pdtQZDe7cgx2\\ns8vBRvEPsOwFYTDYGJUpbDI2wV04cGXCGFLonIu1L2ptmtrmxeb1JDkvv121ZKVze66f74eH7/f5\\nMmjRwMCAwrt4/9KDpflMJpPHvyiR2DPcJklJ3TRDDa0xk36cvrm8vDwHAAwAqKrqjjwXecPG205w\\nHBuqa9rk77/d/qJYLD7cCht5deQIIczbgiAEKLVAKXWUiqVV06Tf35q8dYVJJBJem2A7Kwi2nQzD\\nZig1CG93+PO5/KN6tf5NKpVqbsBUVVVFUUxwHJc1TXNBoxojS7IbhrnLMMx9pVJlBqFQKBKPxwcB\\nkJYgjKIo3QCE1nSKoghbfJuKRqN2RVXexMaQzWaLezyeEUEQDjscjk78PxFFUYRkMsltJgGA3t7e\\nyMLCwie6rr8iCILVbDbvMgwzYRjGxe0o4XC4s1AoHPP5fMP5/NNOyzLKAO6Ew+HrDADBbre/Ryk9\\nnzx81FXJNlEpVpF+OqtpWu2MpmnXWmH9/f2umZmZi4cOHXnLbILLzOchhz1YerJAs9m1GwRAg2GY\\nh7GYah488BJYzYW+2BD61AFBlmX/1nSNRqN9//792ujoaIPVRMjOKHoie3DytVGmp2fXCAEAjuMm\\nu7u7Umosho6gjL/u/QHeEgvJZHJ2K/D+/fuL4+PjXyvPd5ldkShy1UXcmb4DnjgQj/fd5gDA6/XS\\nYCAwTwh9oT3QzrS1+VDVi+vd3Tsy26yQVoFF3dAXJVmK96p9EJ0iLNOwKKU3CQCk0+lSOpP5WLDz\\nF9Q9kZqyO0SloOs6gMfbHSU5NLRiUOuax2/HyZPHEOsLw2SbP83eu/fLxrkNp9P554XxCzVa16MC\\n7+BPnTk9cfmH74KJE8nmga7Xy5JkZ8VKifGIHpoBb1VX8hNTd3/t/7lQ3OeXfFPvf/jBRw8ezD/a\\n7M/aWq91cGgnJaZ2VcgSdnV1XRNNd3vAoBVVYusmnEQS65hfgSG6c+zy3Kre7nF/KrukcMW0Zg8O\\nD08DoJutDxxOEb5IPUymwrq8ft1gLKfkFojkkRxemERCAQUACPFWRazYLJcrFGwQhyufbQQ7rFpy\\nLMkCwGZC34qPIuwp+XPOjBFwazQ/txrdFS2GGS/Xuj+pUKLGk1Kjvlded3s72lyGW+PLbGVcmrAA\\ngN0wTk1NWYODg9XOKltGtpazi5GigzroUnHN5nUHG1ylRsG7rDXHmnEpu4CeEtEKkqNc6QqlLc/M\\n8uT5lLH5eq0aGxsju1O7GQB498a5s/0x9dRALPaQEDZnYwnhWJtMCCNrjeb0UP34Z6e/PW22zjPP\\n+vwXBwfPvbw38XnXjk7GsiwKAIQQhjAMMrlsam45d+zLH6/8o6vkWcBcrXbVKQhf6bpucCwLjmUB\\nSmmhXC419eblrbD/TAgAkUjE987xE0c7ZDmk66ajUCnq+cL63fErl25s5/8baQPaWLhx6goAAAAA\\nSUVORK5CYII=",
    "name": "Chaika.moe",
    "namespace": "trabant",
    "oneshot_arg": "Chaika Gallery or Archive URL (Will attach matching tags to your archive)",
    "type": "metadata",
    "version": 2.1,
    "parameters": [
      {
        "desc": "ipb_pass_hash cookie",
        "type": "string"
      },
      {
        "default_value": 0,
        "desc": "Force resampled archive download",
        "name": "forceresampled",
        "type": "bool"
      }
    ]
  }
]

🔑 Use a Plugin

post

Uses a Plugin and returns the result. If using a metadata plugin, the matching archive will not be modified in the database. See more info on Plugins in the matching section of the Docs.

Authorizations

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Query parameters

idstring · min: 40 · max: 40Optional

ID of the archive to use the Plugin on. This is only mandatory for metadata plugins.

pluginstringOptional

Namespace of the plugin to use.

argstringOptional

Optional One-Shot argument to use when executing this Plugin.

Responses

200

Plugin result

application/json

operationstring · enumOptionalPossible values:

typestring · enumOptional

Plugin type. Omitted when the plugin is not found.

Possible values:

successinteger · enumOptional

Whether the Plugin run succeeded or not.

Possible values:

errorstring · nullableOptional

dataobjectOptional

Arbitrary data returned by the Plugin.

post/plugins/use

POST /api/plugins/use HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

200

Plugin result

{
  "operation": "use_plugin",
  "success": 1,
  "type": "metadata",
  "data": {
    "new_tags": "pages:45"
  }
}

🔑 Use a Plugin Asynchronously

post

Uses a Plugin and returns a Minion Job ID matching the Plugin run. This endpoint is useful if you want to run longer-lived plugins which might timeout if ran with the standard endpoint.

Authorizations

AuthorizationstringRequired

Use Authorization: Bearer <base64(api_key)>

Query parameters

idstring · min: 40 · max: 40Optional

ID of the archive to use the Plugin on. This is only mandatory for metadata plugins.

priorityintegerOptional

Priority of the Minion job. The higher the number, the more important the job is.

Default: 0

pluginstringOptional

Namespace of the plugin to use.

argstringOptional

Optional One-Shot argument to use when executing this Plugin.

Responses

200

Enqueued job

application/json

operationstring · enumOptionalPossible values:

successinteger · enumOptionalPossible values:

jobintegerOptional

ID of the created Minion job

post/plugins/queue

POST /api/plugins/queue HTTP/1.1
Host: lrr.tvc-16.science
Authorization: YOUR_API_KEY
Accept: */*

200

Enqueued job

{
  "job": 86,
  "operation": "queue_plugin_exec",
  "success": 1
}