Bannerbear
API actions for the Bannerbear integration.
Bannerbear
Generate images and videos automatically using Bannerbear templates.
Create Bannerbear image
Create an image from a Bannerbear template, filling in its layers with your own text and images.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | The ID of the Bannerbear template to use. |
modifications | array | Yes | List of changes to make to the template, such as new text or images. Each item names a template layer and the content to put in it. |
metadata | object | No | Optional extra details to save along with this image request, such as your own reference number. |
webhook_url | string | No | Optional URL where Bannerbear sends an update when the image is ready. |
Response
{}Create Bannerbear video
Create a video from a Bannerbear template, filling in its layers with your own text, images, and media.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | The ID of the Bannerbear template to use. |
modifications | array | Yes | List of changes to make to the template, such as new text or images. Each item names a template layer and the content to put in it. |
input_media_url | string | No | Optional link to a video or audio file to use in the video, such as footage to overlay or a soundtrack. |
webhook_url | string | No | Optional URL where Bannerbear sends an update when the video is ready. |
Response
{}Get Bannerbear account
Retrieve account details for the connected Bannerbear workspace.
Response
{}Get Bannerbear image status
Check whether a Bannerbear image has finished generating and get the link to it.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
image_id | string | Yes | The ID of the Bannerbear image to check. |
Response
{
"id": "mock_value",
"imageUrl": "mock_value",
"status": "mock_value"
}Get Bannerbear template
Fetch details for a specific Bannerbear template.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | The ID of the Bannerbear template to look up. |
Response
{}List Bannerbear projects
List available Bannerbear projects for the account.
Response
[
{}
]List Bannerbear templates
Retrieve available Bannerbear templates, optionally filtered by project.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | No | Optional Bannerbear project ID to only list templates from that project. |
Response
[
{}
]