pinakes/docs/api.md

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 - Full OpenAPI 3.0 specification

Endpoints by Tag

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