REST API & Automation
Comprehensive REST API documentation, Axum backend endpoints, and SvelteKit routes.
Preview Content
Please note that the details on this page are pre-content drafts. More detailed technical specifications, architectural breakdowns, and updated guides will be added soon.
Core REST Endpoints
Axum ML Inference Endpoints (http://localhost:8123)
| Method & Route | Description |
|---|---|
GET /health | Server status, version, accelerator, and active providers |
GET /system/hardware | Hardware telemetry, VRAM usage, and model reload state |
POST /system/device | Switch active provider ("auto", "directml", "cuda", "coreml", "cpu") |
GET /system/telemetry | Active and queued OCR jobs, CPU & host RAM stats |
POST /pages/analyze | Multipart image upload -> detection, OCR, text regions |
POST /pages/clean | Multipart image + regions JSON -> LaMa neural inpainting |
POST /pages/preprocess | Normalize and optimize page image bytes |
POST /pages/stitch | Vertical two-panel canvas stitching |
POST /pages/reslice | Multi-image webtoon smart gutter slicing |
GET /pages/reslice/status | Real-time percentage polling for smart reslice |
POST /pages/reslice/cancel | Cancel ongoing smart reslice job |
POST /pages/reslice/reset | Reset smart reslice worker state and initialize run ID |
SvelteKit Web & Library Endpoints (http://localhost:8124/api)
| Method & Route | Description |
|---|---|
GET /api/books | List all books with chapter counts and telemetry |
POST /api/books | Create a new book series in the library |
GET /api/books/:id | Get book metadata, chapter index, and preferences |
POST /api/books/:id/chapters | Create a new chapter under a book |
GET /api/chapters/:id | Get chapter pages, status, and translated regions |
POST /api/chapters/:id/pages | Upload raw page images (multipart/form-data) |
POST /api/chapters/:id/translate | Trigger translation pipeline for a chapter |
GET /api/chapters/:id/translate | Real-time SSE progress event stream |
DELETE /api/chapters/:id/translate | Cancel running chapter translation job |
POST /api/translate-text | Direct LLM text translation with dynamic dialogue memory |
GET /api/system/hardware | Query active GPU, VRAM limits, and hardware capabilities |
POST /api/system/hardware | Set hardware provider and VRAM ceiling |
GET /api/glossary | Fetch compiled system preset themes and custom terms |
POST /api/glossary | Insert or update custom glossary entries |
GET /api/pages/:id/file?kind=output | Retrieve rendered page image (output, cleaned, original, thumb) |
GET /api/mihon/* | Mihon / Tachiyomi source protocol endpoints |