REST API Overview
SpiceBook exposes a REST API for programmatic access to notebooks, simulation, and rendering. All endpoints accept and return JSON unless noted otherwise.
Base URL
Section titled “Base URL”https://spicebook.warehack.ing/apiAll endpoint paths below are relative to this base.
Authentication
Section titled “Authentication”None. The API is open — no API keys or tokens are required. This makes it straightforward to integrate with scripts, CI pipelines, or AI assistants like mcltspice.
Response Format
Section titled “Response Format”Successful responses return JSON with the appropriate HTTP status code (200, 201, or 204). Error responses include a detail message:
{ "detail": "Notebook not found"}Common status codes:
| Code | Meaning |
|---|---|
200 | Success |
201 | Created (new notebook or cell) |
204 | Deleted (no response body) |
404 | Resource not found |
422 | Validation error (malformed request body) |
500 | Internal server error (simulation crash, etc.) |
Health Check
Section titled “Health Check”GET /healthReturns the API version and status:
{"status": "ok", "version": "2026.02.13"}Endpoint Groups
Section titled “Endpoint Groups” Notebooks Create, read, update, delete, and compose notebooks.
Cells Add, update, delete, and reorder cells within notebooks.
Simulation Run SPICE netlists standalone or within notebook cells.
Waveforms & Schematics Generate SVG plots and circuit diagrams.