immich-app/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2026-02-05 00:30:57 +03:00
Code Issues 13 Packages Projects Releases 10 Wiki Activity

[Feature]: Public API (with docs) #411

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

Originally created by @Andrew-71 on GitHub (Nov 11, 2022).

Feature detail

Hey! I was recently looking into making website for personal image sharing links with Immich acting as host, however had a problem with API, lack thereof to be precise. Technically, there is obviously an API (Since mobile app connects to it), and there are a bunch of files related to it in the repository, but there is no clear way to connect and use it as a user, and no docs to know what you can do with it.

Therefore, I would like to ask developers to add some kind of public API docs, which would let users create their own apps around Immich. I remember a developer mentioning that they have auto-generated swagger docs somewhere, maybe something like this would be useful. :D

Platform

Server

Originally created by @Andrew-71 on GitHub (Nov 11, 2022). ### Feature detail Hey! I was recently looking into making website for personal image sharing links with Immich acting as host, however had a problem with API, lack thereof to be precise. _Technically_, there is obviously an API (Since mobile app connects to it), and there are a bunch of files related to it in the repository, but there is no clear way to connect and use it as a user, and no docs to know what you can do with it. Therefore, I would like to ask developers to add some kind of public API docs, which would let users create their own apps around Immich. I remember a developer mentioning that they have auto-generated swagger docs somewhere, maybe something like this would be useful. :D ### Platform Server
OVERLORD commented 2026-02-04 20:19:47 +03:00
Author
Owner
Copy Link

@bo0tzz commented on GitHub (Nov 15, 2022):

Some generated api documentation is available on the server under /api/doc/, eg https://demo.immich.app/api/doc/.

@bo0tzz commented on GitHub (Nov 15, 2022): Some generated api documentation is available on the server under `/api/doc/`, eg https://demo.immich.app/api/doc/.
OVERLORD commented 2026-02-04 20:19:49 +03:00
Author
Owner
Copy Link

@jrasm91 commented on GitHub (Dec 7, 2022):

Also worth mentioning that the documentation is generated from the open-api spec JSON file in the server folder. Open API (swagger) is a format that can be displayed by a lot of different tools, so you should be able to use that to understand the API endpoints, their inputs and outputs.

I agree that it would be nice to integrate some auto generated documentation directly into the docs website.

@jrasm91 commented on GitHub (Dec 7, 2022): Also worth mentioning that the documentation is generated from the open-api spec JSON file in the server folder. Open API (swagger) is a format that can be displayed by a lot of different tools, so you should be able to use that to understand the API endpoints, their inputs and outputs. I agree that it would be nice to integrate some auto generated documentation directly into the docs website.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
accessibility
changelog:enhancement
changelog:security
changelog:translation
cli
date-time
documentation
external-library
format
good first issue
needs-answer
nice to have
sharing
tech-debt
📱mobile
🖥️web
🗄️server
🧠machine-learning
No Label
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#411
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?