immich/open-api/typescript-sdk
Alex f5df5fa98d
chore: change workflow column name (#24349)
chore-change-workflow-column-name
2025-12-02 14:40:17 +07:00
..
src chore: change workflow column name (#24349) 2025-12-02 14:40:17 +07:00
.npmignore chore: publish sdk on release (#7895) 2024-03-12 12:01:12 +07:00
.nvmrc chore(deps): update node.js to v24.11.1 (#24147) 2025-11-25 11:55:36 +07:00
README.md feat(server): user preferences (#9736) 2024-05-28 09:16:53 +07:00
package.json chore(deps): update node to v24 (major) (#24169) 2025-11-25 15:40:48 +07:00
tsconfig.json chore: publish sdk on release (#7895) 2024-03-12 12:01:12 +07: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 });