Create Batch

bannerbear.create_batch

ActionBusiness appsconnection required

Calls the Bannerbear API with the connection's credentials.

Render up to 100 images in one request, each from its own template and modifications.

Ask about Bannerbear All Bannerbear nodes Provider API docs ↗

Connection

Required: Yes — the node will not save without one
Auth type: Bearer token
Providers: Bannerbear
Secret shape: the V5 API key, or {"api_key": "…"}
Resolved by: config.connection_id, else node.connection_id

Configuration

1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

Field	Type	Required	Default	Constraints	Example
items The image payloads to render, at most 100. Each entry takes the same keys as Bannerbear: Create Image — a 'template' uid, a 'modifications' object, and optionally formats, scale, dpi, quality, proxy, version and metadata.	array	Yes	—	≥ 1 characters; array of object	[{"modifications":{"objects":[{"name":"title","text":"First image"}]},"template":"6EZ9nQX0lzpWwqAgzB"}]

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "items": [
    {
      "modifications": {
        "objects": [
          {
            "name": "title",
            "text": "First image"
          }
        ]
      },
      "template": "6EZ9nQX0lzpWwqAgzB"
    }
  ]
}

Output

One shape.

result

Field	Type	Example
uid The batch's unique id, used to poll for the finished items.	string	—
type What the batch renders; currently always 'images'.	string	—
status Batch state: pending or completed.	string	—
pending True while Bannerbear is still working through the batch.	boolean	—
total How many image payloads the batch carried.	number	—
counts Item counts broken down by completed, failed, invalid, pending.	object	—
partial True when at least one item failed or was rejected as invalid.	boolean	—
failed_count How many items failed or were rejected as invalid.	number	—
errors One error object per failed or invalid item.	array	—
items The image objects the batch produced, in the order submitted.	array	—
self The permalink to this batch on the Bannerbear API.	string	—
created_at ISO-8601 timestamp of when the batch was accepted.	string	—
completed_at ISO-8601 timestamp of when the batch finished, else null.	string	—

{
  "completed_at": "",
  "counts": {},
  "created_at": "",
  "errors": [],
  "failed_count": 0,
  "items": [],
  "partial": false,
  "pending": false,
  "self": "",
  "status": "",
  "total": 0,
  "type": "",
  "uid": ""
}

Notes

Bannerbear accepts the batch with 202 and renders it in the background; poll Bannerbear: Get Batch for the finished items.
At most 100 items per batch.

Related Bannerbear nodes

See Create Batch run in a workflow.

In a technical demo we add the Bannerbear connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demo Talk to sales