View as Markdown
Bannerbear icon

Bannerbear ACTION

Create Collection

Generates multiple Images based on a Template Set. See the docs here.
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Bannerbear account once, then configure and run Create Collection from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "bannerbear-create-collection",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bannerbear: { authProvisionId: "apn_xxxxxxx" },
    templateSet: "Template Set UID",
    modifications: "Modifications",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Collection inputs
Property Type Description
templateSet Template Set UID string
The template set UID that you want to use.
Required Dynamic
modifications Modifications string
A list of modifications you want to make. See Create an image for more details on the child parameters. Unlike an Image the modifications list is not always required for a Video, for example: [{"name": "message", "text": "test message"}].
Required
webhookUrl Webhook URL string
A url to POST the full Animated Gif object to upon rendering completed.
Optional
metadata Metadata string
Any metadata that you need to store e.g. ID of a record in your DB.
Optional
transparent Transparent boolean
Render the collection with a transparent background. Default is false.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
bannerbear-create-collection
Version
0.0.2
App
Bannerbear
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes