Skip to main content
GET
/
api
/
assets
/
{asset_id}
Get full metadata for a single asset by ID
curl --request GET \
  --url https://api.example.com/api/assets/{asset_id}
{
  "id": "<string>",
  "device_asset_id": "<string>",
  "device_id": "<string>",
  "mime_type": "<string>",
  "original_file_name": "<string>",
  "file_created_at": "2023-11-07T05:31:56Z",
  "file_modified_at": "2023-11-07T05:31:56Z",
  "local_datetime": "2023-11-07T05:31:56Z",
  "checksum": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "checksum_sha1": "<string>",
  "exif": {
    "asset_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "make": "<string>",
    "model": "<string>",
    "orientation": 123,
    "modified_datetime": "2023-11-07T05:31:56Z",
    "original_datetime": "2023-11-07T05:31:56Z",
    "digitized_datetime": "2023-11-07T05:31:56Z",
    "lens_model": "<string>",
    "f_number": 123,
    "focal_length": 123,
    "iso": 123,
    "exposure_time": 123,
    "exposure_bias": 123,
    "latitude": 123,
    "longitude": 123,
    "altitude": 123,
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "description": "<string>",
    "fps": 123,
    "live_photo_cid": "<string>",
    "projection_type": "<string>",
    "profile_description": "<string>",
    "auto_stack_id": "<string>",
    "rating": 123
  },
  "metadata": {
    "asset_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "make": "<string>",
    "model": "<string>",
    "orientation": 123,
    "modified_datetime": "2023-11-07T05:31:56Z",
    "original_datetime": "2023-11-07T05:31:56Z",
    "digitized_datetime": "2023-11-07T05:31:56Z",
    "lens_model": "<string>",
    "f_number": 123,
    "focal_length": 123,
    "iso": 123,
    "exposure_time": 123,
    "exposure_bias": 123,
    "latitude": 123,
    "longitude": 123,
    "altitude": 123,
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "country_code": "<string>",
    "sublocation": "<string>",
    "place_name": "<string>",
    "timezone": "<string>",
    "display_label": "<string>",
    "description": "<string>",
    "fps": 123,
    "live_photo_cid": "<string>",
    "projection_type": "<string>",
    "auto_stack_id": "<string>",
    "rating": 123
  },
  "metrics": {},
  "asset_urls": {},
  "description": "<string>",
  "faces": [
    {
      "id": "<string>",
      "asset_id": "<string>",
      "bounding_box": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "person_id": "<string>",
      "timestamp_ms": 123,
      "asset_urls": {}
    }
  ],
  "people": [
    {
      "id": "<string>",
      "is_hidden": true,
      "is_favorite": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "birth_date": "2023-12-25",
      "asset_count": 123,
      "thumbnail_face_id": "<string>",
      "asset_urls": {}
    }
  ],
  "width": 0,
  "height": 0,
  "file_size_bytes": 0,
  "trashed_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.gumnut.ai/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
asset_id
string
required

Asset ID (with asset_ prefix) to fetch. Obtain from list_assets, search_assets, or list_album_assets.

Response

Successful Response

Represents a photo or video asset with metadata and access URLs.

​
id
string
required

Unique asset identifier with 'asset_' prefix

​
device_asset_id
string
required

Original asset identifier from the device that uploaded this asset

​
device_id
string
required

Identifier of the device that uploaded this asset

​
mime_type
string
required

MIME type of the file (e.g., 'image/jpeg', 'video/mp4')

​
original_file_name
string
required

Original filename when the asset was uploaded

​
file_created_at
string<date-time>
required

When the file was created on the uploading device

​
file_modified_at
string<date-time>
required

When the file was last modified on the uploading device

​
local_datetime
string<date-time>
required

When the photo/video was taken, in the device's local timezone

​
checksum
string
required

Base64-encoded SHA-256 hash of the asset contents for duplicate detection and integrity

​
created_at
string<date-time>
required

When this asset record was created in the database

​
updated_at
string<date-time>
required

When this asset record was last updated

​
checksum_sha1
string | null

Base64-encoded SHA-1 hash for Immich client compatibility. May be null for older assets.

​
exif
ExifResponse · object

Deprecated alias for metadata. Preserved during the migration window so existing consumers continue to work; clients should prefer metadata.

​
metadata
MetadataResponse · object

Asset metadata — camera/EXIF fields, GPS, and location names. Replaces exif.

​
metrics
Metrics · object

ML-generated quality scores and other metrics

​
asset_urls
Asset Urls · object

Named asset variants: 'original', 'thumbnail', 'preview', 'fullsize' for images; 'original' only for videos

​
description
string | null

AI-generated description of the asset's content, quality, and composition. null means description generation has not yet run; empty string means the model refused to describe the asset. Distinct from exif.description (camera-embedded EXIF metadata).

​
faces
FaceResponse · object[]

All faces detected in this asset

​
people
PersonResponse · object[]

All unique people identified in this asset (deduplicated from faces)

​
width
integer
default:0

Width of the asset in pixels

​
height
integer
default:0

Height of the asset in pixels

​
file_size_bytes
integer
default:0

File size of the asset in bytes

​
trashed_at
string<date-time> | null

When this asset was moved to trash (ISO 8601, UTC). null for live assets. Trashed assets are excluded from default list/search results and are purged after the configured retention window.