Lodol Docs

Bannerbear

API actions for the Bannerbear integration.

Bannerbear

Generate images and videos automatically using Bannerbear templates.


Create Bannerbear image

Render an image using a Bannerbear template and modifications.

Parameters

ParameterTypeRequiredDescription
template_idstringYesBannerbear template UID to render.
modificationsarrayYesArray of layer modifications for the template.
metadataobjectNoOptional metadata to store with the render request.
webhook_urlstringNoOptional webhook URL to receive render status updates.

Response

{}

Create Bannerbear video

Render a video using a Bannerbear template and modifications.

Parameters

ParameterTypeRequiredDescription
template_idstringYesBannerbear template UID to render.
modificationsarrayYesArray of layer modifications for the template.
input_media_urlstringNoOptional input media URL for video overlays or audio.
webhook_urlstringNoOptional webhook URL to receive render status updates.

Response

{}

Get Bannerbear account

Retrieve account details for the connected Bannerbear workspace.

Response

{}

Get Bannerbear image status

Retrieve the status and URL for a rendered Bannerbear image.

Parameters

ParameterTypeRequiredDescription
image_idstringYesBannerbear image UID.

Response

{
  "id": "mock_value",
  "imageUrl": "mock_value",
  "status": "mock_value"
}

Get Bannerbear template

Fetch details for a specific Bannerbear template.

Parameters

ParameterTypeRequiredDescription
template_idstringYesBannerbear template UID.

Response

{}

List Bannerbear projects

List available Bannerbear projects for the account.

Response

[
  {}
]

List Bannerbear templates

Retrieve available Bannerbear templates, optionally filtered by project.

Parameters

ParameterTypeRequiredDescription
project_idstringNoOptional Bannerbear project UID to filter templates.

Response

[
  {}
]

On this page