Skip to content
rusticdoc
Search
Ctrl
K
Cancel
Product
What it does
How it works
A template and JSON in, a finished document out
Formats
The templates it reads and the files it writes
What it’s for
Invoices, reports and PDF forms
How you use it
Building blocks
Templates, conversion and PDF steps in one request
Ways to run it
One container, many replicas or the command line
Questions
What people ask before they start
Docs
Learn
Quickstart
Fill your first template in five minutes
Write templates
Tags, loops, conditions and filters
HTTP API
Every route, field and response
Run it
Docker, Kubernetes, sizing and logs
Project
Security
How it handles documents from strangers
Changelog
What each release contains
Known limits
What it doesn’t do
About
GitHub
Menu
Start here
Quickstart
Install
Concepts
Write templates
Template syntax
Conditions
Calculations
Filters
Rich content
Office formats
PDF templates
Translations and settings
Validate a template
Batch rendering
Use the API
The render pipeline
Convert documents
HTML to PDF
PDF operations
Stored templates
Fonts
Background jobs
Webhooks
Authentication
Run it
Docker
Many containers
Kubernetes
Sizing
Security
Observability
Reference
HTTP API
Overview
Render
Overview
Render a template
POST
Render a batch
POST
Validate a template
POST
Convert
Overview
Convert documents
POST
PDF
Overview
Read bookmarks
POST
Write bookmarks
POST
Convert PDFs to PDF/A or PDF/UA
POST
Attach files
POST
Encrypt a PDF
POST
Embed Factur-X XML
POST
Flatten a PDF
POST
Merge PDFs
POST
Read metadata
POST
Write metadata
POST
Optimise a PDF
POST
Rotate pages
POST
Sign a PDF
POST
Split a PDF
POST
Add a stamp
POST
Add a watermark
POST
PDF forms
Overview
List form fields
POST
Fill a form
POST
Overlay a PDF
POST
Templates
Overview
List aliases
GET
Get an alias
GET
Set an alias
PUT
Delete an alias
DELETE
List templates
GET
Upload a template
POST
Get a template
GET
Delete a template
DELETE
Download a template
GET
Preview a template
POST
List a template's variables
GET
Jobs
Overview
Get a job
GET
Download a job's result
GET
Fonts
Overview
List fonts
GET
Upload fonts
POST
Reload fonts
POST
Delete a font
DELETE
Service
Overview
Liveness
GET
Metrics
GET
Readiness
GET
Engine versions
GET
Configuration
CLI
Errors
Project
Security overview
Known limits
Changelog
SDKs
Licence
GitHub
Overview
Service
Section titled “Service”
Health, version, metrics
Operations
Section titled “Operations”
GET
/health
GET
/metrics
GET
/ready
GET
/v1/version
