bybrooklyn
e50ca64e80
- P1: Fix cancel race in pipeline, fix VideoToolbox quality mapping - P2: SSRF protection, batch cancel N+1, archived filter fixes, metadata persistence, reverse proxy hardening, reprobe logging - TD: Remove AlchemistEvent legacy bridge, fix silent .ok() on DB writes, optimize sort-by-size query, split db.rs (3400 LOC) into 8 focused submodules under src/db/ - UX: Add queue position display for queued jobs - Docs: Update API docs, engine modes, library doctor, config ref - Plans: Add plans.md for remaining open items (UX-2/3, FG-4, RG-2) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
3.0 KiB
title, description
| title | description |
|---|---|
| API Reference | REST and SSE API reference for Alchemist. |
Authentication
All API routes require the alchemist_session auth cookie established via /api/auth/login, or an Authorization: Bearer <token> header.
Machine-readable contract: OpenAPI spec
POST /api/auth/login
Establish a session. Returns a Set-Cookie header.
Request:
{
"username": "admin",
"password": "..."
}
POST /api/auth/logout
Invalidate current session and clear cookie.
GET /api/settings/api-tokens
List metadata for configured API tokens.
POST /api/settings/api-tokens
Create a new API token. The plaintext value is only returned once.
Request:
{
"name": "Prometheus",
"access_level": "read_only"
}
DELETE /api/settings/api-tokens/:id
Revoke a token.
Jobs
GET /api/jobs
List jobs with filtering and pagination.
Params: limit, page, status, search, sort_by, sort_desc, archived.
GET /api/jobs/:id/details
Fetch full job state, metadata, logs, and stats.
POST /api/jobs/:id/cancel
Cancel a queued or active job.
POST /api/jobs/:id/restart
Restart a terminal job (failed/cancelled/completed).
POST /api/jobs/:id/priority
Update job priority.
Request: {"priority": 100}
POST /api/jobs/batch
Bulk action on multiple jobs.
Request:
{
"action": "restart|cancel|delete",
"ids": [1, 2, 3]
}
POST /api/jobs/restart-failed
Restart all failed or cancelled jobs.
POST /api/jobs/clear-completed
Archive all completed jobs from the active queue.
Engine
GET /api/engine/status
Get current operational status and limits.
POST /api/engine/pause
Pause the engine (suspend active jobs).
POST /api/engine/resume
Resume the engine.
POST /api/engine/drain
Enter drain mode (finish active jobs, don't start new ones).
POST /api/engine/mode
Switch engine mode or apply manual overrides.
Request:
{
"mode": "background|balanced|throughput",
"concurrent_jobs_override": 2,
"threads_override": 0
}
Statistics
GET /api/stats/aggregated
Total savings, job counts, and global efficiency.
GET /api/stats/daily
Encode activity history for the last 30 days.
GET /api/stats/savings
Detailed breakdown of storage savings.
System
GET /api/system/hardware
Detected hardware backend and codec support matrix.
GET /api/system/hardware/probe-log
Full logs from the startup hardware probe.
GET /api/system/resources
Live telemetry: CPU, Memory, GPU utilization, and uptime.
Events (SSE)
GET /api/events
Real-time event stream.
Emitted Events:
status: Job state changes.progress: Real-time encode statistics.decision: Skip/Transcode logic results.log: Engine and job logs.config_updated: Configuration hot-reload notification.scan_started/scan_completed: Library scan status.