Introduction

The Bannx render API

Turn any template page into a banner, OG image, social graphic, or PDF with a single request. Render by page ID, override variables on the fly, and scale from one call to bulk generation.

Get your API keyRead the rendering guide
Base URL
Authentication

Authorization: Bearer

API key per space

Formats
pngsvgwebppdfpptx

Your first render

One POST with a page ID returns a hosted image and its metadata.

POST/api/render
curl -X POST https://bannx.com/api/render \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "pageId": "PAGE_ID", "format": "png" }'
200 OK · application/json
{
  "pageId": "PAGE_ID",
  "format": "png",
  "width": 1200,
  "height": 630,
  "renderMs": 42,
  "file": {
    "url": "https://cdn.bannx.app/renders/abc.png",
    "sizeBytes": 81234
  }
}

Use the returned file.url to display or download the asset, or set "output": "binary" to stream raw bytes.

Quickstart

Three steps from zero to a rendered image.

  1. 1

    Create an API key

    Generate a token under Settings > Space > Developers. Keys are scoped to a single space.

    Open Developers
  2. 2

    Authenticate requests

    Send the token on every call with the Authorization: Bearer header.

    Authentication
  3. 3

    Render a page

    POST a pageId from a published template and read file.url from the response.

    Rendering API

Explore the API

Reference and guides for every part of the platform.

AuthenticationAPI keys, Bearer tokens, GET render secrets, and scope.Rendering APIRender to PNG, SVG, WebP, or PDF via GET or POST by page ID.TemplatesList and fetch templates and their pages programmatically.VariablesPage, template, and global variables with per-request overrides.VideoNewRender MP4s, stills, and bulk videos from video templates.BrandsNewBrand token kits, and re-skinning renders with brandTweaks.Auto-paginationNewContent-driven multi-page PDFs from a single designed page.Template expressionsFunctions and syntax for dynamic bindings inside templates.WebhooksFire callbacks after a render, upload results, or log events.Endpoint referenceBrowse every documented route, method, and payload.MCP for AI agentsNewLet Claude, Cursor, and agents generate assets via MCP.

Rate limits & credits

Rendering consumes credits per space. Invalid or missing tokens return 401 Unauthorized.

View usage