OxyKit.Flow

Job orchestrator: accept render + deliver jobs, persist them (SQLite or PostgreSQL), process asynchronously via named render engines and output providers.

License: MIT · Uses: OxyKit.Render.Client · Releases: app zips (no Flow NuGet package)

Quick start

Start Render first (Local API or a Render release zip). Then:

dotnet run --project src/OxyKit.Flow/OxyKit.Flow.csproj
# http://localhost:5077

Or download a Flow release zip for your OS and run the host (needs the .NET 10 runtime).

Item	Value
Base URL	http://localhost:5077
Dev API key	X-OxyKit-Flow-Key: dev-flow-key
Create job	POST /api/v1/jobs (+ optional Idempotency-Key)
Poll	GET /api/v1/jobs/{id}
OpenAPI	/scalar, /openapi/v1.json (Development)

In this chapter

• Jobs & outputs
• Wiring Render & Mail
• Smoke & OpenAPI

Boundaries

Flow never embeds document generators. Default engine oxykit-render uses OxyKit.Render.Client only (never Core). Third-party engines plug in via OxyKit.Flow.Abstractions + Kind=assembly (no host fork) — see Wiring. Mail delivery is HTTP, not Mail.Client. Delivery outputs: file, mail, or named FTP/SFTP profiles. Host style matches Mail (FastEndpoints + ErrorOr).