Test-render a template

POST

/templates/:id/test-render

Ephemerally renders a DOCX/Liquid template to a base64 PDF (no R2 write, no quota, no file rows). Renders from { data }, a { projectId, recordId } record, or the template’s saved sample data. Rendering from a record additionally requires data-record:read. Requires playbook:create.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

idstringRequired

Request

This endpoint expects an object.

datamap from strings to anyOptional

projectIdstringOptional>=1 character

recordIdstringOptional>=1 character

Response

The rendered preview document.

documentstring

Base64-encoded rendered PDF.

mimeTypestring

filenamestring

warningslist of maps from strings to any

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

503

Service Unavailable Error

1	curl -X POST https:/https://api/templates/id/test-render \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"document": "JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9UeXBlL1BhZ2UvUGFyZW50IDMgMCBSL1Jlc291cmNlcyA8PC9Gb250IDw8L0YxIDYgMCBSPj4+Pi9NZWRpYUJveFswIDAgNjEyIDc5Ml0vQ29udGVudHMgNiAwIFI+PgplbmRvYmoKNiAwIG9iago8PC9MZW5ndGggMTIz",
3	"mimeType": "application/pdf",
4	"filename": "rendered_template_preview.pdf",
5	"warnings": [
6	{}
7	]
8	}