Skip to main content

PluginActionsResponse

Response containing available plugin actions for a scope

actions object[]required

Available actions grouped by plugin

  • Array [
  • actionTypestringrequired

    Action type (e.g., "metadata_search", "metadata_get")

    descriptionstring | nullnullable

    Description of the action

    iconstring | nullnullable

    Icon hint for UI (optional)

    labelstringrequired

    Human-readable label for the action

    libraryIdsstring<uuid>[]

    Library IDs this plugin applies to (empty means all libraries) Used by frontend to filter which plugins show up for each library

    pluginDisplayNamestringrequired

    Plugin display name

    pluginIdstring<uuid>required

    Plugin ID

    pluginNamestringrequired

    Plugin name

    searchUriTemplatestring | nullnullable

    URI template for searching on the plugin's website (from manifest)

  • ]
  • scopestringrequired

    The scope these actions are for

    PluginActionsResponse
    {
    "actions": [
    {
    "actionType": "string",
    "description": "string",
    "icon": "string",
    "label": "string",
    "libraryIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "pluginDisplayName": "string",
    "pluginId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "pluginName": "string",
    "searchUriTemplate": "string"
    }
    ],
    "scope": "string"
    }