Skip to content

Jobs & outputs ​

API surface (v1) ​

MethodPathPurpose
POST/api/v1/jobsCreate 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 ​

OutputBehavior
fileWrite rendered bytes to disk
mailHTTP send to OxyKit.Mail (sent / accepted / scheduled = success)
ftp / sftpNamed profiles in Flow config

Jobs are persisted (SQLite) and processed asynchronously. Configure Render (and Mail when using mail) before expecting completion — see Wiring.

Render · Mail · Flow