- Category: images & design
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 33
- Triggers: 0
- Slug:
BANNERBEAR - Version: 20261101_00
Tools
Create Project
Create Project
BANNERBEAR_CREATE_PROJECTCreates a new Bannerbear project with the specified name and optional settings. Use this tool to create new projects for organizing templates and API resources. Note: This action requires a Master API Key. Project-specific API keys cannot create new projects.Input Parameters
Output
Create Signed Base
Create Signed Base
BANNERBEAR_CREATE_SIGNED_BASETool to create a signed URL base for a template. Used for generating images via signed URLs. Signed bases enable on-demand image generation using encrypted URL parameters without requiring API calls for each image. Use when you need to create dynamic images through URL manipulation.Input Parameters
Output
Create Template
Create Template
BANNERBEAR_CREATE_TEMPLATECreate a new blank template in a Bannerbear project. Use when you need to programmatically create templates via API. Note: Templates can only be created via API if you have a Master API Key.Input Parameters
Output
Create Template Set
Create Template Set
BANNERBEAR_CREATE_TEMPLATE_SETTool to create a new template set by grouping multiple templates together. Use when you need to organize related templates into a single set for batch image generation. Template sets allow you to apply the same modifications to multiple templates simultaneously via a single API call.Input Parameters
Output
Create Video Template
Create Video Template
BANNERBEAR_CREATE_VIDEO_TEMPLATETool to create a new video template for video generation in Bannerbear. Video templates are based on existing image templates and hold additional rendering instructions for creating videos. Use when you need to set up a reusable template for generating videos with overlays, transcriptions, or multi-layer video compositions.Input Parameters
Output
Create Webhook
Create Webhook
BANNERBEAR_CREATE_WEBHOOKCreate a project-level webhook that fires for all events of a specific type. Use this tool to register a URL that will receive POST requests when events occur in your Bannerbear project. Note: When using a Master API Key, you must provide a project_id parameter. Project API Keys do not require project_id.Input Parameters
Output
Delete Template
Delete Template
Delete Webhook
Delete Webhook
Get Account Info
Get Account Info
BANNERBEAR_GET_ACCOUNT_INFORetrieves Bannerbear account information including subscription plan, API usage, and quota limits. Use this tool to: - Check current API usage and remaining quota (resets monthly) - Verify the subscription plan - Get details about the current project Note: When using a Master API Key, you must provide a project_id parameter. Project API Keys do not require project_id.Input Parameters
Output
Get Animated GIF
Get Animated GIF
BANNERBEAR_GET_ANIMATED_GIFTool to retrieve a single Animated Gif object by its unique identifier (UID). Use when you need to check the status of a specific animated GIF, get its rendered URL, or retrieve detailed information about its configuration. The status field indicates the rendering progress: ‘pending’ (still processing), ‘completed’ (ready with image_url populated), or ‘failed’. Poll this endpoint to monitor rendering progress, or use webhook_url for automatic notifications.Input Parameters
Output
Get Auth Status
Get Auth Status
BANNERBEAR_GET_AUTHVerify API authentication and check which project the API key is scoped to. Use this to validate credentials before making other API calls or to confirm the project context.Input Parameters
Output
Get Available Fonts
Get Available Fonts
BANNERBEAR_GET_FONTSThis 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.Input Parameters
Output
Get Image
Get Image
BANNERBEAR_GET_IMAGERetrieves a single Image object by its unique identifier (UID). Use this to check the status of an image generation request, retrieve the final image URL, or poll for completion. When using a Master API Key, you must provide the project_id parameter.Input Parameters
Output
Get Project
Get Project
Get Screenshot
Get Screenshot
BANNERBEAR_GET_SCREENSHOTRetrieve a single Screenshot object referenced by its unique ID. Use when you need to check the status or get the final screenshot URL for a previously created screenshot.Input Parameters
Output
Get Signed Bases
Get Signed Bases
BANNERBEAR_GET_SIGNED_BASESThis 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.Input Parameters
Output
Get Template
Get Template
BANNERBEAR_GET_TEMPLATERetrieve a template by its unique ID, including its dimensions and available modifications. An extended response can be requested.Input Parameters
Output
Get Template Set Details
Get Template Set Details
BANNERBEAR_GET_TEMPLATE_SETThis 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.Input Parameters
Output
Get Webhook
Get Webhook
BANNERBEAR_GET_WEBHOOKRetrieves a single Webhook object by its unique ID. Use this to get details about a specific webhook including its URL, event type, and creation timestamp.Input Parameters
Output
Hydrate Project
Hydrate Project
BANNERBEAR_HYDRATE_PROJECTHydrates a project by copying all templates from a source project or selected templates by UID. The source templates and destination project must belong to the same account.Input Parameters
Output
Import Template
Import Template
BANNERBEAR_IMPORT_TEMPLATEImports publicly available templates into a project using publication IDs from the Bannerbear library or shared publications. Repeating an import can create duplicate templates.Input Parameters
Output
Join PDFs
Join PDFs
BANNERBEAR_JOIN_PDFSMerges multiple PDF files into a single combined PDF document. This tool accepts an array of publicly accessible PDF URLs and combines them in order into one merged PDF file. The operation is asynchronous - the response will initially have status ‘pending’ and you should poll the ‘self’ endpoint or use a webhook to get the final ‘joined_pdf_url’ when status becomes ‘completed’. Note: When using a Master API Key (account-level key), you must provide the project_id parameter.Input Parameters
Output
List Animated GIFs
List Animated GIFs
BANNERBEAR_LIST_ANIMATED_GIFSLists all animated GIFs in a Bannerbear project. Retrieves a paginated list of all animated GIFs that have been created in your Bannerbear project. When using a Master API Key, you must provide the project_id parameter. Returns up to 25 animated GIFs per page by default, configurable up to 100 using the limit parameter.Input Parameters
Output
List Collections
List Collections
BANNERBEAR_LIST_COLLECTIONSLists a page of collections in a Bannerbear project. A project ID is required for this tool, including when using a project API key; page and limit can be supplied.Input Parameters
Output
List Effects
List Effects
BANNERBEAR_LIST_EFFECTSTool to list all available image effects in Bannerbear. Use when you need to discover which effects can be applied to images or templates in the Bannerbear API.Input Parameters
Output
List Images
List Images
BANNERBEAR_LIST_IMAGESLists all images in a Bannerbear project. Retrieves a paginated list of all images that have been created in your Bannerbear project. When using a Master API Key, you must provide the project_id parameter. Returns up to 25 images per page by default, configurable up to 100 using the limit parameter.Input Parameters
Output
List Projects
List Projects
BANNERBEAR_LIST_PROJECTSLists all projects in a Bannerbear account. This action retrieves a paginated list of all projects in your Bannerbear account. Use when you need to discover available projects or obtain project UIDs for other actions. Requires a Master API Key (not a project-specific API key).Input Parameters
Output
List Screenshots
List Screenshots
BANNERBEAR_LIST_SCREENSHOTSLists all screenshots in a Bannerbear project. Retrieves a paginated list of all screenshots that have been created in your Bannerbear project. When using a Master API Key, you must provide the project_id parameter. Returns up to 25 screenshots per page by default, configurable up to 100 using the limit parameter.Input Parameters
Output
List Templates
List Templates
BANNERBEAR_LIST_TEMPLATESList templates in a Bannerbear project, with pagination and optional tag or partial-name filters. Results include template UIDs, names, dimensions, preview URLs, timestamps and available modifications.Input Parameters
Output
List Template Sets
List Template Sets
BANNERBEAR_LIST_TEMPLATE_SETSTool to list all template sets inside a project with pagination support. Template Sets are groups of Templates that you organize in the Bannerbear dashboard. Use when you need to retrieve all template sets or paginate through them.Input Parameters
Output
List Videos
List Videos
BANNERBEAR_LIST_VIDEOSList a page of videos in a Bannerbear project. Results include video status, timestamps, video and preview URLs, and template and modification details.Input Parameters
Output
List Video Templates
List Video Templates
BANNERBEAR_LIST_VIDEO_TEMPLATESThis action retrieves a list of all video templates available in your Bannerbear project. It returns an array of video template objects including properties like uid, name, dimensions, and creation timestamps. The tool is used for listing video templates and retrieving template UIDs for subsequent video creation actions.Input Parameters
Output
Update Template Set
Update Template Set
BANNERBEAR_UPDATE_TEMPLATE_SETTool to update a template set by modifying its list of templates. The template set will be cleared first and the new list applied. Use when you need to change which templates are included in a template set. Template Sets are sets of Templates that you group together in the Bannerbear dashboard.