API Reference & Playground

curl -X POST http://localhost:8080/api/jobs \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_key" \         # omit if auth disabled
  -d '{
    "topic": "Impact of quantum computing on cryptography",
    "subject": "Computer Science",
    "level": "Masters",
    "style": "IEEE",
    "pages": 10
  }'

# Response (202 Accepted)
{
  "job_id": "a1b2c3d4",
  "stream_url": "/api/jobs/a1b2c3d4/stream",
  "status_url": "/api/jobs/a1b2c3d4"
}

curl http://localhost:8080/api/jobs \
  -H "X-API-Key: your_key"

# Returns array of JobListItem sorted by created_at desc

curl http://localhost:8080/api/jobs/a1b2c3d4

// JavaScript
const es = new EventSource("/api/jobs/a1b2c3d4/stream");

es.addEventListener("log", e => {
  const data = JSON.parse(e.data);
  console.log(data.message, data.level);
});

es.addEventListener("progress", e => {
  const { stage, state, pct } = JSON.parse(e.data);
});

es.addEventListener("done", e => {
  const { pdf_url, docx_url, doc_url, elapsed } = JSON.parse(e.data);
});

es.addEventListener("stream_end", () => es.close());

curl -O http://localhost:8080/api/jobs/a1b2c3d4/pdf
curl -O http://localhost:8080/api/jobs/a1b2c3d4/docx
curl -O http://localhost:8080/api/jobs/a1b2c3d4/doc

curl -X DELETE http://localhost:8080/api/jobs/a1b2c3d4

curl http://localhost:8080/health

{
  "status": "ok",
  "version": "2.0.0",
  "workers_busy": 1,
  "workers_total": 3,
  "jobs_total": 12,
  "jobs_running": 1
}