Swagger API Documentation

Our interactive API documentation, publicly available at docs.photoprism.dev, is automatically generated from the source code annotations in the /internal/api package.

Running the following command in your local development environment will update the /internal/api/swagger.json file, which contains the API endpoint documentation in machine-readable form:

make swag

You can view it as HTML by navigating to /api/v1/docs/index.html after you have rebuilt and started photoprism with the commands make build and ./photoprism start:

Any help with adding annotations to improve our documentation is much appreciated!

The /api/v1/docs API documentation endpoint is disabled in production builds.