# API Documentation

This is the index of all generated REST API documentation for Pinakes.

Documentation is generated from OpenAPI annotations via `cargo xtask docs` (or
`just docs`). Do not edit generated files by hand.

## Reference

- [openapi.json](api/openapi.json) - Full OpenAPI 3.0 specification

## Endpoints by Tag

- [Analytics](api/analytics.md) - Usage analytics and viewing history
- [Audit](api/audit.md) - Audit log entries
- [Auth](api/auth.md) - Authentication and session management
- [Backup](api/backup.md) - Database backup
- [Books](api/books.md) - Book metadata, series, authors, and reading progress
- [Collections](api/collections.md) - Media collections
- [Config](api/config.md) - Server configuration
- [Database](api/database.md) - Database administration
- [Duplicates](api/duplicates.md) - Duplicate media detection
- [Enrichment](api/enrichment.md) - External metadata enrichment
- [Export](api/export.md) - Media library export
- [Health](api/health.md) - Server health checks
- [Integrity](api/integrity.md) - Library integrity checks and repairs
- [Jobs](api/jobs.md) - Background job management
- [Media](api/media.md) - Media item management
- [Notes](api/notes.md) - Markdown notes link graph
- [Photos](api/photos.md) - Photo timeline and map view
- [Playlists](api/playlists.md) - Media playlists
- [Plugins](api/plugins.md) - Plugin management
- [Saved_searches](api/saved_searches.md) - Saved search queries
- [Scan](api/scan.md) - Directory scanning
- [Scheduled_tasks](api/scheduled_tasks.md) - Scheduled background tasks
- [Search](api/search.md) - Full-text media search
- [Shares](api/shares.md) - Media sharing and notifications
- [Social](api/social.md) - Ratings, comments, favorites, and share links
- [Statistics](api/statistics.md) - Library statistics
- [Streaming](api/streaming.md) - HLS and DASH adaptive streaming
- [Subtitles](api/subtitles.md) - Media subtitle management
- [Sync](api/sync.md) - Multi-device library synchronization
- [Tags](api/tags.md) - Media tag management
- [Transcode](api/transcode.md) - Video transcoding sessions
- [Upload](api/upload.md) - File upload and managed storage
- [Users](api/users.md) - User and library access management
- [Webhooks](api/webhooks.md) - Webhook configuration