The Bannerbear connector lets your AI agent act in each user's Bannerbear account. Each user connects their own Bannerbear access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 29 · 26 · 529 read26 write5 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Bannerbear connection
In AgentKit > Connections, create a Bannerbear connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 1import { ScalekitClient } from '@scalekit-sdk/node'2import 'dotenv/config'3import { createInterface } from 'node:readline/promises'45const scalekit = new ScalekitClient(6process.env.SCALEKIT_ENVIRONMENT_URL,7process.env.SCALEKIT_CLIENT_ID,8process.env.SCALEKIT_CLIENT_SECRET,9)10const actions = scalekit.actions1112const connector = 'bannerbear'13const identifier = 'user_123'1415// Generate an authorization link for the user16const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })17console.log('Authorize Bannerbear:', link)18const rl = createInterface({ input: process.stdin, output: process.stdout })19await rl.question('Press Enter after authorizing...')20rl.close()2122// Make your first call23const result = await actions.executeTool({24connector,25identifier,26toolName: 'bannerbear_account_get',27toolInput: {},28})29console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py 1import os2from scalekit import ScalekitClient3from dotenv import load_dotenv4load_dotenv()56scalekit_client = ScalekitClient(7env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),8client_id=os.getenv("SCALEKIT_CLIENT_ID"),9client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),10)11actions = scalekit_client.actions1213connection_name = "bannerbear"14identifier = "user_123"1516# Generate an authorization link for the user17link_response = actions.get_authorization_link(18connection_name=connection_name,19identifier=identifier,20)21print("Authorize Bannerbear:", link_response.link)22input("Press Enter after authorizing...")2324# Make your first call25result = actions.execute_tool(26tool_input={},27tool_name="bannerbear_account_get",28connection_name=connection_name,29identifier=identifier,30)31print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Bannerbear credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolbannerbear_account_getGet the Bannerbear workspace and account tied to the API key.Read-onlyGet Account
Get the Bannerbear workspace and account tied to the API key. Returns the workspace, plan, render quota and AI quota. Use it to check the key works and how much quota is left.
Inputs
This tool takes no inputs.
bannerbear_animation_getGet one animation by its uid.Read-onlyGet Animation
Get one animation by its uid. Returns its status, progress and file URLs once completed. Use it to poll an animation started with Create Animation.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_animation_template_getGet one animation template by its uid.Read-onlyGet Animation Template
Get one animation template by its uid. Returns its size, frame rate and config with layers and keyframes. Use the layer ids in Animate Template or Create Animation.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_animation_templates_listList animation templates in the Bannerbear workspace, 25 per page, newest first.Read-onlyList Animation Templates
List animation templates in the Bannerbear workspace, 25 per page, newest first. Returns an array of animation template objects with uid, status and timestamps. Use Get Animation Template for layers and keyframes.
Inputs
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
bannerbear_animations_listList animations in the Bannerbear workspace, 25 per page, newest first.Read-onlyList Animations
List animations in the Bannerbear workspace, 25 per page, newest first. Returns an array of animation objects with uid, status and timestamps. Use Get Animation to poll one render.
Inputs
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
bannerbear_asset_getGet one uploaded asset by its uid.Read-onlyGet Uploaded Asset
Get one uploaded asset by its uid. Returns its CDN URL, MIME type and size. Use the URL in template modifications or tool inputs.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_assets_listList assets in the Bannerbear workspace, 25 per page, newest first.Read-onlyList Assets
List assets in the Bannerbear workspace, 25 per page, newest first. Returns an array of asset objects with uid, status and timestamps. Use Get Asset for one asset's CDN URL.
Inputs
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
bannerbear_batch_getGet one batch by its uid.Read-onlyGet Batch
Get one batch by its uid. Returns the batch status and the status and file URLs of each image in it. Use it to poll a batch started with Create Batch.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_batches_listList batches in the Bannerbear workspace, 25 per page, newest first.Read-onlyList Batches
List batches in the Bannerbear workspace, 25 per page, newest first. Returns an array of batche objects with uid, status and timestamps. Use Get Batch for the status of each item.
Inputs
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
bannerbear_image_getGet one rendered image by its uid.Read-onlyGet Rendered Image
Get one rendered image by its uid. Returns its status (pending, completed or failed), file URLs by format and any error. Use it to poll an image started with Create Image.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_image_template_getGet one image template by its uid.Read-onlyGet Image Template
Get one image template by its uid. Returns the template's name, size, tags and full config with every layer. Use the layer names in Create Image modifications.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_image_templates_listList image templates in the Bannerbear workspace, 25 per page, newest first.Read-onlyList Image Templates
List image templates in the Bannerbear workspace, 25 per page, newest first. Returns an array of image template objects with uid, status and timestamps. Use Get Image Template for a template's full layer config.
Inputs
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
bannerbear_images_listList images in the Bannerbear workspace, 25 per page, newest first.Read-onlyList Images
List images in the Bannerbear workspace, 25 per page, newest first. Returns an array of image objects with uid, status and timestamps. Use Get Image to poll one render's status.
Inputs
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
bannerbear_instant_url_getGet one Instant URL by its uid.Read-onlyGet Instant Url
Get one Instant URL by its uid. Returns its template, mode, security, status and limits (not the signing key). Use List Instant URLs to find the uid.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_instant_urls_listList instant URLs in the Bannerbear workspace, 25 per page, newest first.Read-onlyList Instant Urls
List instant URLs in the Bannerbear workspace, 25 per page, newest first. Returns an array of instant URL objects with uid, status and timestamps. Use Get Instant URL for one URL's settings.
Inputs
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
bannerbear_publication_getGet one publication by its uid.Read-onlyGet Publication
Get one publication by its uid. Returns its name, kind, tags, preview and visibility. Use Install Publication to copy it into your workspace.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_publications_listBrowse Bannerbear's curated public library of ready-made image and animation templates.Read-onlyBrowse Public Library
Browse Bannerbear's curated public library of ready-made image and animation templates. Returns publications with uid, name, template kind, tags, size and preview. Use Install Publication to copy one into your workspace. It does not list your own publications.
Inputs
categorystring- Only publications in this category, matched against their tags, for example social media or marketing & sales. Comma-separate to match any of several. Example: social media.
kindstring- Only publications of this kind. Omit for all of them. Example: image.one of
imageanimation pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
qstring- Only publications whose name contains this text, case-insensitive. Example: instagram.
bannerbear_recipe_getGet one recipe by uid or slug.Read-onlyGet Recipe
Get one recipe by uid or slug. Returns its name, description, tags, audiences, preview and a sample run's inputs and outputs. Use Install Recipe to add it to your workspace.
Inputs
idstringrequired- The recipe's uid or slug. Get it from List Recipes. Example: linkedin-hiring-post.
bannerbear_recipes_listBrowse the recipe library of ready-made workflows, newest first, 20 per page.Read-onlyList Recipes
Browse the recipe library of ready-made workflows, newest first, 20 per page. Returns recipes with uid, slug, name, description, audiences and install count. Use Install Recipe to copy one into your workspace as a workflow.
Inputs
audiencestring- Only recipes for this audience, for example `recruiters`. Example: recruiters.
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
qstring- Only recipes whose name contains this text, case-insensitive. Example: instagram.
bannerbear_tool_getGet one media tool's definition by its type.Read-onlyGet Tool
Get one media tool's definition by its type. Returns its label, description, input schema, outputs and extra credit cost. Use List Tools to find tool types.
Inputs
tool_typestringrequired- Tool identifier, as returned by List Tools (for example remove_bg or generate_ai_image). Example: remove_bg.
bannerbear_tool_job_getGet one tool job by its uid.Read-onlyGet Tool Job
Get one tool job by its uid. Returns its status and, once completed, the output file URLs. Use it to poll a job started by any run-tool tool (for example Remove Background).
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_tool_jobs_listList tool jobs in the workspace across every tool and status, newest first.Read-onlyList Tool Jobs
List tool jobs in the workspace across every tool and status, newest first. Returns jobs with uid, tool type, status and outputs. Use Get Tool Job to poll one job.
Inputs
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
bannerbear_tools_listList Bannerbear's media tools (background removal, AI image, PDF, video editing and more).Read-onlyList Tools
List Bannerbear's media tools (background removal, AI image, PDF, video editing and more). Returns each tool's id, label, description, output kind, input schema and extra credit cost. Use Get Tool for a tool's input fields; this connector has run tools for the most common ones.
Inputs
filterstring- Only tools in this group. Example: image.one of
aiimageaudiopdf qstring- Words to match against the label, description and keywords. Every word must match. Example: instagram.
bannerbear_webhook_getGet one webhook by its uid.Read-onlyGet Webhook
Get one webhook by its uid. Returns its name, URL, resource, event and status. Use List Webhooks to find the uid.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_webhooks_listList webhooks in the Bannerbear workspace, 25 per page, newest first.Read-onlyList Webhooks
List webhooks in the Bannerbear workspace, 25 per page, newest first. Returns an array of webhook objects with uid, status and timestamps. Use Get Webhook for one webhook's settings.
Inputs
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
bannerbear_workflow_getGet one workflow by its uid.Read-onlyGet Workflow
Get one workflow by its uid. Returns its declared inputs and ordered steps. Use the input names in Run Workflow.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_workflow_run_getGet one workflow run by its uid.Read-onlyGet Workflow Run
Get one workflow run by its uid. Returns its status, per-step status and the outputs of each completed step. Use it to poll a run started with Run Workflow.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_workflow_runs_listList workflow runs in the workspace, 25 per page, newest first.Read-onlyList Workflow Runs
List workflow runs in the workspace, 25 per page, newest first. Returns runs with uid, workflow, status and timestamps. Use Get Workflow Run for per-step status and outputs.
Inputs
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
bannerbear_workflows_listList workflows in the Bannerbear workspace, 25 per page, newest first.Read-onlyList Workflows
List workflows in the Bannerbear workspace, 25 per page, newest first. Returns an array of workflow objects with uid, status and timestamps. Use Get Workflow for a workflow's inputs and steps.
Inputs
pageinteger- Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
bannerbear_animation_createRender a video or GIF from an animation template by changing its layers.WriteCreate Animation
Render a video or GIF from an animation template by changing its layers. Returns a pending animation with its uid (202). Use Get Animation to poll status and progress.
Inputs
modificationsobjectrequired- Layer and output overrides. Put per-layer changes in objects: each gives the layer id and type and the values to set, such as text or image_url. Optional template overrides change the output width, height, fps or transparency. Example: {"objects": [{"id": "title", "type": "text", "text": "Summer sale"}]}.
templatestringrequired- UID of the animation template to render. Example: A89wavQyY3Bebk3djP.
formatsarray- Output formats. Ignored when `transparent` is set — that always yields MOV. Example: ["mp4"].
metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
bannerbear_animation_template_animateApply a named motion preset (FadeIn, ZoomIn, PopIn and others) to an animation template's layers, optionally staggered.WriteAnimate Template
Apply a named motion preset (FadeIn, ZoomIn, PopIn and others) to an animation template's layers, optionally staggered. Returns the updated template with its new keyframes. Uses no AI credits. Use Update Animation Template to set keyframes by hand.
Inputs
presetstringrequired- FadeIn, FadeOut, ZoomIn, ZoomOut, GetBigger, GetSmaller, ScaleIn, ScaleOut work on any layer. PopIn and PopOut are measured in `em` and apply to text layers only. Example: FadeIn.one of
FadeInFadeOutZoomInZoomOutGetBiggerGetSmallerScaleInScaleOutPopInPopOut uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
durationinteger- How long each layer's tween runs, in milliseconds. Example: 600.
easingstring- Optional anime.js easing, e.g. easeOutCubic. Example: easeOutCubic.
mergeboolean- Keep keyframes on layers this call does not touch. False replaces the whole timeline. Example: true.
objectsarray- Layer ids, in the order the stagger should run. Omit to animate every layer in stacking order. Example: ["title", "subtitle"].
staggerinteger- Milliseconds between each layer's START. At 500, layers begin at 0, 500, 1000 — not 500ms of gap after each finishes. Example: 500.
bannerbear_animation_template_createCreate an animation template from a name, size, frame rate and optional config.WriteCreate Animation Template
Create an animation template from a name, size, frame rate and optional config. Returns the new template with its uid. Use Animate Template to add preset motion to its layers.
Inputs
namestringrequired- Display name, shown in the Bannerbear dashboard. Example: Product reveal.
configobject- Template config object with the layers (and keyframes for animations), in the same shape Get returns. Fetch the template, edit its config and send it back to change layers. Example: {"layers": []}.
descriptionstring- Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
frame_rateinteger- Frames per second of the rendered animation, for example 24, 30 or 60. Example: 30.one of
243060 heightinteger- Canvas height in pixels. Example: 1080.
tagsarray- List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].
widthinteger- Canvas width in pixels. Example: 1080.
bannerbear_animation_template_updateUpdate an animation template's name, description, tags, size, frame rate or config.WriteUpdate Animation Template
Update an animation template's name, description, tags, size, frame rate or config. Returns the updated template. Use Get Animation Template first and send back its edited config.
- Idempotent
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
configobject- Template config object with the layers (and keyframes for animations), in the same shape Get returns. Fetch the template, edit its config and send it back to change layers. Example: {"layers": []}.
descriptionstring- Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
frame_rateinteger- Frames per second of the rendered animation, for example 24, 30 or 60. Example: 30.one of
243060 heightinteger- Canvas height in pixels. Example: 1080.
namestring- Display name, shown in the Bannerbear dashboard. Example: Product reveal.
tagsarray- List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].
widthinteger- Canvas width in pixels. Example: 1080.
bannerbear_batch_createRender up to 100 images in one request from image template payloads.WriteCreate Batch
Render up to 100 images in one request from image template payloads. Returns a pending batch with its uid and one pending image per item. Use Get Batch to poll progress. Use Create Image for a single render.
Inputs
itemsarrayrequired- Image payloads to render, up to 100. Each item has the same shape as Create Image: a template uid and a modifications list. Example: [{"template": "A89wavQyY3Bebk3djP", "modifications": {"objects": [{"name": "title", "text": "Hi"}]}}].
typestringrequired- Batch type. Only images is supported. Example: images.one of
images
bannerbear_image_createRender an image from an image template by changing its layers (text, images, colors).WriteCreate Image
Render an image from an image template by changing its layers (text, images, colors). Returns a pending image record with its uid (202); the file URLs appear once status is completed. Use Get Image to poll for the result. Use Create Batch to render up to 100 images at once.
Inputs
modificationsobjectrequired- Layer and template overrides. Put per-layer changes in objects: each targets a layer by name (or id) and sets values such as text, image_url, color or position. Optional template overrides change the output width, height or transparency. Example: {"objects": [{"name": "title", "text": "Hello world"}]}.
templatestringrequired- UID of the image template to render. Example: A89wavQyY3Bebk3djP.
dpiinteger- DPI metadata embedded in the output image for print sizing. Example: 300.
formatsarray- Output file formats. Example: ["png"].
metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
proxyboolean- Proxy and resize external images before rendering. Example: false.
qualityinteger- Compression quality for JPG or WebP output, 1 to 100. Example: 90.
scaleinteger- Output scale multiplier for higher resolution: 1, 2, 3 or 4. Example: 1.one of
1234 versioninteger- Render a specific template version number instead of the latest. Example: 3.
bannerbear_image_template_createCreate an image template in the workspace from a name, size and optional layer config.WriteCreate Image Template
Create an image template in the workspace from a name, size and optional layer config. Returns the new template with its uid. Use Install Publication to copy a ready-made template instead.
Inputs
namestringrequired- Display name, shown in the Bannerbear dashboard. Example: Instagram quote card.
configobject- Template config object with the layers (and keyframes for animations), in the same shape Get returns. Fetch the template, edit its config and send it back to change layers. Example: {"layers": []}.
descriptionstring- Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
heightinteger- Canvas height in pixels. Example: 1080.
tagsarray- List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].
widthinteger- Canvas width in pixels. Example: 1080.
bannerbear_image_template_updateUpdate an image template's name, description, tags, size or layer config.WriteUpdate Image Template
Update an image template's name, description, tags, size or layer config. Returns the updated template. Use Get Image Template first and send back its edited config to keep all layer attributes.
- Idempotent
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
configobject- Template config object with the layers (and keyframes for animations), in the same shape Get returns. Fetch the template, edit its config and send it back to change layers. Example: {"layers": []}.
descriptionstring- Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
heightinteger- Canvas height in pixels. Example: 1080.
namestring- Display name, shown in the Bannerbear dashboard. Example: Instagram quote card.
tagsarray- List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].
widthinteger- Canvas width in pixels. Example: 1080.
bannerbear_instant_url_createCreate an Instant URL that renders images from a template on demand through URL parameters.WriteCreate Instant URL
Create an Instant URL that renders images from a template on demand through URL parameters. Returns the Instant URL with its base URL and, for signed mode, the signing key (shown only once). Use Create Image instead for one-off API renders.
Inputs
namestringrequired- Display name, shown in the Bannerbear dashboard. Example: Instagram quote card.
templatestringrequired- UID of the image template to render. Example: A89wavQyY3Bebk3djP.
expires_atstring- ISO 8601 date-time after which the Instant URL stops rendering. Example: 2026-12-31T23:59:59Z.
max_rendersinteger- Maximum number of renders this Instant URL may produce before it stops. Example: 1000.
modestring- How the URL carries modifications: encoded (one base64 blob) or named_params (one query parameter per layer). Example: named_params.one of
encodednamed_params rate_limitboolean- Whether to apply Bannerbear's per-URL rate limit to renders from this Instant URL. Example: true.
scaleinteger- Output scale multiplier for higher resolution: 1, 2, 3 or 4. Example: 1.one of
1234 securitystring- signed requires each URL to carry an HMAC signature made with the signing key; open accepts any URL. Example: signed.one of
signedopen statusstring- Whether the object is active or disabled. Example: active.one of
activedisabled template_versioninteger- Pin the Instant URL to this template version number. Omit to always use the latest version. Example: 3.
bannerbear_instant_url_updateUpdate an Instant URL's name, template, mode, security, status or limits.WriteUpdate Instant URL
Update an Instant URL's name, template, mode, security, status or limits. Returns the updated Instant URL. Set status to disabled to stop renders without deleting it.
- Idempotent
Inputs
namestringrequired- Display name, shown in the Bannerbear dashboard. Example: Instagram quote card.
templatestringrequired- UID of the image template to render. Example: A89wavQyY3Bebk3djP.
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
expires_atstring- ISO 8601 date-time after which the Instant URL stops rendering. Example: 2026-12-31T23:59:59Z.
max_rendersinteger- Maximum number of renders this Instant URL may produce before it stops. Example: 1000.
modestring- How the URL carries modifications: encoded (one base64 blob) or named_params (one query parameter per layer). Example: named_params.one of
encodednamed_params rate_limitboolean- Whether to apply Bannerbear's per-URL rate limit to renders from this Instant URL. Example: true.
scaleinteger- Output scale multiplier for higher resolution: 1, 2, 3 or 4. Example: 1.one of
1234 securitystring- signed requires each URL to carry an HMAC signature made with the signing key; open accepts any URL. Example: signed.one of
signedopen statusstring- Whether the object is active or disabled. Example: active.one of
activedisabled template_versioninteger- Pin the Instant URL to this template version number. Omit to always use the latest version. Example: 3.
bannerbear_publication_installInstall a publication into your workspace as a new image or animation template.WriteInstall Publication
Install a publication into your workspace as a new image or animation template. Returns the new template with its uid. Use Browse Public Library to find publications. Trial accounts are capped at 3 templates.
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_recipe_installInstall a recipe into your workspace, copying its workflow and the templates it uses.WriteInstall Recipe
Install a recipe into your workspace, copying its workflow and the templates it uses. Returns the new workflow with its uid. Use Run Workflow next. Trial accounts are capped at 3 workflows.
Inputs
idstringrequired- The recipe's uid or slug. Get it from List Recipes. Example: linkedin-hiring-post.
bannerbear_tool_concat_videosJoin several videos into one, in order, with an optional transition.WriteJoin Videos
Join several videos into one, in order, with an optional transition. Returns a pending tool job with its uid (202). Use Get Tool Job to poll for the joined video URL.
Inputs
video_urlsarrayrequired- Two or more URLs in play order. Example: ["https://example.com/videos/a.mp4", "https://example.com/videos/b.mp4"].
fpsinteger- Defaults to the highest frame rate among the inputs, capped at 60. Example: 30.
heightinteger- Canvas height in pixels. Example: 1080.
metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
transitionstring- How each clip flows into the next. Defaults to none. Example: fade.one of
nonefadedissolvewipeleftslideleft transition_durationnumber- Only used when transition is set. Defaults to 1. Example: 0.5.
widthinteger- Canvas width in pixels. Example: 1080.
bannerbear_tool_create_pdfCombine images or PDFs from URLs into one multi-page PDF, in the given order.WriteCreate Multi-page PDF
Combine images or PDFs from URLs into one multi-page PDF, in the given order. Returns a pending tool job with its uid (202). Use Get Tool Job to poll for the PDF URL.
Inputs
urlsarrayrequired- One URL per line — JPG, PNG, or PDF. Upload adds them here. Order is preserved. Example: ["https://example.com/page1.png", "https://example.com/page2.png"].
metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
bannerbear_tool_extract_articleExtract the title, text and lead image from an article web page.WriteExtract Article
Extract the title, text and lead image from an article web page. Returns a pending tool job with its uid (202). Use Get Tool Job to poll for the extracted fields, for example to feed a template.
Inputs
urlstringrequired- Public URL of the article page to extract. Example: https://example.com/blog/launch-announcement.
metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
bannerbear_tool_generate_ai_imageGenerate an image from a text prompt with an AI model (Flux, Nano Banana or GPT Image).WriteGenerate AI Image
Generate an image from a text prompt with an AI model (Flux, Nano Banana or GPT Image). Returns a pending tool job with its uid (202). Use Get Tool Job to poll for the image URL. Credit cost varies by model.
Inputs
modelstringrequired- Costs vary by model — see the credit cost shown for each. Example: flux_schnell.one of
flux_schnellflux_1_1_pronano_bananagpt_image_2 promptstringrequired- What to generate — describe the subject, style and composition. Example: A flat illustration of a coffee cup on a desk, pastel colors.
aspect_ratiostring- Defaults to square. Example: 1:1.one of
1:116:99:164:33:4 metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
reference_image_urlstring- Optional starting point — only some models accept one. Example: https://example.com/photos/reference.jpg.
bannerbear_tool_generate_textGenerate short text, such as a caption or headline, from a prompt with AI.WriteGenerate Text
Generate short text, such as a caption or headline, from a prompt with AI. Returns a pending tool job with its uid (202); the text appears in its outputs. Use Get Tool Job to poll for the result. Spends Bannerbear credits.
Inputs
promptstringrequired- What to write or rewrite, with any source text after it. Up to 100000 characters. Example: Write a 20-word Instagram caption for a summer coffee sale.
max_charactersinteger- The text is never longer than this. Example: 280.
metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
bannerbear_tool_pdf_to_imageTurn the first page or all pages (up to 20) of a PDF into PNG or JPG images.WritePDF to Image
Turn the first page or all pages (up to 20) of a PDF into PNG or JPG images. Returns a pending tool job with its uid (202). Use Get Tool Job to poll for the image URLs.
Inputs
pdf_urlstringrequired- PDF URL. Example: https://example.com/docs/brochure.pdf.
dpiinteger- 72 to 300. 300 suits print, 72 to 150 suits screens. Example: 300.
formatstring- Format. Example: png.one of
pngjpg metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
pagesstring- All pages makes one image per page, up to 20. Example: first.one of
firstall
bannerbear_tool_remove_backgroundRemove the background from an image and return a transparent PNG.WriteRemove Background
Remove the background from an image and return a transparent PNG. Returns a pending tool job with its uid (202). Use Get Tool Job to poll for the output URL. Spends Bannerbear credits.
Inputs
image_urlstringrequired- Public URL of the image to cut out. Example: https://example.com/photos/product.jpg.
metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
bannerbear_tool_trim_videoCut a video to the section between a start and end time in seconds.WriteTrim Video
Cut a video to the section between a start and end time in seconds. Returns a pending tool job with its uid (202). Use Get Tool Job to poll for the trimmed video URL.
Inputs
endnumberrequired- End (seconds). Example: 20.
startnumberrequired- Start (seconds). Example: 5.
video_urlstringrequired- Video URL. Example: https://example.com/videos/clip.mp4.
metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
bannerbear_tool_video_thumbnailsGrab still frames from a video, either a count of frames or one every interval seconds.WriteVideo Thumbnails
Grab still frames from a video, either a count of frames or one every interval seconds. Returns a pending tool job with its uid (202). Use Get Tool Job to poll for the thumbnail image URLs.
Inputs
video_urlstringrequired- Video URL. Example: https://example.com/videos/clip.mp4.
countinteger- How many frames to grab, up to 10. Example: 4.
intervalnumber- Seconds between frames — fractions are fine, 0.5 for two a second. Example: 10.
metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
startnumber- Where the first frame is taken. Example: 5.
bannerbear_webhook_createCreate a webhook that posts render events to your URL.WriteCreate Webhook
Create a webhook that posts render events to your URL. Returns the new webhook with its uid. Choose a resource (image, batch, tool_job, workflow_run or animation) and an event (all_events, completed or failed).
Inputs
namestringrequired- Name of the webhook, shown in the dashboard. Example: Image completed hook.
urlstringrequired- URL to receive webhook events. Example: https://example.com/webhooks/bannerbear.
eventstring- Event type to trigger on. Example: completed.one of
all_eventscompletedfailed resourcestring- Resource type to trigger on. Example: image.one of
imagebatchtool_jobworkflow_runanimation statusstring- Whether the object is active or disabled. Example: active.one of
activedisabled
bannerbear_webhook_updateUpdate a webhook's name, URL, resource, event or status.WriteUpdate Webhook
Update a webhook's name, URL, resource, event or status. Returns the updated webhook. Set status to disabled to pause deliveries without deleting it.
- Idempotent
Inputs
namestringrequired- Name of the webhook, shown in the dashboard. Example: Image completed hook.
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
urlstringrequired- URL to receive webhook events. Example: https://example.com/webhooks/bannerbear.
eventstring- Event type to trigger on. Example: completed.one of
all_eventscompletedfailed resourcestring- Resource type to trigger on. Example: image.one of
imagebatchtool_jobworkflow_runanimation statusstring- Whether the object is active or disabled. Example: active.one of
activedisabled
bannerbear_workflow_createCreate a workflow that chains tools and image or animation renders into one automation.WriteCreate Workflow
Create a workflow that chains tools and image or animation renders into one automation. Returns the new workflow with its uid. Use Install Recipe to start from a ready-made workflow instead.
Inputs
namestringrequired- Display name, shown in the Bannerbear dashboard. Example: Product photo to social card.
descriptionstring- Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
inputsobject- Inputs the workflow accepts, keyed by input name. Each value gives the input type (string, url, number or boolean) and whether it is required. Example: {"image_url": {"type": "url", "required": true}}.
stepsarray- Ordered steps the workflow runs. Each step has a key, a type (tool, image or animation), a ref (a tool slug from List Tools, or a template uid) and its inputs. Step inputs can reference workflow inputs as {{inputs.<name>}} and earlier steps' outputs as {{steps.<key>.<output>}}. On update the list replaces the current steps. Example: [{"key": "cutout", "type": "tool", "ref": "remove_bg", "inputs": {"image_url": "{{inputs.image_url}}"}}].
tagsarray- List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].
bannerbear_workflow_run_createStart a run of a workflow with values for its declared inputs.WriteRun Workflow
Start a run of a workflow with values for its declared inputs. Returns a pending run with its uid (202). Each step is billed as the resource it creates. Use Get Workflow Run to poll until status is completed or failed.
Inputs
workflowstringrequired- UID of the workflow to run. Get it from List Workflows. Example: rZdpMYmAnDB1zb3kXL.
inputsobject- Values for the workflow's declared inputs, keyed by input name. URL inputs must be http(s) URLs. Example: {"image_url": "https://example.com/photos/product.jpg"}.
metadatastring- Free-text string stored with the object and returned in its record and webhooks, for your own reference such as an order ID. Example: order-1234.
bannerbear_workflow_updateUpdate a workflow's name, description, tags, inputs or steps.WriteUpdate Workflow
Update a workflow's name, description, tags, inputs or steps. Returns the updated workflow. Use Get Workflow first to see the current steps.
- Idempotent
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
descriptionstring- Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
inputsobject- Inputs the workflow accepts, keyed by input name, each with a type (string, url, number or boolean) and a required flag. Omit to keep the current inputs; send {} to clear them. Example: {"image_url": {"type": "url", "required": true}}.
namestring- Display name, shown in the Bannerbear dashboard. Example: Product photo to social card.
stepsarray- Ordered steps the workflow runs. Each step has a key, a type (tool, image or animation), a ref (a tool slug from List Tools, or a template uid) and its inputs. Step inputs can reference workflow inputs as {{inputs.<name>}} and earlier steps' outputs as {{steps.<key>.<output>}}. On update the list replaces the current steps. Example: [{"key": "cutout", "type": "tool", "ref": "remove_bg", "inputs": {"image_url": "{{inputs.image_url}}"}}].
tagsarray- List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].
bannerbear_animation_template_deletePermanently delete a animation template by its uid.DestructiveDelete Animation Template
Permanently delete a animation template by its uid. This cannot be undone. Returns an empty response on success. Use List to find the uid first.
- Idempotent
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_image_template_deletePermanently delete a image template by its uid.DestructiveDelete Image Template
Permanently delete a image template by its uid. This cannot be undone. Returns an empty response on success. Use List to find the uid first.
- Idempotent
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_instant_url_deletePermanently delete a Instant URL; any URLs built on it stop rendering by its uid.DestructiveDelete Instant URL
Permanently delete a Instant URL; any URLs built on it stop rendering by its uid. This cannot be undone. Returns an empty response on success. Use List to find the uid first.
- Idempotent
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_webhook_deletePermanently delete a webhook by its uid.DestructiveDelete Webhook
Permanently delete a webhook by its uid. This cannot be undone. Returns an empty response on success. Use List to find the uid first.
- Idempotent
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
bannerbear_workflow_deletePermanently delete a workflow by its uid.DestructiveDelete Workflow
Permanently delete a workflow by its uid. This cannot be undone. Returns an empty response on success. Use List to find the uid first.
- Idempotent
Inputs
uidstringrequired- Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
No tools match.
Related: other Design connectors
All 34 in DesignFigmaScalekit connectorConnect to Figma to access user files, teams, projects, and design metadata via OAuth 2.0OAuth54 tools
MiroScalekit connectorMiro is a visual collaboration platform for teams. Manage boards, sticky notes, shapes, cards, frames, connectors, images, and tags using the Miro REST...OAuth115 tools
MuralScalekit connectorMural is a digital whiteboard for visual collaboration. Manage murals, widgets (sticky notes, shapes, text, arrows, images), rooms, folders, templates...OAuth61 tools