Skip to main content

uploadAsset

This endpoint requires the asset.upload permission.

Query Parameters
key string
slug string
Header Parameters
x-immich-checksum string

sha1 checksum that can be used for duplicate detection before the file is uploaded

Request Body — REQUIRED

Asset Upload Information

assetData binary — REQUIRED
deviceAssetId string — REQUIRED
deviceId string — REQUIRED
duration string
fileCreatedAt date-time — REQUIRED
fileModifiedAt date-time — REQUIRED
filename string
isFavorite boolean
livePhotoVideoId uuid
metadata object[] — REQUIRED
key string — REQUIRED

Possible values: [mobile-app]

value object — REQUIRED
sidecarData binary
visibility string

Possible values: [archive, timeline, hidden, locked]

Responses
201
Schema — OPTIONAL
id string
status string

Possible values: [created, replaced, duplicate]