Skip to main content
Create image in Bannerbear
Wrk Product avatar
Written by Wrk Product
Updated over a month ago

Create image in Bannerbear.

Application

  • Bannerbear

Inputs (what you have)

Name

Description

Data Type

Required?

Example

Connected Account

The connected account to use for the request

Connected Account

Yes

Template ID

The template ID you want to use

Text (Short)

Yes

Metadata

Metadata that you need to store e.g. ID of a record in your DB

Text (Short)

No

Wait for image?

Whether to wait for the image to be proccesed before returning. If after three tries the images is not ready, an error will be thrown. Number of tries can be increased by setting "Wait maximum tries"

True/False

No

Wait maximum tries

How often it should check if the image is available before it fails

Number

No

Webhook URL

A URL to POST the Image object to upon rendering completed

Link

No

Modification ID 1

The ID of the item you want to change

Text (Short)

No

Modification ID 1 text

Replacement text you want to use

Text (Short)

No

Modification ID 1 color

Color hex of object

Text (Short)

No

Modification ID 1 background

Color hex of text background

Text (Short)

No

Modification ID 1 image URL

Replacement image URL you want to use (must be publicly viewable)

Link

No

Modification ID 2

The ID of the item you want to change

Text (Short)

No

Modification ID 2 text

Replacement text you want to use

Text (Short)

No

Modification ID 2 color

Color hex of object

Text (Short)

No

Modification ID 2 background

Color hex of text background

Text (Short)

No

Modification ID 2 image URL

Replacement image URL you want to use (must be publicly viewable)

Link

No

Modification ID 3

The ID of the item you want to change

Text (Short)

No

Modification ID 3 text

Replacement text you want to use

Text (Short)

No

Modification ID 3 color

Color hex of object

Text (Short)

No

Modification ID 3 background

Color hex of text background

Text (Short)

No

Modification ID 3 image URL

Replacement image URL you want to use (must be publicly viewable)

Link

No

Outputs (what you get)

Name

Description

Data Type

Required?

Example

JSON Output

JSON output returned by the API

Text (Long)

No

Outcomes

Name

Description

Success

This status is selected if the job has successfully completed.

Unsuccessful

This status is selected if the job has completed unsuccessfully.

Requirements

  • N/A

Did this answer your question?