Skip to content

REST API

Routes and parameters can be found in our API docs:

https://godoc.org/github.com/photoprism/photoprism/internal/api

Examples

Basic

GET /api/v1/photos?count=10
Note: Routes are going to change while we are developing the frontend. The API is not covered by a deprecation policy.

With authentication

PhotoPrism uses X-Session-ID HTTP header as authentication method:

curl -H "X-Session-ID: xyz" http://localhost:2342/api/v1/photos?count=10
Replace xyz by session_id value of your active browser session, which can be found inside local storage.