API Script Examples

[markeeisner]

I relatively recently switched to immich from photoprism. I have a custom made digital photo frame running from a raspberry pi and previously manually added photos to a nextcloud folder and used rclone to sync this folder to the pi to update photos.

After moving to immich I wanted to make use of the api to have a "Photoframe" album in immich and have the photos pulled. This would make the process feasible for my wife to manage the photoframe contents with no input from me and without the manual process of populating the nextcloud folder.

I have some basic coding knowledge but most of my experience is from 10 years ago so I was hoping to find some easily adaptable api examples to be able to cobble things together. In the end I couldn't find anything very helpful and nothing immich specific outside of the api documentation.

I've managed to cobble something together in python that works for me, I tried to keep it simple and efficient and easily sharable. With an api key in a file alongside the script, the instance url, album name and destination folder it will download and delete photos from the destination folder only when there are changes.

I wanted to share the script so wondered if there is already a store of these kinds of example scripts for users to take and adapt that I could contribute to? If not what would be the prefered way of sharing this sort of thing?

Some possible options:

• Folder in the repo with scripts and documentation
• Seperate repo with scripts and documentation
• Curated list of scripts in the main repo with links to script authors repos

[mmomjian]

How long is the script? Could it be posted as a guide?

[markeeisner]

65 lines including whitespace so the script and an explaination would probably be well suited to a guide. I'll take a stab at writing it up.

[soana]

I'm trying to learn some of this, can you point me to some examples or a place to start?

[markeeisner]

Sorry, looks like the download endpoint is different too. I'll get back to you again when it's actually working!

[markeeisner]

@LuucE

Ok, sorted now. Try again with the latest script and let me know if you have any issues.

[LuucE]

Thanks @markeeisner for your quick fix. Now it works as designed.

I wonder if it's possible to use the script for more than one album, maybe all albums?

Regards, Luuc.

[markeeisner]

Hey @LuucE

It wouldn't be that hard to modify the script for multiple or all albums. Possibly an extra config option or 2 then looping through the album ids to add all the asset references to the main array.

I don't have time to make the modification immediately but I can plan to do it in the next few months.

[LuucE]

Hi @markeeisner that would be a nice feature. I can use it to collect all pictures from all albums in Immich, despite who has added them. No problem to wait a few months.

Regards, Luuc.