Sign in
Plugins

Retrieve plugin methods

Changed on

Retrieve a list of plugin methods

get/plugins/methods

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/plugins/methods
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Query parameters

descriptionstring
enabledboolean

Whether the plugin method is enabled

idstring uuid

Plugin method ID

namestring
pluginNamestring

Plugin name

pluginVersionstring

Plugin version

titlestring
trigger'AssetCreate' | 'AssetMetadataExtraction'

Plugin trigger type

Workflow trigger

type'AssetV1'

Workflow type

Workflow types

Response

descriptionstring required

Description

hostFunctionsboolean required
keystring required

Key

namestring required

Name

schemaobject
titlestring required

Title

typesWorkflowType[] required

Workflow types

uiHintsstring[] required

Ui hints

Changes

  • f5e391d20316Revision changes
    • breaking

      removed the enum value AssetPersonV1 from the query request parameter type

    • breaking

      removed the enum value PersonRecognized from the query request parameter trigger

    • info

      removed the AssetPersonV1 enum value from the // response property for the response status

  • 6036291e3d41Revision changes
    • info

      added the new enum value AssetMetadataExtraction to the query request parameter trigger