mirror-immich/open-api/typescript-sdk
github-actions 3254d31cd2 chore: version v2.7.3 2026-04-09 17:51:40 +00:00
..
src chore: version v2.7.3 2026-04-09 17:51:40 +00:00
.npmignore chore: publish sdk on release (#7895) 2024-03-12 12:01:12 -04:00
.nvmrc chore(deps): update node.js to v24.14.1 (#27412) 2026-03-31 12:46:38 +02:00
README.md feat(server): user preferences (#9736) 2024-05-28 09:16:53 +07:00
package.json chore: version v2.7.3 2026-04-09 17:51:40 +00:00
tsconfig.json chore(deps): update dependency typescript to v6 (#27577) 2026-04-07 17:15:55 +02: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 });