Skip to main content
Bannerbear logo
  • Category: images & design
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 33
  • Triggers: 0
  • Slug: BANNERBEAR
  • Version: 20261101_00

Tools

Slug: 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

string
required
The name of the new project.
boolean
Enable or disable the project image proxy. When enabled, images are served through Bannerbear’s proxy.
boolean
Enable or disable web sessions for the project. Web sessions allow capturing screenshots of web pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The UID of the project. Required when using a Master API Key. Can be obtained from the Get Account Info action or project settings.
string
required
The unique identifier of the template to create a signed base for. Use the List Templates action to get available template UIDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the new blank template.
array
An array of tags for this template. Used for organizing and filtering templates.
integer
required
The width of the new blank template in pixels.
integer
required
The height of the new blank template in pixels.
string
Storage for custom data (e.g., database IDs). Can be used to associate the template with external systems.
string
required
The project ID where the template will be created. Required when using Master API Key. Can be obtained from project settings or by listing projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
A name for the template set. This helps identify and organize your template sets.
array
required
Array of template UIDs to include in the template set. Must contain at least one template UID. Template UIDs can be obtained from the List Templates action.
string
required
The project UID to create the template set in. Required when using a Master API Key. Project UIDs can be obtained from the project settings or by listing projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The image template UID on which to base this video template. This template provides the visual layers and structure for the video.
string
Required when using a Master API Key - the project UID where the video template will be created. Can be omitted when using a project-specific API key.
string ("overlay" | "transcribe" | "multi_overlay")
required
Specifies the Build Pack type for rendering videos: ‘overlay’ adds video/images onto template layers, ‘transcribe’ auto-transcribes speech and applies text to layers, ‘multi_overlay’ supports multiple video layers.
boolean
Whether to require approval before rendering videos from this template. Only applies to the ‘transcribe’ Build Pack.
string
The name of the text layer where transcribed text will be applied. Only applies to the ‘transcribe’ Build Pack.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The external webhook receiver URL you want to register. This URL will receive POST requests when the specified event occurs.
string ("template_created" | "template_edited" | "image_created" | "collection_created" | "video_created" | "animated_gif_created" | "movie_created" | "screenshot_created")
required
The event type to register this URL to. The webhook will fire when this event occurs in the project.
string
The project UID to create the webhook for. Required when using a Master API Key. If using a project-specific API key, this can be omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BANNERBEAR_DELETE_TEMPLATEPermanently delete a template from a Bannerbear project by its unique ID. A project ID is required.

Input Parameters

string
required
The unique identifier (UID) of the template to delete.
string
required
The project ID. Required when using a Master API Key to specify which project the template belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BANNERBEAR_DELETE_WEBHOOKDelete a webhook by its unique ID. A project ID is required.

Input Parameters

string
required
The webhook uid that you want to delete.
string
required
The project ID (required when using Master API Key). Can be obtained from the project settings or by listing projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The UID of the project to get account info for. Required when using a Master API Key. Can be obtained from the project settings or by listing projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (UID) of the animated GIF to retrieve.
string
The project ID. Required when using a Master API Key to specify which project to access. You can get this from the BANNERBEAR_LIST_PROJECTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Required when using a Master API Key. Must be a valid project UID. Not required for Project API Keys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The unique identifier (UID) of the Bannerbear project. Required when using a Master API Key (keys starting with ‘bb_ma_’). Can be obtained from the project settings or by listing projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (UID) of the image to retrieve.
string
The UID of the Bannerbear project. Required when using a Master API Key. You can get this from the BANNERBEAR_LIST_PROJECTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BANNERBEAR_GET_PROJECTRetrieves a Bannerbear project by UID, including its name, creation date, template count, and feature settings. Requires a Master API Key.

Input Parameters

string
required
The project uid that you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The screenshot uid that you want to retrieve.
string
Required when using Master API Key. The project ID to scope the request to. Can be obtained from the project settings or by listing projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page of results to retrieve. The API returns 25 items per page.
string
The UID of the project. Required when using a Master API Key. Can be obtained from the Get Account Info action or project settings.
string
required
The unique identifier of the template to retrieve signed bases for. Use the List Templates action to get available template UIDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BANNERBEAR_GET_TEMPLATERetrieve a template by its unique ID, including its dimensions and available modifications. An extended response can be requested.

Input Parameters

string
required
The unique identifier (UID) of the template to retrieve.
boolean
Set to true to return an extended response including current layer defaults for the template.
string
The project UID. Required when using a Master API Key. If using a project-specific API key, this can be omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier (UID) of the template set to retrieve.
string
The project ID. Required when using a Master API Key to specify which project to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The webhook uid that you want to retrieve.
string
The UID of the project. Required when using a Master API Key. Can be obtained from the project settings or by listing projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The UID of the project to hydrate (the destination project that will receive the templates).
string
The UID of the project to copy templates from (the source project). Must be under the same account as the destination project. Either ‘source’ or ‘templates’ must be provided, but not both.
array
Optional array of specific template UIDs to copy. If provided, the ‘source’ parameter will be ignored. Either ‘source’ or ‘templates’ must be provided, but not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The project UID to import the template into. Required when using a Master API Key. If using a project-specific API key, this can be omitted.
array
required
An array of Publication IDs to import into this project. Publication IDs are the IDs of publicly-available templates either from the library or shared by other users. Cannot use private template IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
List of URLs to publicly accessible PDF files that need to be merged. Each URL must point to a valid PDF document.
string
The unique identifier (uid) of the Bannerbear project. Required when using a Master API Key. Can be obtained from the Bannerbear dashboard or by listing projects via the API.
string
Optional webhook URL to receive a POST notification when merging is complete. The webhook will receive the join operation response payload.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. The API returns 25 items per page by default.
integer
Number of items per page (default 25, max 100).
string
The UID of the Bannerbear project. Required when using a Master API Key. You can get this from the BANNERBEAR_LIST_PROJECTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page of results you would like to retrieve. The API returns 25 items per page by default.
integer
The number of items per page (default 25, max 100).
string
required
The UID of the Bannerbear project. Required when using a Master API Key. You can get this from the BANNERBEAR_LIST_PROJECTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The UID of the Bannerbear project. Required when using a Master API Key (keys starting with ‘bb_ma_’). Can be obtained from the project settings or by listing projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page of results you would like to retrieve. The API returns 25 items per page.
integer
The number of items per page (default 25, max 100).
string
The UID of the Bannerbear project. Required when using a Master API Key. You can get this from the BANNERBEAR_LIST_PROJECTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination (25 items per page by default).
integer
Number of items per page (default 25, max 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page of results you would like to retrieve. The API returns 25 items per page.
integer
The number of items per page (default 25, max 100).
string
The UID of the Bannerbear project. Required when using a Master API Key. You can get this from the BANNERBEAR_LIST_PROJECTS action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter templates by a specific tag. Only templates with this tag will be returned.
string
Filter templates by partial name match. Returns templates whose name contains this string.
integer
The page of results to retrieve. The API returns 25 items per page by default.
integer
Number of templates to return per page. Defaults to 25, maximum is 100.
boolean
Set to true to return an extended response including current layer defaults for each template.
string
The project UID to list templates from. Required when using a Master API Key. If using a project-specific API key, this can be omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page of results to retrieve. The API returns 25 items per page by default.
integer
Number of template sets to return per page. Defaults to 25, maximum is 100.
string
The project ID to list template sets from. Required when using a Master API Key. If using a project-specific API key, this can be omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page of results to retrieve. The API returns 25 items per page.
integer
The API returns 25 items per page by default but you can request up to 100 using this parameter.
string
The project ID to list videos from. Required when using a Master API Key. Can be obtained from the Bannerbear dashboard or via the list projects endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
The page of results to retrieve. The API returns 25 items per page by default.
integer
Number of video templates to return per page. Defaults to 25, maximum is 100.
string
required
The project ID to list video templates from. Required when using a Master API Key. Can be obtained from the Bannerbear dashboard or via the list projects endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
required
The unique identifier (UID) of the template set to update.
array
required
List of template UIDs to include in the set. The template set will be cleared first and the new list applied.
string
The project ID. Required when using a Master API Key to specify which project to access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not