Bannerbear

Auto-generated images: list templates, create an image from a template and fetch results.

4 actions API key 3 read1 write Calls api.bannerbear.com

Connect

TypeScript

const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "bannerbear" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();

Permissions requested

This toolkit uses a single credential and requests no scopes.

Actions

Create image from templatewritebannerbear.create_imageQueue an image from a template with layer modifications (text, image_url, colors). Returns pending with a uid; fetch it with get_image. Uses image quota.

Input	Type		Description
`template`	string	Required	Template uid
`modifications`	array of object	Required	Layer changes
`webhook_url`	string	Optional	URL to POST the finished image to
`metadata`	string	Optional	Your own reference string
`transparent`	boolean	Optional	Transparent PNG background

TypeScript

await setu.execute({
  userId: "user_1",
  action: "bannerbear.create_image",
  input: {
    "template": "<template>",
    "modifications": []
  },
});

Get imagereadbannerbear.get_imageGet a generated image by uid: status (pending, completed, failed) and the finished image URL.

Input	Type		Description
`uid`	string	Required	Image uid

TypeScript

await setu.execute({
  userId: "user_1",
  action: "bannerbear.get_image",
  input: {
    "uid": "<uid>"
  },
});

List imagesreadbannerbear.list_imagesList recently generated images in the project: uid, status and URL.

Input	Type		Description
`page`	integer	Optional	Page number (25 per page)
`limit`	integer	Optional	Up to 100 per page

TypeScript

await setu.execute({
  userId: "user_1",
  action: "bannerbear.list_images",
  input: {},
});

List templatesreadbannerbear.list_templatesList the project's image templates: uid, name, size and which layers can be modified (text, image).

Input	Type		Description
`page`	integer	Optional	Page number (25 per page)
`limit`	integer	Optional	Up to 100 per page
`name`	string	Optional	Partial name match
`tag`	string	Optional	Only templates with this tag

TypeScript

await setu.execute({
  userId: "user_1",
  action: "bannerbear.list_templates",
  input: {},
});