HTTP API

This reference is generated from the service’s OpenAPI 3.1.0 description, version 0.1.0. The same description is at /openapi.json on this site and on your own service.

Requests are multipart forms unless a route says otherwise. Send credentials with X-Api-Key or Authorization: Bearer, or use basic auth, as Authentication explains. Failures are JSON, as Errors describes.

• Render: Templates in, documents out
• Convert: Documents in, converted documents out
• Stored templates: Store a template, name it with an alias, and render it by id or alias from any replica
• Fonts: List, upload and delete fonts, and reload a mounted directory
• PDF operations: PDF operations
• PDF forms: PDF templates: form fields, tags in annotations, overlays
• Background jobs: Requests run in the background with Prefer: respond-async, and their results
• Service: Health, version, metrics