← Tools Reference

Bannerbear

Bannerbear integration (Design & Media, Marketing). Imported from open-connector.

API key5 toolshttps://sync.api.bannerbear.com
GET
bannerbear_get_auth
Verify a Bannerbear API key and return the project it is scoped to.

/v2/auth

1 parameter
ParamTypeRequiredDescription
project_idstringoptionalThe Bannerbear project UID. Required when using a Full Access Master API Key.
GET
bannerbear_list_templates
List Bannerbear templates in the connected project.

/v2/templates

6 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe page of results to retrieve. Bannerbear returns 25 items per page.
limitintegeroptionalThe number of templates to return, up to 100.
tagstringoptionalFilter templates by tag.
namestringoptionalFilter templates by partial name match.
extendedbooleanoptionalWhether to include current layer defaults.
project_idstringoptionalThe Bannerbear project UID. Required when using a Full Access Master API Key.
GET
bannerbear_get_template
Retrieve one Bannerbear template by UID.

/v2/templates/{uid}

3 parameters
ParamTypeRequiredDescription
uidstringrequiredThe Bannerbear resource UID.
extendedbooleanoptionalWhether to include current layer defaults.
project_idstringoptionalThe Bannerbear project UID. Required when using a Full Access Master API Key.
POST
bannerbear_create_image_sync
Create a Bannerbear image synchronously from a template and return the generated media URLs.

/v2/images

6 parameters
ParamTypeRequiredDescription
templatestringrequiredThe template UID to use.
modificationsarrayrequiredTemplate layer modifications to apply.
transparentbooleanoptionalWhether to render a transparent PNG.
render_pdfbooleanoptionalWhether to also render a PDF.
metadatastringoptionalCustom metadata to store with the generated image.
project_idstringoptionalThe Bannerbear project UID. Required when using a Full Access Master API Key.
GET
bannerbear_get_image
Retrieve one Bannerbear image by UID.

/v2/images/{uid}

2 parameters
ParamTypeRequiredDescription
uidstringrequiredThe Bannerbear resource UID.
project_idstringoptionalThe Bannerbear project UID. Required when using a Full Access Master API Key.