> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Bannerbear

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.

**Authentication:** Bearer Token
**Categories:** Design, Media
**Tools:** 60: 29 read, 26 write, 5 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=BANNERBEAR)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Bannerbear connection

   In **AgentKit > Connections**, create a Bannerbear connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'bannerbear'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Bannerbear:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'bannerbear_account_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "bannerbear"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Bannerbear:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="bannerbear_account_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Bannerbear credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'bannerbear_account_get',
  toolInput: {},
  connector: 'bannerbear',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="bannerbear_account_get",
    tool_input={},
    connection_name="bannerbear",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `bannerbear_account_get`

Get Account · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `bannerbear_animation_get`

Get Animation · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_animation_template_get`

Get Animation Template · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_animation_templates_list`

List Animation Templates · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.

Example input: `{}`

### `bannerbear_animations_list`

List Animations · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.

Example input: `{}`

### `bannerbear_asset_get`

Get Uploaded Asset · Read-only

Get one uploaded asset by its uid.
Returns its CDN URL, MIME type and size.
Use the URL in template modifications or tool inputs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_assets_list`

List Assets · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.

Example input: `{}`

### `bannerbear_batch_get`

Get Batch · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_batches_list`

List Batches · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.

Example input: `{}`

### `bannerbear_image_get`

Get Rendered Image · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_image_template_get`

Get Image Template · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_image_templates_list`

List Image Templates · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.

Example input: `{}`

### `bannerbear_images_list`

List Images · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.

Example input: `{}`

### `bannerbear_instant_url_get`

Get Instant Url · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_instant_urls_list`

List Instant Urls · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.

Example input: `{}`

### `bannerbear_publication_get`

Get Publication · Read-only

Get one publication by its uid.
Returns its name, kind, tags, preview and visibility.
Use Install Publication to copy it into your workspace.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_publications_list`

Browse Public Library · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `category` (`string`, optional): 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.
- `kind` (`string`, optional): Only publications of this kind. Omit for all of them. Example: image. One of: `image`, `animation`.
- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
- `q` (`string`, optional): Only publications whose name contains this text, case-insensitive. Example: instagram.

Example input: `{}`

### `bannerbear_recipe_get`

Get Recipe · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): The recipe's uid or slug. Get it from List Recipes. Example: linkedin-hiring-post.

Example input: `{"id":"<id>"}`

### `bannerbear_recipes_list`

List Recipes · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `audience` (`string`, optional): Only recipes for this audience, for example `recruiters`. Example: recruiters.
- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.
- `q` (`string`, optional): Only recipes whose name contains this text, case-insensitive. Example: instagram.

Example input: `{}`

### `bannerbear_tool_get`

Get Tool · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `tool_type` (`string`, required): Tool identifier, as returned by List Tools (for example remove_bg or generate_ai_image). Example: remove_bg.

Example input: `{"tool_type":"<tool_type>"}`

### `bannerbear_tool_job_get`

Get Tool Job · Read-only

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).

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_tool_jobs_list`

List Tool Jobs · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.

Example input: `{}`

### `bannerbear_tools_list`

List Tools · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `filter` (`string`, optional): Only tools in this group. Example: image. One of: `ai`, `image`, `audio`, `pdf`.
- `q` (`string`, optional): Words to match against the label, description and keywords. Every word must match. Example: instagram.

Example input: `{}`

### `bannerbear_webhook_get`

Get Webhook · Read-only

Get one webhook by its uid.
Returns its name, URL, resource, event and status.
Use List Webhooks to find the uid.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_webhooks_list`

List Webhooks · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.

Example input: `{}`

### `bannerbear_workflow_get`

Get Workflow · Read-only

Get one workflow by its uid.
Returns its declared inputs and ordered steps.
Use the input names in Run Workflow.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_workflow_run_get`

Get Workflow Run · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_workflow_runs_list`

List Workflow Runs · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.

Example input: `{}`

### `bannerbear_workflows_list`

List Workflows · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page of results to return; each page holds 25 items. Starts at 1. Example: 2.

Example input: `{}`

### `bannerbear_animation_create`

Create Animation · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `modifications` (`object`, required): 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"}]}.
- `template` (`string`, required): UID of the animation template to render. Example: A89wavQyY3Bebk3djP.
- `formats` (`array`, optional): Output formats. Ignored when `transparent` is set — that always yields MOV. Example: ["mp4"].
- `metadata` (`string`, optional): 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.

Example input: `{"modifications":{},"template":"<template>"}`

### `bannerbear_animation_template_animate`

Animate Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `preset` (`string`, required): 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: `FadeIn`, `FadeOut`, `ZoomIn`, `ZoomOut`, `GetBigger`, `GetSmaller`, `ScaleIn`, `ScaleOut`, `PopIn`, `PopOut`.
- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
- `duration` (`integer`, optional): How long each layer's tween runs, in milliseconds. Example: 600.
- `easing` (`string`, optional): Optional anime.js easing, e.g. easeOutCubic. Example: easeOutCubic.
- `merge` (`boolean`, optional): Keep keyframes on layers this call does not touch. False replaces the whole timeline. Example: true.
- `objects` (`array`, optional): Layer ids, in the order the stagger should run. Omit to animate every layer in stacking order. Example: ["title", "subtitle"].
- `stagger` (`integer`, optional): Milliseconds between each layer's START. At 500, layers begin at 0, 500, 1000 — not 500ms of gap after each finishes. Example: 500.

Example input: `{"preset":"FadeIn","uid":"<uid>"}`

### `bannerbear_animation_template_create`

Create Animation Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Display name, shown in the Bannerbear dashboard. Example: Product reveal.
- `config` (`object`, optional): 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": []}.
- `description` (`string`, optional): Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
- `frame_rate` (`integer`, optional): Frames per second of the rendered animation, for example 24, 30 or 60. Example: 30. One of: `24`, `30`, `60`.
- `height` (`integer`, optional): Canvas height in pixels. Example: 1080.
- `tags` (`array`, optional): List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].
- `width` (`integer`, optional): Canvas width in pixels. Example: 1080.

Example input: `{"name":"<name>"}`

### `bannerbear_animation_template_update`

Update Animation Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
- `config` (`object`, optional): 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": []}.
- `description` (`string`, optional): Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
- `frame_rate` (`integer`, optional): Frames per second of the rendered animation, for example 24, 30 or 60. Example: 30. One of: `24`, `30`, `60`.
- `height` (`integer`, optional): Canvas height in pixels. Example: 1080.
- `name` (`string`, optional): Display name, shown in the Bannerbear dashboard. Example: Product reveal.
- `tags` (`array`, optional): List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].
- `width` (`integer`, optional): Canvas width in pixels. Example: 1080.

Example input: `{"uid":"<uid>"}`

### `bannerbear_batch_create`

Create Batch · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `items` (`array`, required): 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"}]}}].
- `type` (`string`, required): Batch type. Only images is supported. Example: images. One of: `images`.

Example input: `{"items":[],"type":"images"}`

### `bannerbear_image_create`

Create Image · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `modifications` (`object`, required): 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"}]}.
- `template` (`string`, required): UID of the image template to render. Example: A89wavQyY3Bebk3djP.
- `dpi` (`integer`, optional): DPI metadata embedded in the output image for print sizing. Example: 300.
- `formats` (`array`, optional): Output file formats. Example: ["png"].
- `metadata` (`string`, optional): 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.
- `proxy` (`boolean`, optional): Proxy and resize external images before rendering. Example: false.
- `quality` (`integer`, optional): Compression quality for JPG or WebP output, 1 to 100. Example: 90.
- `scale` (`integer`, optional): Output scale multiplier for higher resolution: 1, 2, 3 or 4. Example: 1. One of: `1`, `2`, `3`, `4`.
- `version` (`integer`, optional): Render a specific template version number instead of the latest. Example: 3.

Example input: `{"modifications":{},"template":"<template>"}`

### `bannerbear_image_template_create`

Create Image Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Display name, shown in the Bannerbear dashboard. Example: Instagram quote card.
- `config` (`object`, optional): 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": []}.
- `description` (`string`, optional): Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
- `height` (`integer`, optional): Canvas height in pixels. Example: 1080.
- `tags` (`array`, optional): List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].
- `width` (`integer`, optional): Canvas width in pixels. Example: 1080.

Example input: `{"name":"<name>"}`

### `bannerbear_image_template_update`

Update Image Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
- `config` (`object`, optional): 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": []}.
- `description` (`string`, optional): Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
- `height` (`integer`, optional): Canvas height in pixels. Example: 1080.
- `name` (`string`, optional): Display name, shown in the Bannerbear dashboard. Example: Instagram quote card.
- `tags` (`array`, optional): List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].
- `width` (`integer`, optional): Canvas width in pixels. Example: 1080.

Example input: `{"uid":"<uid>"}`

### `bannerbear_instant_url_create`

Create Instant URL · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Display name, shown in the Bannerbear dashboard. Example: Instagram quote card.
- `template` (`string`, required): UID of the image template to render. Example: A89wavQyY3Bebk3djP.
- `expires_at` (`string`, optional): ISO 8601 date-time after which the Instant URL stops rendering. Example: 2026-12-31T23:59:59Z.
- `max_renders` (`integer`, optional): Maximum number of renders this Instant URL may produce before it stops. Example: 1000.
- `mode` (`string`, optional): How the URL carries modifications: encoded (one base64 blob) or named_params (one query parameter per layer). Example: named_params. One of: `encoded`, `named_params`.
- `rate_limit` (`boolean`, optional): Whether to apply Bannerbear's per-URL rate limit to renders from this Instant URL. Example: true.
- `scale` (`integer`, optional): Output scale multiplier for higher resolution: 1, 2, 3 or 4. Example: 1. One of: `1`, `2`, `3`, `4`.
- `security` (`string`, optional): signed requires each URL to carry an HMAC signature made with the signing key; open accepts any URL. Example: signed. One of: `signed`, `open`.
- `status` (`string`, optional): Whether the object is active or disabled. Example: active. One of: `active`, `disabled`.
- `template_version` (`integer`, optional): Pin the Instant URL to this template version number. Omit to always use the latest version. Example: 3.

Example input: `{"name":"<name>","template":"<template>"}`

### `bannerbear_instant_url_update`

Update Instant URL · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, required): Display name, shown in the Bannerbear dashboard. Example: Instagram quote card.
- `template` (`string`, required): UID of the image template to render. Example: A89wavQyY3Bebk3djP.
- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
- `expires_at` (`string`, optional): ISO 8601 date-time after which the Instant URL stops rendering. Example: 2026-12-31T23:59:59Z.
- `max_renders` (`integer`, optional): Maximum number of renders this Instant URL may produce before it stops. Example: 1000.
- `mode` (`string`, optional): How the URL carries modifications: encoded (one base64 blob) or named_params (one query parameter per layer). Example: named_params. One of: `encoded`, `named_params`.
- `rate_limit` (`boolean`, optional): Whether to apply Bannerbear's per-URL rate limit to renders from this Instant URL. Example: true.
- `scale` (`integer`, optional): Output scale multiplier for higher resolution: 1, 2, 3 or 4. Example: 1. One of: `1`, `2`, `3`, `4`.
- `security` (`string`, optional): signed requires each URL to carry an HMAC signature made with the signing key; open accepts any URL. Example: signed. One of: `signed`, `open`.
- `status` (`string`, optional): Whether the object is active or disabled. Example: active. One of: `active`, `disabled`.
- `template_version` (`integer`, optional): Pin the Instant URL to this template version number. Omit to always use the latest version. Example: 3.

Example input: `{"name":"<name>","template":"<template>","uid":"<uid>"}`

### `bannerbear_publication_install`

Install Publication · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_recipe_install`

Install Recipe · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): The recipe's uid or slug. Get it from List Recipes. Example: linkedin-hiring-post.

Example input: `{"id":"<id>"}`

### `bannerbear_tool_concat_videos`

Join Videos · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `video_urls` (`array`, required): Two or more URLs in play order. Example: ["https://example.com/videos/a.mp4", "https://example.com/videos/b.mp4"].
- `fps` (`integer`, optional): Defaults to the highest frame rate among the inputs, capped at 60. Example: 30.
- `height` (`integer`, optional): Canvas height in pixels. Example: 1080.
- `metadata` (`string`, optional): 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.
- `transition` (`string`, optional): How each clip flows into the next. Defaults to none. Example: fade. One of: `none`, `fade`, `dissolve`, `wipeleft`, `slideleft`.
- `transition_duration` (`number`, optional): Only used when transition is set. Defaults to 1. Example: 0.5.
- `width` (`integer`, optional): Canvas width in pixels. Example: 1080.

Example input: `{"video_urls":["https://example.com/videos/a.mp4","https://example.com/videos/b.mp4"]}`

### `bannerbear_tool_create_pdf`

Create Multi-page PDF · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `urls` (`array`, required): 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"].
- `metadata` (`string`, optional): 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.

Example input: `{"urls":["https://example.com/page1.png","https://example.com/page2.png"]}`

### `bannerbear_tool_extract_article`

Extract Article · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `url` (`string`, required): Public URL of the article page to extract. Example: https://example.com/blog/launch-announcement.
- `metadata` (`string`, optional): 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.

Example input: `{"url":"<url>"}`

### `bannerbear_tool_generate_ai_image`

Generate AI Image · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `model` (`string`, required): Costs vary by model — see the credit cost shown for each. Example: flux_schnell. One of: `flux_schnell`, `flux_1_1_pro`, `nano_banana`, `gpt_image_2`.
- `prompt` (`string`, required): What to generate — describe the subject, style and composition. Example: A flat illustration of a coffee cup on a desk, pastel colors.
- `aspect_ratio` (`string`, optional): Defaults to square. Example: 1:1. One of: `1:1`, `16:9`, `9:16`, `4:3`, `3:4`.
- `metadata` (`string`, optional): 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_url` (`string`, optional): Optional starting point — only some models accept one. Example: https://example.com/photos/reference.jpg.

Example input: `{"model":"flux_schnell","prompt":"<prompt>"}`

### `bannerbear_tool_generate_text`

Generate Text · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `prompt` (`string`, required): 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_characters` (`integer`, optional): The text is never longer than this. Example: 280.
- `metadata` (`string`, optional): 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.

Example input: `{"prompt":"<prompt>"}`

### `bannerbear_tool_pdf_to_image`

PDF to Image · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `pdf_url` (`string`, required): PDF URL. Example: https://example.com/docs/brochure.pdf.
- `dpi` (`integer`, optional): 72 to 300. 300 suits print, 72 to 150 suits screens. Example: 300.
- `format` (`string`, optional): Format. Example: png. One of: `png`, `jpg`.
- `metadata` (`string`, optional): 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.
- `pages` (`string`, optional): All pages makes one image per page, up to 20. Example: first. One of: `first`, `all`.

Example input: `{"pdf_url":"<pdf_url>"}`

### `bannerbear_tool_remove_background`

Remove Background · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `image_url` (`string`, required): Public URL of the image to cut out. Example: https://example.com/photos/product.jpg.
- `metadata` (`string`, optional): 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.

Example input: `{"image_url":"<image_url>"}`

### `bannerbear_tool_trim_video`

Trim Video · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `end` (`number`, required): End (seconds). Example: 20.
- `start` (`number`, required): Start (seconds). Example: 5.
- `video_url` (`string`, required): Video URL. Example: https://example.com/videos/clip.mp4.
- `metadata` (`string`, optional): 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.

Example input: `{"end":20,"start":5,"video_url":"<video_url>"}`

### `bannerbear_tool_video_thumbnails`

Video Thumbnails · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `video_url` (`string`, required): Video URL. Example: https://example.com/videos/clip.mp4.
- `count` (`integer`, optional): How many frames to grab, up to 10. Example: 4.
- `interval` (`number`, optional): Seconds between frames — fractions are fine, 0.5 for two a second. Example: 10.
- `metadata` (`string`, optional): 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.
- `start` (`number`, optional): Where the first frame is taken. Example: 5.

Example input: `{"video_url":"<video_url>"}`

### `bannerbear_webhook_create`

Create Webhook · Write

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).

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Name of the webhook, shown in the dashboard. Example: Image completed hook.
- `url` (`string`, required): URL to receive webhook events. Example: https://example.com/webhooks/bannerbear.
- `event` (`string`, optional): Event type to trigger on. Example: completed. One of: `all_events`, `completed`, `failed`.
- `resource` (`string`, optional): Resource type to trigger on. Example: image. One of: `image`, `batch`, `tool_job`, `workflow_run`, `animation`.
- `status` (`string`, optional): Whether the object is active or disabled. Example: active. One of: `active`, `disabled`.

Example input: `{"name":"<name>","url":"<url>"}`

### `bannerbear_webhook_update`

Update Webhook · Write

Update a webhook's name, URL, resource, event or status.
Returns the updated webhook.
Set status to disabled to pause deliveries without deleting it.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, required): Name of the webhook, shown in the dashboard. Example: Image completed hook.
- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
- `url` (`string`, required): URL to receive webhook events. Example: https://example.com/webhooks/bannerbear.
- `event` (`string`, optional): Event type to trigger on. Example: completed. One of: `all_events`, `completed`, `failed`.
- `resource` (`string`, optional): Resource type to trigger on. Example: image. One of: `image`, `batch`, `tool_job`, `workflow_run`, `animation`.
- `status` (`string`, optional): Whether the object is active or disabled. Example: active. One of: `active`, `disabled`.

Example input: `{"name":"<name>","uid":"<uid>","url":"<url>"}`

### `bannerbear_workflow_create`

Create Workflow · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Display name, shown in the Bannerbear dashboard. Example: Product photo to social card.
- `description` (`string`, optional): Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
- `inputs` (`object`, optional): 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}}.
- `steps` (`array`, optional): 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}}"}}].
- `tags` (`array`, optional): List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].

Example input: `{"name":"<name>"}`

### `bannerbear_workflow_run_create`

Run Workflow · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `workflow` (`string`, required): UID of the workflow to run. Get it from List Workflows. Example: rZdpMYmAnDB1zb3kXL.
- `inputs` (`object`, optional): 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"}.
- `metadata` (`string`, optional): 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.

Example input: `{"workflow":"<workflow>"}`

### `bannerbear_workflow_update`

Update Workflow · Write

Update a workflow's name, description, tags, inputs or steps.
Returns the updated workflow.
Use Get Workflow first to see the current steps.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.
- `description` (`string`, optional): Free-text description, shown in the Bannerbear dashboard. Example: Square card used for weekly social posts.
- `inputs` (`object`, optional): 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}}.
- `name` (`string`, optional): Display name, shown in the Bannerbear dashboard. Example: Product photo to social card.
- `steps` (`array`, optional): 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}}"}}].
- `tags` (`array`, optional): List of tags applied to the object, used to group and filter in the dashboard. Example: ["social"].

Example input: `{"uid":"<uid>"}`

### `bannerbear_animation_template_delete`

Delete Animation Template · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_image_template_delete`

Delete Image Template · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_instant_url_delete`

Delete Instant URL · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_webhook_delete`

Delete Webhook · Destructive

Permanently delete a webhook by its uid. This cannot be undone.
Returns an empty response on success.
Use List to find the uid first.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

### `bannerbear_workflow_delete`

Delete Workflow · Destructive

Permanently delete a workflow by its uid. This cannot be undone.
Returns an empty response on success.
Use List to find the uid first.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `uid` (`string`, required): Bannerbear unique ID (uid) of the object, returned when it was created or listed. Example: 672PdQlVyD1ynEKGOL.

Example input: `{"uid":"<uid>"}`

## Related

Other Design connectors ([all 34](/agentkit/connectors/?category=design)):

- [Figma](/agentkit/connectors/figma/): Scalekit connector, OAuth, 54 tools
- [Miro](/agentkit/connectors/miro/): Scalekit connector, OAuth, 115 tools
- [Mural](/agentkit/connectors/mural/): Scalekit connector, OAuth, 61 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
