mirror-immich/packages/sdk
Timon 1b451f3d07
Merge branch 'main' into feat/memories-view
2026-06-03 09:46:49 +02:00
..
src Merge branch 'main' into feat/memories-view 2026-06-03 09:46:49 +02:00
.npmignore chore: move sdk to packages (#28350) 2026-05-11 13:37:10 -04:00
README.md 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
tsconfig.json chore: move sdk to packages (#28350) 2026-05-11 13:37:10 -04:00

README.md

@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 });