-
Notifications
You must be signed in to change notification settings - Fork 6
API
Codex edited this page Jun 13, 2026
·
1 revision
The frontend uses the same REST API that scripts and third-party tools can use.
Swagger docs are available at /docs.
| Method | Endpoint | Purpose |
|---|---|---|
POST |
/api/v1/ingest/orca |
Upload a file from OrcaSlicer or curl |
GET |
/api/v1/models |
List and search models |
GET |
/api/v1/models/stats |
Read library counts and configured storage usage |
GET |
/api/v1/models/{id} |
Read one model with files and metadata |
PATCH |
/api/v1/models/{id} |
Update name, description, collection, tags |
GET |
/api/v1/models/export?format=json |
Export library metadata without raw file blobs |
GET |
/api/v1/models/trash |
List soft-deleted models |
POST |
/api/v1/models/{id}/print-jobs |
Manually log a print job for a model |
POST |
/api/v1/models/{id}/print-jobs/import-printer/{printer_id} |
Import matching Moonraker print history |
PATCH |
/api/v1/models/{id}/files/{file_id}/revision |
Update G-code revision status, notes, recommended marker |
GET |
/api/v1/files/{id}/download |
Download a stored file |
GET |
/api/v1/files/{id}/download-url |
Get a direct pre-signed S3 URL or local fallback |
GET |
/api/v1/files/{id}/stl |
Serve STL directly or convert 3MF/OBJ to cached STL for preview |
POST |
/api/v1/files/thumbnails/rebuild |
Queue thumbnail regeneration for existing mesh files |
GET |
/api/v1/printers |
List registered printers |
POST |
/api/v1/printers/{id}/send |
Send vault G-code to a printer |
GET |
/api/v1/printers/{id}/status |
Read printer status |
GET |
/api/v1/printers/{id}/diagnostics |
Check provider capabilities and connectivity |
WS |
/api/v1/printers/{id}/ws |
Live printer status stream |
GET |
/api/v1/auth/api-keys |
List current user's active API keys |
POST |
/api/v1/backups |
Create a full backup archive |
Auth-required endpoints need a bearer token or API key login flow.
curl -F "file=@my_print.gcode" \
-F "model_name=Desk Bracket" \
-F "category=Functional/Brackets" \
-H "Authorization: Bearer YOUR_LOGIN_TOKEN" \
http://localhost:8000/api/v1/ingest/orca