# Bannerbear

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

- **Category:** images & design
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 33
- **Triggers:** 0
- **Slug:** `BANNERBEAR`
- **Version:** 20260225_00

## Tools

### Create Project

**Slug:** `BANNERBEAR_CREATE_PROJECT`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the new project. |
| `image_proxy` | boolean | No | Enable or disable the project image proxy. When enabled, images are served through Bannerbear's proxy. |
| `web_sessions` | boolean | No | Enable or disable web sessions for the project. Web sessions allow capturing screenshots of web pages. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Signed Base

**Slug:** `BANNERBEAR_CREATE_SIGNED_BASE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | No | The UID of the project. Required when using a Master API Key. Can be obtained from the Get Account Info action or project settings. |
| `template_uid` | string | Yes | The unique identifier of the template to create a signed base for. Use the List Templates action to get available template UIDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Template

**Slug:** `BANNERBEAR_CREATE_TEMPLATE`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the new blank template. |
| `tags` | array | No | An array of tags for this template. Used for organizing and filtering templates. |
| `width` | integer | Yes | The width of the new blank template in pixels. |
| `height` | integer | Yes | The height of the new blank template in pixels. |
| `metadata` | string | No | Storage for custom data (e.g., database IDs). Can be used to associate the template with external systems. |
| `project_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Template Set

**Slug:** `BANNERBEAR_CREATE_TEMPLATE_SET`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A name for the template set. This helps identify and organize your template sets. |
| `templates` | array | Yes | 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. |
| `project_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Video Template

**Slug:** `BANNERBEAR_CREATE_VIDEO_TEMPLATE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template` | string | Yes | The image template UID on which to base this video template. This template provides the visual layers and structure for the video. |
| `project_id` | string | No | 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. |
| `render_type` | string ("overlay" | "transcribe" | "multi_overlay") | Yes | 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. |
| `approval_required` | boolean | No | Whether to require approval before rendering videos from this template. Only applies to the 'transcribe' Build Pack. |
| `transcription_layer_name` | string | No | The name of the text layer where transcribed text will be applied. Only applies to the 'transcribe' Build Pack. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook

**Slug:** `BANNERBEAR_CREATE_WEBHOOK`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The external webhook receiver URL you want to register. This URL will receive POST requests when the specified event occurs. |
| `event` | string ("template_created" | "template_edited" | "image_created" | "collection_created" | "video_created" | "animated_gif_created" | "movie_created" | "screenshot_created") | Yes | The event type to register this URL to. The webhook will fire when this event occurs in the project. |
| `project_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Template

**Slug:** `BANNERBEAR_DELETE_TEMPLATE`

Tool to delete a template referenced by its unique ID. Use when you need to permanently remove a template from a Bannerbear project. Note: This action requires a project_id when using a Master API Key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | The unique identifier (UID) of the template to delete. |
| `project_id` | string | Yes | The project ID. Required when using a Master API Key to specify which project the template belongs to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `BANNERBEAR_DELETE_WEBHOOK`

Tool to delete a webhook referenced by its unique ID. Use when you need to remove a webhook that is no longer needed. Requires the webhook UID and project ID (when using Master API Key).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | The webhook uid that you want to delete. |
| `project_id` | string | Yes | The project ID (required when using Master API Key). Can be obtained from the project settings or by listing projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Info

**Slug:** `BANNERBEAR_GET_ACCOUNT_INFO`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Animated GIF

**Slug:** `BANNERBEAR_GET_ANIMATED_GIF`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | The unique identifier (UID) of the animated GIF to retrieve. |
| `project_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Auth Status

**Slug:** `BANNERBEAR_GET_AUTH`

Verify 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | No | Required when using a Master API Key. Must be a valid project UID. Not required for Project API Keys. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Available Fonts

**Slug:** `BANNERBEAR_GET_FONTS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Image

**Slug:** `BANNERBEAR_GET_IMAGE`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | The unique identifier (UID) of the image to retrieve. |
| `project_id` | string | No | The UID of the Bannerbear project. Required when using a Master API Key. You can get this from the BANNERBEAR_LIST_PROJECTS action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `BANNERBEAR_GET_PROJECT`

Retrieves detailed information about a specific Bannerbear project by its unique identifier (UID). Use this tool to get project details including name, creation date, template count, and feature settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | The project uid that you want to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Screenshot

**Slug:** `BANNERBEAR_GET_SCREENSHOT`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | The screenshot uid that you want to retrieve. |
| `project_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Signed Bases

**Slug:** `BANNERBEAR_GET_SIGNED_BASES`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template

**Slug:** `BANNERBEAR_GET_TEMPLATE`

Tool to retrieve a single template by its unique ID with layer defaults. Use when you need to get detailed information about a specific template including its dimensions, available modifications, and layer structure.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template Set Details

**Slug:** `BANNERBEAR_GET_TEMPLATE_SET`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | The unique identifier (UID) of the template set to retrieve. |
| `project_id` | string | No | The project ID. Required when using a Master API Key to specify which project to access. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook

**Slug:** `BANNERBEAR_GET_WEBHOOK`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | The webhook uid that you want to retrieve. |
| `project_id` | string | No | The UID of the project. Required when using a Master API Key. Can be obtained from the project settings or by listing projects. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Hydrate Project

**Slug:** `BANNERBEAR_HYDRATE_PROJECT`

Hydrate a project by copying templates from another project. Useful for white-label setups where you need to duplicate templates across multiple projects. Both the source and destination projects must be under the same account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | The UID of the project to hydrate (the destination project that will receive the templates). |
| `source` | string | No | 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. |
| `templates` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Template

**Slug:** `BANNERBEAR_IMPORT_TEMPLATE`

Tool to import templates from the Bannerbear template library or from other projects. Use when you need to add publicly-available templates to your project. Note: Only publication IDs (public templates) can be imported, not private template IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | No | 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. |
| `publications` | array | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Join PDFs

**Slug:** `BANNERBEAR_JOIN_PDFS`

Merges 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pdf_urls` | array | Yes | List of URLs to publicly accessible PDF files that need to be merged. Each URL must point to a valid PDF document. |
| `project_id` | string | No | 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. |
| `webhook_url` | string | No | Optional webhook URL to receive a POST notification when merging is complete. The webhook will receive the join operation response payload. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Animated GIFs

**Slug:** `BANNERBEAR_LIST_ANIMATED_GIFS`

Lists 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Collections

**Slug:** `BANNERBEAR_LIST_COLLECTIONS`

Lists all collections in a Bannerbear project. Retrieves a paginated list of all collections 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 collections per page by default, configurable up to 100 using the limit parameter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results you would like to retrieve. The API returns 25 items per page by default. |
| `limit` | integer | No | The number of items per page (default 25, max 100). |
| `project_id` | string | Yes | The UID of the Bannerbear project. Required when using a Master API Key. You can get this from the BANNERBEAR_LIST_PROJECTS action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Effects

**Slug:** `BANNERBEAR_LIST_EFFECTS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Images

**Slug:** `BANNERBEAR_LIST_IMAGES`

Lists 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Projects

**Slug:** `BANNERBEAR_LIST_PROJECTS`

Lists 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (25 items per page by default). |
| `limit` | integer | No | Number of items per page (default 25, max 100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Screenshots

**Slug:** `BANNERBEAR_LIST_SCREENSHOTS`

Lists 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `BANNERBEAR_LIST_TEMPLATES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Filter templates by a specific tag. Only templates with this tag will be returned. |
| `name` | string | No | Filter templates by partial name match. Returns templates whose name contains this string. |
| `page` | integer | No | The page of results to retrieve. The API returns 25 items per page by default. |
| `limit` | integer | No | Number of templates to return per page. Defaults to 25, maximum is 100. |
| `extended` | boolean | No | Set to true to return an extended response including current layer defaults for each template. |
| `project_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Template Sets

**Slug:** `BANNERBEAR_LIST_TEMPLATE_SETS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to retrieve. The API returns 25 items per page by default. |
| `limit` | integer | No | Number of template sets to return per page. Defaults to 25, maximum is 100. |
| `project_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Videos

**Slug:** `BANNERBEAR_LIST_VIDEOS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to retrieve. The API returns 25 items per page. |
| `limit` | integer | No | The API returns 25 items per page by default but you can request up to 100 using this parameter. |
| `project_id` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Video Templates

**Slug:** `BANNERBEAR_LIST_VIDEO_TEMPLATES`

This 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page of results to retrieve. The API returns 25 items per page by default. |
| `limit` | integer | No | Number of video templates to return per page. Defaults to 25, maximum is 100. |
| `project_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Template Set

**Slug:** `BANNERBEAR_UPDATE_TEMPLATE_SET`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `uid` | string | Yes | The unique identifier (UID) of the template set to update. |
| `templates` | array | Yes | List of template UIDs to include in the set. The template set will be cleared first and the new list applied. |
| `project_id` | string | No | The project ID. Required when using a Master API Key to specify which project to access. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |