Rendering
Render a published page by ID
Render a published page to PNG, SVG, or WebP. Optional query renderType overrides the template's rendererType (satori, takumi, html). When using html, PNG/WebP use headless Chrome (Puppeteer); SVG falls back to Satori. Auth depends on template setting requireGetRenderToken: when true (default), send Authorization Bearer API key or gt (GET render secret from Developers). When false, no auth. Query param token is not allowed (use gt for URL secret).
Rendering
Render a published page by ID
Render a published page to PNG, SVG, or WebP. Optional query renderType overrides the template's rendererType (satori, takumi, html). When using html, PNG/WebP use headless Chrome (Puppeteer); SVG falls back to Satori. Auth depends on template setting requireGetRenderToken: when true (default), send Authorization Bearer API key or gt (GET render secret from Developers). When false, no auth. Query param token is not allowed (use gt for URL secret).
/api/render/:pageIdQuery / Path parameters
| Name | In | Required | Description |
|---|---|---|---|
| pageId | path | Yes | Published page ID |
| format | query | No | Output format. Default: png |
| renderType | query | No | Override renderer; default is the template's rendererType |
| tweaks | query | No | JSON object of variable overrides, e.g. {"title":"Hello"} |
| gt | query | No | GET render secret (space-level) when Bearer is not used; requires template requireGetRenderToken |
Responses
Binary image (image/png, image/svg+xml, or image/webp)
Missing or invalid API token
Page or template not found
curl -X GET "https://bannx.com/api/render/:pageId" \
-H "Authorization: Bearer YOUR_API_TOKEN"// Binary image (image/png, image/svg+xml, or image/webp)
// Or data URL for inline format