Document templates

Render a document

Prints a revision - the published one unless revision names another - with data. The data is checked and the template run first, before anything is reserved: problems are a 422 that costs nothing. Then it prints like POST /pdf, on the render.pdf meter. PDFs are not cached. As a job, submit kind document.

post/v1/document-templates/{id}/render

Request

  • Base URL: https://api.ironfang.com/render
  • URL: https://api.ironfang.com/render/v1/document-templates/{id}/render
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes a synchronous render happen, and count, at most once. Any string up to 255 characters, remembered per account. The first request under a key is admitted and rendered as usual; a synchronous result is not kept, so the same request again under the key is a 409 idempotency_key_used and reserves nothing - send a new key to render again. A different request under a used key is a 409 idempotency_conflict. An identical request inside the cache window is still served from cache.

Request body

dataobject

The document data: at most 1 MiB, 32 levels deep.

revisioninteger

The revision number to render; absent or 0 for the published one.

Response

The rendered PDF.

Changes

No recorded changes to this operation across all 1 revision of this API.