Skip to main content

System & Task Queue API

Backs the Monitor page and operational tooling.

System — prefix /api/v1/system

MethodPathDescription
GET/healthBackend health check
POST/restartRestart the backend process
GET/gpu-listAll discovered GPUs with static info
GET/gpu-metricsMetrics for one GPU (?gpu_id=)
GET/gpu-metrics/allMetrics for every GPU
GET/gpu-infoDetailed GPU device info
GET/gpu-processesProcesses currently holding GPU memory
GET/metricsHost CPU/memory snapshot
GET/disk-usageDisk usage for the data volumes
GET/disk-rates / /network-ratesI/O rates
GET/allEverything above in one call (what the Monitor page fetches on load)
GET/resource-estimateEstimate resources for a prospective job config

Live metrics stream over the system/* WebSocket channels every 2 seconds — the REST endpoints are the polling fallback and scripting interface. See the WebSocket reference.

Task queue — prefix /api/v1/task-queue

The persistent record of background jobs, powering the Monitor page's Active Operations and Failed Operations sections.

MethodPathDescription
GET``List task records (paginated)
GET/activeCurrently running/queued tasks
GET/failedFailed tasks with error details
GET/{id}One task record
POST/{id}/retryRetry a failed task
DELETE/{id}Delete a task record (204)

Workers — prefix /api/v1/workers

Celery introspection:

MethodPathDescription
GET/queuesQueue depths
GET/activeTasks currently executing on workers
GET/statsWorker statistics
GET/healthWorker connectivity health

Version — GET /api/v1/version

Returns the running application version.