Get Image
bannerbear.get_image
ActionBusiness appsconnection required
Calls the Bannerbear API with the connection's credentials.
Read one image by uid, including its render status and file URLs.
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 image to read, as returned by Bannerbear: Create Image. | string | Yes | — | — | 672PdQlVyD1ynEKGOL |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"uid": "672PdQlVyD1ynEKGOL"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
uid The image's unique id, used to poll for the finished render. | string | — |
status Render state: pending, completed or failed. | string | — |
pending True while the render is still queued and 'files' is empty. | boolean | — |
template The uid of the template this image was rendered from. | string | — |
files The finished file URLs, keyed by format (png, jpg, pdf, …). | object | — |
image_url The PNG URL when there is one, else the first finished file. | string | — |
error Bannerbear's reason when the render failed, otherwise null. | string | — |
metadata The metadata string supplied when the image was created. | string | — |
self The permalink to this image on the Bannerbear API. | string | — |
created_at ISO-8601 timestamp of when the render was requested. | string | — |
completed_at ISO-8601 timestamp of when the render finished, else null. | string | — |
{
"completed_at": "",
"created_at": "",
"error": "",
"files": {},
"image_url": "",
"metadata": "",
"pending": false,
"self": "",
"status": "",
"template": "",
"uid": ""
}Related Bannerbear nodes
See Get Image 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.