Sign in
Download

Retrieve download information

Changed on

Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.

post/download/info

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/download/info
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Query parameters

keystring
slugstring

Request body

albumIdstring uuid

Album ID to download

archiveSizeinteger

Archive size limit in bytes

assetIdsstring[]

Asset IDs to download

userIdstring uuid

User ID to download assets from

Response

totalSizeinteger required

Total size in bytes

Changes

  • 2cd7bd44a940Revision changes
    • info

      the /// response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status