Sign in
Workflows

Retrieve a workflow

Changed on

Retrieve a workflow details without ids, default values, etc.

get/workflows/{id}/share

Request

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

Path parameters

idstring uuid required

Response

descriptionstring nullable required

Workflow description

namestring nullable required

Workflow name

trigger'AssetCreate' | 'AssetMetadataExtraction' required

Plugin trigger type

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