Jobs & outputs
API surface (v1)
| Method | Path | Purpose |
|---|---|---|
POST | /api/v1/jobs | Create a job (optional Idempotency-Key) |
GET | /api/v1/jobs/{id} | Poll status / result |
Exact payloads: live OpenAPI in Development.
Optional on create: render.engine (default oxykit-render). Must match a configured engine under Render:Engines.
Outputs
| Output | Behavior |
|---|---|
file | Write rendered bytes to disk |
mail | HTTP send to OxyKit.Mail (sent / accepted / scheduled = success) |
ftp / sftp | Named profiles in Flow config |
Jobs are persisted (SQLite) and processed asynchronously. Configure Render (and Mail when using mail) before expecting completion — see Wiring.