Workflow Automation

Bannerbear

Learn how to use Bannerbear with Composio

Overview

SLUG: BANNERBEAR

Description

Bannerbear offers an automated image and video generation API, allowing businesses to create graphics, social media visuals, and marketing collateral with customizable templates at scale

Authentication Details

full
stringDefaults to https://api.bannerbear.comRequired
generic_api_key
stringRequired

Connecting to Bannerbear

Create an auth config

Use the dashboard to create an auth config for the Bannerbear toolkit. This allows you to connect multiple Bannerbear accounts to Composio for agents to use.

1

Select App

Navigate to Bannerbear.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Bannerbear Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4bannerbear_auth_config_id = "ac_YOUR_BANNERBEAR_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10    # Replace this with a method to retrieve an API key from the user.
11    # Or supply your own.
12    user_api_key = input("[!] Enter API key")
13
14    connection_request = composio.connected_accounts.initiate(
15        user_id=user_id,
16        auth_config_id=auth_config_id,
17        config={"auth_scheme": "API_KEY", "val": user_api_key}
18    )
19
20    # API Key authentication is immediate - no redirect needed
21    print(f"Successfully connected Bannerbear for user {user_id}")
22    print(f"Connection status: {connection_request.status}")
23    
24    return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, bannerbear_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Bannerbear toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["BANNERBEAR"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Get Account Info

Description

This tool allows you to check your bannerbear account status, including quota levels and current usage. the endpoint returns information about your account status, paid plan, api usage, and quota.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Available Fonts

Description

This tool retrieves a list of all available fonts in bannerbear. the fonts are categorized into serif, sans serif, novelty, international, and custom, and can be used to verify font availability prior to creating or modifying images.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signed Bases

Description

This tool retrieves a list of signed bases for a specific template. signed bases are used to generate on-demand images using encrypted url parameters. the endpoint returns a list of base urls that can be used with the signed url feature.

Action Parameters

template_uid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Template Set Details

Description

This tool retrieves detailed information about a specific template set using its unique identifier (uid). template sets are sets of templates that you group together in the bannerbear dashboard. it provides comprehensive details about the template set including its name, available modifications, and the list of templates inside the set.

Action Parameters

uid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Join PDFs

Description

This tool allows users to merge multiple pdf files into a single pdf document by accepting an array of pdf urls, sending a post request to the bannerbear api, and returning the unique identifier, status, and url of the merged pdf.

Action Parameters

pdf_urls
arrayRequired
webhook_url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Images

Description

Lists all images inside a bannerbear project. this endpoint allows you to retrieve a paginated list of all images that have been created in your project.

Action Parameters

limit
integer
page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Templates

Description

This action retrieves a list of all templates available in your bannerbear project. it returns an array of template objects including properties like uid, name, dimensions, creation and update timestamps, template type, preview url, and modifications. the tool is used for listing templates, retrieving template uids for subsequent actions such as image or video creation, and managing project templates.

Action Parameters

extended
boolean
limit
integer
name
string
page
integer
tag
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Videos

Description

This action retrieves a list of all videos created in your bannerbear account. it returns an array of video objects including properties like uid, status, timestamps, video and preview urls, as well as template and modification details. the tool is used for listing videos, monitoring video status, and managing project videos.

Action Parameters

limit
integer
page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired