Skip to content

OxyKit.Render ​

Document render engine: an HTTP sidecar that turns JSON into PDF, XLSX, CSV, or HTML.

License: MIT · Client: OxyKit.Render.Client (never Core) · Releases: app zips

Why a sidecar ​

Render stays process-isolated. Flow (and other callers) talk HTTP via the Client. Exotic engines can sit beside this one without embedding generators in the orchestrator.

Quick start ​

bash
dotnet run --project src/OxyKit.Render.Api
# http://localhost:5066

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

ItemValue
Base URLhttp://localhost:5066
Dev API keyX-OxyKit-Render-Key: dev-local-key
HealthGET /health (anonymous)
OpenAPI/scalar, /openapi/v1.json (Development)

In this chapter ​

Design boundaries ​

  • No tenancy or billing in Core
  • Template data is untrusted (schema + escape)
  • Auth errors and render errors use { "error": "..." }

Render · Mail · Flow