immich/packages/sdk
Alex Tran 18ec30c3b8 feat(workflow): add trigger for assets added to an album
Introduces the AlbumAssetAdded workflow trigger and a new AssetAlbumV1
workflow type that carries album context (id, owner, name, description)
alongside the asset, mirroring AssetPersonV1. A new AlbumAssetAdd event
is emitted from AlbumService when assets are added to an album (both
addAssets and addAssetsToAlbums), and WorkflowExecutionService queues
the workflow trigger with the album id so steps can act on a specific
album.
2026-06-02 20:30:31 +00:00
..
src feat(workflow): add trigger for assets added to an album 2026-06-02 20:30:31 +00:00
.npmignore chore: move sdk to packages (#28350) 2026-05-11 13:37:10 -04:00
package.json chore(deps): update dependency @types/node to ^24.12.4 (#28490) 2026-05-20 12:41:17 +02:00
README.md chore: move sdk to packages (#28350) 2026-05-11 13:37:10 -04:00
tsconfig.json chore: move sdk to packages (#28350) 2026-05-11 13:37:10 -04:00

@immich/sdk

A TypeScript SDK for interfacing with the Immich API.

Install

npm i --save @immich/sdk

Usage

For a more detailed example, check out the @immich/cli.

import { getAllAlbums, getMyUser, init } from "@immich/sdk";

const API_KEY = "<API_KEY>"; // process.env.IMMICH_API_KEY

init({ baseUrl: "https://demo.immich.app/api", apiKey: API_KEY });

const user = await getMyUser();
const albums = await getAllAlbums({});

console.log({ user, albums });