Get Batch
bannerbear.get_batch
ActionBusiness appsconnection required
Calls the Bannerbear API with the connection's credentials.
Read one batch by uid, with the render status of every item in it.
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 |
|---|---|---|---|---|---|
uid The uid of the batch to read, as returned by Bannerbear: Create Batch. | string | Yes | — | — | 8bKmPqR3xYwZ5nAJeL |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"uid": "8bKmPqR3xYwZ5nAJeL"
}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": ""
}Related Bannerbear nodes
See Get 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.