immich-app/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2026-02-25 03:12:21 +03:00
Code Issues 783 Packages Projects Releases 12 Wiki Activity

[Tech-Debt] Restify Asset Endpoints #634

New Issue
Closed
opened 2026-02-04 21:36:04 +03:00 by OVERLORD · 2 comments
OVERLORD commented 2026-02-04 21:36:04 +03:00
Owner
Copy Link

Originally created by @jrasm91 on GitHub (Jan 30, 2023).

We should simplify (and restify) the set of API endpoints related to assets.

All endpoints will return a new header, indicating total item count, which can be used for display totals. A HEAD to the endpoint will return the header without the items.

Search:

  • GET /search/<metadata|smart> - get a list of assets with search/sort filters, including isFavorite, created before/after/on, albumId, etc.

Single:

  • POST /: - create an asset (with file upload)
  • GET /:id - get asset

Multiple:

  • POST /download/archive - download a list of asset by ids (as an archive)
  • POST /check - check a list of asset metadata to determine which ones to upload
  • PUT / -update multiple assets by ids
  • DELETE / -delete multiple assets by ids

Serve:

  • GET /media/thumb?assetId=<id> - get thumbnail
  • GET /media/original?assetId=<id> - get thumbnail
  • GET /media/resize?assetId=<id> - get dynamic/resized version

Remove:

  • GET /download/:id
  • GET /download-library
  • GET /:deviceId
  • GET /count-by-time-bucket
  • GET /count-by-user-id
  • POST /check
  • POST /exist
  • POST /shared-link (move to /shared)
  • PATCH /shared-link (move to /shared)
  • GET /assetById/:assetId (renamed)
  • GET /curated-objects
  • GET /curated-locations
  • GET /search-terms
  • POST /search
Originally created by @jrasm91 on GitHub (Jan 30, 2023). We should simplify (and restify) the set of API endpoints related to assets. All endpoints will return a new header, indicating total item count, which can be used for display totals. A `HEAD` to the endpoint will return the header without the items. Search: - [x] `GET` `/search/<metadata|smart>` - get a list of assets with search/sort filters, including `isFavorite`, created before/after/on, albumId, etc. Single: - [x] `POST` `/`: - create an asset (with file upload) - [x] `GET` `/:id` - get asset Multiple: - [x] `POST` `/download/archive` - download a list of asset by ids (as an archive) - [ ] `POST` `/check` - check a list of asset metadata to determine which ones to upload - [x] `PUT` `/` -update multiple assets by ids - [x] `DELETE` `/` -delete multiple assets by ids Serve: - [ ] `GET` `/media/thumb?assetId=<id>` - get thumbnail - [ ] `GET` `/media/original?assetId=<id>` - get thumbnail - [ ] `GET` `/media/resize?assetId=<id>` - get dynamic/resized version Remove: - [x] `GET` `/download/:id` - [x] `GET` `/download-library` - [ ] `GET` `/:deviceId` - [x] `GET` `/count-by-time-bucket` - [x] `GET` `/count-by-user-id` - [ ] `POST` `/check` - [ ] `POST` `/exist` - [x] `POST` `/shared-link` (move to `/shared`) - [x] `PATCH` `/shared-link` (move to `/shared`) - [x] `GET` `/assetById/:assetId` (renamed) - [x] `GET` `/curated-objects` - [x] `GET` `/curated-locations` - [x] `GET` `/search-terms` - [x] `POST` `/search`
OVERLORD added the 🗄️servertech-debt labels 2026-02-04 21:36:04 +03:00
OVERLORD commented 2026-02-04 21:36:20 +03:00
Author
Owner
Copy Link

@agross commented on GitHub (Mar 11, 2024):

Will there be at some point a new version of immich-sdk to reflect these changes for projects using Immich's API? @alextran1502 Context: https://github.com/agross/immich-duplicates/issues/16#issuecomment-1989279506

@agross commented on GitHub (Mar 11, 2024): Will there be at some point a new version of `immich-sdk` to reflect these changes for projects using Immich's API? @alextran1502 Context: https://github.com/agross/immich-duplicates/issues/16#issuecomment-1989279506
OVERLORD commented 2026-02-04 21:36:26 +03:00
Author
Owner
Copy Link

@jrasm91 commented on GitHub (Jul 2, 2024):

I believe all of the asset endpoints are basically fixed, so closing. (at least CRUD seems to be done)

@jrasm91 commented on GitHub (Jul 2, 2024): I believe all of the asset endpoints are basically fixed, so closing. (at least CRUD seems to be done)
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
accessibility
changelog:enhancement
changelog:security
changelog:skip
changelog:translation
cli
date-time
dependencies
documentation
external-library
format
good first issue
mobile-beta
mobile-beta
mobile-beta
needs-answer
nice to have
pull-request
Mirrored from GitHub Pull Request
 sharing
tech-debt
📱mobile
🖥️web
🗄️server
🧠machine-learning
No Label tech-debt 🗄️server
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
OVERLORD
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: immich-app/immich#634
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?