Struct ImmichClient 

pub struct ImmichClient { /* private fields */ }

Client for interacting with the Immich REST API.

Handles authentication via API key and provides typed methods for API endpoints.

Example

use immich_lib::ImmichClient;

let client = ImmichClient::new("https://immich.example.com", "your-api-key")?;
let duplicates = client.get_duplicates().await?;
println!("Found {} duplicate groups", duplicates.len());

Implementations

impl ImmichClient

pub fn new(base_url: &str, api_key: &str) -> Result<Self>

Creates a new ImmichClient with the given base URL and API key.

Arguments

• base_url - The base URL of the Immich server (e.g., https://immich.example.com)
• api_key - The API key for authentication (created in Immich web UI)

Errors

Returns an error if:

• The base_url is not a valid URL
• The api_key is empty or contains invalid characters
• The HTTP client cannot be built

pub async fn get_duplicates(&self) -> Result<Vec<DuplicateGroup>>

Fetches all duplicate groups from the Immich server.

Returns

A vector of duplicate groups, each containing assets that Immich has identified as duplicates. Returns an empty vector if no duplicates exist.

Errors

Returns an error if:

• The HTTP request fails (network error, timeout)
• The server returns an error response (401 unauthorized, etc.)
• The response cannot be parsed as JSON

pub async fn get_all_assets(&self) -> Result<Vec<AssetResponse>>

Fetches all assets from the Immich server.

Uses pagination to handle large libraries. Automatically filters out trashed assets.

Returns

A vector of all non-trashed assets in the library.

Errors

Returns an error if:

• The HTTP request fails (network error, timeout)
• The server returns an error response (401 unauthorized, etc.)
• The response cannot be parsed as JSON

pub async fn get_asset(&self, asset_id: &str) -> Result<AssetResponse>

Fetches a single asset by ID.

Arguments

• asset_id - The ID of the asset to fetch

Returns

The asset with its EXIF metadata.

Errors

Returns an error if:

• The HTTP request fails (network error, timeout)
• The server returns an error response (401 unauthorized, 404 not found)
• The response cannot be parsed as JSON

pub async fn download_asset(&self, asset_id: &str, path: &Path) -> Result<u64>

Downloads an asset’s original file to the specified path.

Uses streaming to avoid buffering the entire file in memory, making it suitable for large files.

Arguments

• asset_id - The ID of the asset to download
• path - The destination path to save the file

Returns

The total number of bytes written to the file.

Errors

Returns an error if:

• The HTTP request fails
• The server returns an error response
• The file cannot be created or written to

pub async fn delete_assets( &self, asset_ids: &[String], force: bool, ) -> Result<()>

Deletes multiple assets in a single API call.

Arguments

• asset_ids - The IDs of the assets to delete
• force - If true, permanently delete; if false, move to trash

Errors

Returns an error if:

• The HTTP request fails
• The server returns an error response

pub async fn update_asset_metadata( &self, asset_id: &str, latitude: Option<f64>, longitude: Option<f64>, date_time_original: Option<&str>, description: Option<&str>, ) -> Result<()>

Updates an asset’s metadata fields.

This method allows updating GPS coordinates, date/time, and description for an asset. Only non-None fields will be sent in the update request.

Arguments

• asset_id - The ID of the asset to update
• latitude - New GPS latitude (optional)
• longitude - New GPS longitude (optional)
• date_time_original - New original date/time as ISO 8601 string (optional)
• description - New description (optional)

Errors

Returns an error if:

• The HTTP request fails
• The server returns an error response

pub async fn upload_asset(&self, file_path: &Path) -> Result<UploadResponse>

Uploads a file to Immich as a new asset.

Arguments

• file_path - Path to the file to upload

Returns

Information about the uploaded asset including its new ID.

Errors

Returns an error if:

• The file cannot be read
• The HTTP request fails
• The server returns an error response

Trait Implementations

impl Clone for ImmichClient

fn clone(&self) -> ImmichClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImmichClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.