---
canonical_url: "https://docs.composio.dev/toolkits/bannerbite"
markdown_url: "https://docs.composio.dev/toolkits/bannerbite.md"
product: "platform"
version: null
last_updated: null
---

# Bannerbite

Bannerbite is a creative automation platform for generating images and videos from reusable projects and templates.

- **Category:** images & design
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 6
- **Triggers:** 0
- **Slug:** `BANNERBITE`
- **Version:** 00000000_00

## Tools

### Generate Media

**Slug:** `BANNERBITE_GENERATE_MEDIA`

Queue one asynchronous image, video, or overlay render from a Bannerbite bite. WARNING: a valid call consumes render credits and queues external asynchronous work; it may also send completion updates to an email or webhook. The response confirms queue acceptance only, not completed media.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `audio` | object | No | Optional audio track for the render. |
| `scene` | integer | No | Scene number to render for image output; defaults to scene 1. |
| `media_type` | string ("image" | "video" | "overlay") | No | Kind of media to render. |
| `scene_data` | array | Yes | Complete template-specific scene fields to render, using field names returned by get_scene_data. A valid request consumes render credits and queues asynchronous work. |
| `webhook_url` | string | No | Public callback URL that receives asynchronous render updates and completion. |
| `notification_email` | string | No | Email address that receives the finished render. Sending it is an external side effect. |
| `bite_id_or_access_token` | string | Yes | Bite ID or bite access token identifying the template to render; normally use the bite ID returned by list_bites. |

#### 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 Bite

**Slug:** `BANNERBITE_GET_BITE`

Return one Bannerbite bite by its numeric bite ID, including template and output-size details; fail explicitly when the bite does not exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bite_id` | integer | Yes | Numeric ID of the Bannerbite bite 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 Project

**Slug:** `BANNERBITE_GET_PROJECT`

Return one Bannerbite project by its numeric project ID; fail explicitly when the project does not exist.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | Numeric ID of the Bannerbite project 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 Scene Data

**Slug:** `BANNERBITE_GET_SCENE_DATA`

Return the editable scene fields for a Bannerbite bite so their names and current values can be used in a render request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bite_id` | integer | Yes | Numeric ID of the bite whose editable scene fields should be returned. |

#### 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 Bites

**Slug:** `BANNERBITE_LIST_BITES`

Return one provider page of Bannerbite bites in a project, up to 100 bites; the API exposes no verified way to request another page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum bites to return in this provider page (1-100). |
| `project_id` | integer | Yes | Numeric ID of the project whose bites should be returned. |

#### 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:** `BANNERBITE_LIST_PROJECTS`

Return one provider page of projects owned by the connected Bannerbite account, up to 100 projects; the API exposes no verified way to request another page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum projects to return in this provider page (1-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 |