Skip to content

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 updates /internal/api/swagger.json, which contains the machine-readable API description:

make fmt-go swag-fmt swag

In local debug builds, you can also browse the embedded Swagger UI at /api/v1/docs and fetch the generated JSON from /api/v1/swagger.json after rebuilding and starting photoprism:

swagger-docs

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

The /api/v1/docs and /api/v1/swagger.json endpoints are only available in debug builds and are disabled in production builds.