Sign in
Sync

Stream sync changes

Changed on

Retrieve a JSON lines streamed response of changes for synchronization. This endpoint is used by the mobile app to efficiently stay up to date with changes.

post/sync/stream

Request

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

Request body

resetboolean

Reset sync state

typesSyncRequestType[] required

Sync request types

Changes

  • 3903d67f6b1cRevision changes
    • info

      added the new AssetOcrV1 enum value to the request property /

  • 56523954a19eRevision changes
    • info

      added the new AlbumAssetsV2 enum value to the request property /

    • info

      added the new AssetsV2 enum value to the request property /

    • info

      added the new PartnerAssetsV2 enum value to the request property /