Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Bannerbear

Scalekit connector
Open markdown

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

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  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.

  4. Authorize a user and make your first call

    quickstart.mts
    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)
    Terminal window
    npx tsx quickstart.mts

    Each 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 to execute_tool
Try in PlaygroundRequest a tool
  • bannerbear_account_getGet the Bannerbear workspace and account tied to the API key.Read-only

    Get 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-only

    Get 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-only

    Get 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-only

    List 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-only

    List 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-only

    Get 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-only

    List 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-only

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