Skip to content

API Reference

vonhex edited this page Apr 24, 2026 · 1 revision

API Reference

The Eyeris backend provides a RESTful API. All endpoints (except login) require a JWT Bearer token.

Authentication

POST /auth/login

  • Body: {"username": "...", "password": "..."}
  • Returns: {"access_token": "...", "token_type": "bearer"}

Core Endpoints

  • GET /api/images: List media with advanced filtering.
  • GET /api/images/{id}: Detailed metadata for a single item.
  • GET /api/images/{id}/file: Streams the original file (supports Range requests for video).
  • GET /api/images/duplicates: Lists groups of visually similar images.
  • POST /api/scan/start: Triggers a library scan.

Detailed Documentation

For a full interactive Swagger UI, visit: http://<your-eyeris-ip>:8000/docs

Clone this wiki locally