docs-api-group-actionName

Rendering

Render a page by ID (GET)

Render by page ID with query parameters. Supports draft (database), publish cache, png/svg/webp/pdf, JSON or binary responses, tweaks, and brandTweaks — aligned with POST /api/render. Auth depends on template requireGetRenderToken (Bearer or gt query).

GET/api/render/:pageId

Query / Path parameters

NameInRequiredDescription
pageIdpathYesPage ID to render
formatqueryNoOutput format. Default: png
draftqueryNoIf true, load from database instead of publish cache. Default: false
outputqueryNoResponse shape: omit or json for metadata + file URL; binary for raw bytes
pageIdsqueryNoComma-separated page IDs for merged PDF (format=pdf only)
gtqueryNoGET render secret when Bearer is not used

Responses

200

Binary image/PDF or application/json with file metadata

401

Missing or invalid API token

404

Page or template not found

Request
curl -X GET "https://bannx.com/api/render/:pageId" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
Response
// Binary image (image/png, image/svg+xml, or image/webp)
// Or data URL for inline format