Sign in
Plugins

Retrieve workflow templates

Changed on

Retrieve workflow templates provided by installed plugins

get/plugins/templates

Request

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

Response

descriptionstring required

Template description

keystring required

Template key (unique across all templates)

titlestring required

Template title

trigger'AssetCreate' | 'AssetMetadataExtraction' required

Plugin trigger type

uiHintsstring[] required

Ui hints, for example "smart-album"

Changes

  • f5e391d20316Revision changes
    • info

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

  • 6036291e3d41Revision changes
    • warning

      added the new AssetMetadataExtraction enum value to the / response property for the response status