Download Api Wrapped
immichpy.client.wrapper.download_api_wrapped.DownloadApiWrapped
DownloadApiWrapped(api_client=None)
Bases: DownloadApi
Wrapper for the DownloadApi that provides convenience methods.
Source code in immichpy/client/generated/api/download_api.py
32 33 34 35 | |
download_archive_to_file
async
download_archive_to_file(download_info: DownloadInfoDto, out_dir: Path, key: StrictStr | None = None, slug: StrictStr | None = None, show_progress: bool = False, **kwargs: Any) -> list[Path]
Download one or more asset archives and save them to ZIP files.
Note: This method intentionally downloads archives sequentially (not in parallel) by default. Immich has to build ZIP archives server-side; parallelizing many archive requests can put significant CPU/disk load on the Immich server and may lead to timeouts or degraded performance for other users. If you choose to parallelize, keep concurrency low and do so at your own risk.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
download_info
|
DownloadInfoDto
|
The download info (two-step flow; downloads all archives returned by |
required |
out_dir
|
Path
|
The directory to write the ZIP archive to. |
required |
key
|
StrictStr | None
|
Public share key (the last path segment of a public share URL, i.e. |
None
|
slug
|
StrictStr | None
|
Public share slug for custom share URLs (the last path segment of |
None
|
show_progress
|
bool
|
Whether to show progress bars (per-archive bytes + overall archive count). |
False
|
kwargs
|
Any
|
Additional arguments to pass to the underlying SDK calls. |
{}
|
Returns:
| Type | Description |
|---|---|
list[Path]
|
The list of paths to the downloaded archives. For exact request/response behavior, inspect |
Source code in immichpy/client/wrapper/download_api_wrapped.py
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | |