canonical: https://jentic.com/apis/bannerbear.com/bannerbear # Bannerbear API Jentic publishes the only available OpenAPI specification for the Bannerbear API, keeping it validated and agent-ready. Bannerbear automates image and video generation from designer-built templates, exposing endpoints for one-off images, batched collections, animated GIFs, screenshots of URLs, and rendered videos. Each render request supplies modifications (text, image swaps, colour overrides) to a template, and Bannerbear returns hosted output assets ready to embed in social posts, landing pages, or email. The API is widely used for personalised marketing creatives and dynamic OG images. ## For AI agents Generate branded images, videos, animated GIFs, and URL screenshots on demand from Bannerbear templates. Suited to agents producing dynamic marketing creatives and personalised assets at scale. ## Scope Does not handle template design editing, asset storage as a CDN, or live video streaming - use for rendering images, videos, GIFs, and screenshots from prebuilt templates only. ## Capabilities - Render images from a Bannerbear template with text and image modifications - Generate batches of images as a collection in a single request - Create animated GIFs by interpolating layer modifications across frames - Capture full-page screenshots of URLs at configurable resolutions - Render videos by composing template frames with audio and timing controls - Inspect templates, collections, and projects to drive automated pipelines ## Use cases ### Personalised Marketing Creatives at Scale Generate thousands of personalised images for email, social, and ad campaigns by feeding customer data into Bannerbear templates. Marketing teams design templates once in Bannerbear's editor and then drive variations through POST /v2/images, swapping recipient names, product photos, and colour themes. This replaces handcrafted Photoshop work and cuts campaign turnaround from days to minutes. Example prompt: POST /v2/images with template UID 'tpl_abc' and modifications mapping the customer's name, product image URL, and brand colour, then return the image_url from the response. ### Dynamic Open Graph and Social Cards Generate per-page Open Graph images for blog posts, product pages, and shareable links using Bannerbear templates. Drop a request to POST /v2/images at publish time or render on demand from a serverless function for share-time previews. Pair with /v2/screenshots when an actual rendered page snapshot is preferable to a templated card. Example prompt: POST /v2/images for blog post 'how-to-rank-on-google' with the post title and author headshot, then store the returned image_url on the post record for OG meta tags. ### Short-Form Video and Animated Ad Production Produce short-form videos and animated GIFs at scale by sending modifications to /v2/videos and /v2/animated_gifs. Bannerbear handles transcoding, frame composition, and audio overlay, so marketing teams iterate on creative variants without owning a video pipeline. Useful for social ads, product highlight reels, and animated email banners. Example prompt: POST /v2/videos with template UID 'vid_promo' and modifications for product name, price, and a stock background, then poll GET /v2/videos/{uid} until status is completed. ### AI Agent Creative Producer via Jentic Wire an AI agent to Bannerbear through Jentic so it can act as an on-demand creative producer. The agent searches Jentic for an intent like 'generate a marketing image', loads the Bannerbear schema, and executes the call with the API key held in your Jentic One instance. The agent can compose copy, choose templates, and return finished image URLs to a chat UI or email draft. Example prompt: Search Jentic for 'create a marketing image', execute POST /v2/images against template 'tpl_promo' with copy generated by the agent, and post the rendered image_url to Slack. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /v2/images | Render an image from a template | | GET | /v2/images/{uid} | Get a rendered image and its status | | POST | /v2/videos | Render a video from a template | | GET | /v2/videos/{uid} | Get a rendered video and its status | | POST | /v2/animated_gifs | Render an animated GIF | | POST | /v2/screenshots | Capture a screenshot of a URL | | POST | /v2/collections | Create a batched collection of image renders | ## Key resources - **Images** — Static image renders from Bannerbear templates - **Videos** — Rendered video outputs with status polling - **Animated GIFs** — Multi-frame animated GIF renders driven by modifications - **Screenshots** — Full-page URL screenshots at configurable resolutions - **Collections** — Batched image renders grouped under one request - **Templates** — Designer-built reusable templates with named modifiable layers ## Why Jentic - **Setup:** Wiring Bannerbear by hand means adding a bearer key to every request, submitting render jobs, and polling the image, video, and screenshot uids until they complete yourself. Through Jentic you install once, import the Bannerbear API from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** Bannerbear takes its render targets in the request body rather than as a resource in the URL path, so scope the agent to the operations it needs, such as creating an image or a screenshot. You choose that operation set, so video or GIF rendering are not included unless you add them. - **Credential handling:** Your Bannerbear bearer key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a marketing image' or 'render a short video', and Jentic returns the matching Bannerbear operation with its input schema and required template parameters so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Placid** — Template-based image, video, and PDF generation API. - **Creatomate** — Programmatic video and image rendering API with a focus on video. - **Cloudinary Upload API** — Image and video transformation, hosting, and CDN. ## FAQ ### Why is there no official OpenAPI spec for Bannerbear? Bannerbear does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Bannerbear via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Bannerbear API use? Bannerbear uses HTTP bearer authentication with a project-scoped API key passed in the Authorization header. When called through Jentic, the key is stored encrypted in your Jentic One instance and injected at request time so it never enters the agent's context. ### Can I generate videos with the Bannerbear API? Yes. POST /v2/videos with a video template UID and modifications, then poll GET /v2/videos/{uid} until the status is completed. The response includes the hosted MP4 URL ready to embed or download. ### What are the rate limits for the Bannerbear API? Bannerbear enforces rate limits per project plan rather than a single global value. Image renders are typically the most permissive; video and screenshot endpoints have lower concurrent-render limits. Inspect the response headers for current quota and back off when retries are signalled. ### How do I render an image through Jentic? Install the Jentic SDK with pip install jentic, search for 'create a marketing image', and execute the matched POST /v2/images operation with the template UID and modifications. Jentic injects the bearer token, calls Bannerbear, and returns the image_url to the agent. ### Does Bannerbear support URL screenshots? Yes. POST /v2/screenshots with a target URL and viewport options to render a full-page screenshot. Then call GET /v2/screenshots/{uid} to retrieve the hosted image URL once the render completes. ### Can I limit what my agent is allowed to do with the Bannerbear API? Yes. Because you self-host Jentic One, your own rules decide which Bannerbear operations and credentials the agent may use. Since Bannerbear takes its render targets in the request body rather than as a resource in the URL path, you scope the agent to only the operations it needs, such as creating an image (POST /v2/images) or capturing a URL screenshot (POST /v2/screenshots). Video and animated GIF rendering stay off limits unless you explicitly add those operations to the set.