Renders

Document generation: /render.

Functions

context(_: Raise<KarboneError>)
abstract suspend fun convert(document: TemplateSource.Content, to: OutputFormat, options: RenderOptions = RenderOptions.None): RenderedDocument

Pure format conversion through POST /render/template: no templating, tags are left untouched.

context(_: Raise<KarboneError>)
abstract suspend fun download(id: RenderId): RenderedDocument

GET /render/{renderId}. No authentication. On the cloud the file is kept one hour and served once.

context(_: Raise<KarboneError>)
abstract suspend fun render(template: TemplateSource, data: RenderData, options: RenderOptions = RenderOptions.None): RenderedDocument

Synchronous, one round-trip: POST /render/{id}?download=true.

Same as render but RenderOptions are built inline through configure.

context(_: Raise<KarboneError>)
abstract suspend fun start(template: TemplateSource, data: RenderData, options: RenderOptions = RenderOptions.None): RenderId

Two-step flow: POST /render/{id} returning a RenderId to pass to download.

context(_: Raise<KarboneError>)
abstract suspend fun startAsync(template: TemplateSource, data: RenderData, webhook: Webhook, options: RenderOptions = RenderOptions.None): AsyncRenderAccepted

Asynchronous render: Carbone calls webhook with {success, data: {renderId}} when done. Required for batch.