Create image
bannerbear_create_imageDestructive
Generate an image from a template (additive; CONSUMES API quota). Async by default: returns a pending image whose uid you poll with bannerbear_get_image. Set synchronous:true to block and receive the finished image (image_url populated) via the sync host. API: POST /v2/images.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| metadata | No | Arbitrary metadata string echoed back on the object. | |
| template | Yes | Template uid to render. | |
| render_pdf | No | Also render a PDF version of the image. | |
| synchronous | No | When true, POST to the sync host and wait for the completed image. Default false (202 pending). | |
| transparent | No | Render with a transparent background (PNG). | |
| webhook_url | No | URL Bannerbear will POST the finished image to when done. | |
| modifications | No | Layer overrides applied to the template. Array of objects, one per layer, each keyed by `name` (the layer name) plus the props to set, e.g. { name: "title", text: "Hello", color: "#FF0000" } or { name: "photo", image_url: "https://..." }. Only include layers you want to change. |