Templates

Get one template version

invoice resolves the latest version; invoice@3 pins version 3.

get/v1/templates/{ref}

Request

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

Path parameters

refstring required
Example:invoice

invoice for the latest version, or invoice@3 to pin one.

Response

The template and the resolved version, including its source and schema.

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.