Templates

Publish a new immutable version

Earlier versions keep rendering byte-for-byte as they did. Renders cached against the old version stay valid; the new version starts with a cold cache.

Fields you leave out are inherited from the previous version, not reset. engine, schema, options, expected_pages and example all carry forward, so {"source": "…"} publishes a new body against the same renderer and the same validation contract. Send a field to override it, and send an empty value ({} for schema or options, null for example) to clear it. source is always required, and message is never inherited — it is the note for this version.

post/v1/templates/{name}/versions

Request

  • Base URL: https://api.galleyrender.com
  • URL: https://api.galleyrender.com/v1/templates/{name}/versions
  • Auth: HTTP bearer

Path parameters

namestring required
Example:invoice

The template name, without a version.

Request body

namestring required
sourcestring required

One self-contained HTML document with inline CSS and Liquid expressions. No file includes.

engine'chromium' | 'satori'
schemaobject

JSON Schema for the data payload. Strongly recommended: it is what turns a bad payload into a field-level error.

expected_pagesinteger

How many PDF pages a typical payload renders. This is the pre-flight estimate the free tier and the spend cap are checked against, so a multi-page template must declare it or a render that cannot fit the allowance will be allowed to start. It is not a limit: the render is metered on the pages it actually produced, and an under-estimate is corrected afterwards from that count. Ignored for png/jpg, which are always one unit.

exampleunknown
descriptionstring
messagestring

Change note for this version, like a commit message.

Example request

{
  "name": "invoice",
  "options": {
    "margin": "18mm"
  }
}

Response

Published.

object'template' required
idstring required
namestring required
descriptionstring nullable
latest_versioninteger required
created_atstring date-time required
updated_atstring date-time required
versioninteger

Present when a version was resolved.

refstring
engine'chromium' | 'satori'
schemaobject nullable
optionsobject nullable
expected_pagesinteger

The version's declared PDF page estimate.

exampleunknown
sourcestring
checksumstring

SHA-256 of engine, source, schema and options. Part of the render cache key.

messagestring nullable
version_created_atstring date-time
origin'library' | 'import' | 'own'

On GET /v1/templates: a starter from the library, a template saved from a document import, or one of the account's own.

Example response

{
  "id": "tpl_5m2k8q1xv7bd",
  "ref": "invoice@1"
}

Changes

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