Get Image Template
bannerbear.get_image_template
ActionBusiness appsconnection required
Calls the Bannerbear API with the connection's credentials.
Read one image template by uid, including the full canvas configuration and its layer names.
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 template to read. | string | Yes | — | — | 6EZ9nQX0lzpWwqAgzB |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"uid": "6EZ9nQX0lzpWwqAgzB"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
uid The template's unique id, which a render passes as 'template'. | string | — |
name The template's name as shown in the Bannerbear dashboard. | string | — |
description The template's description, or null when none was set. | string | — |
tags The tags applied to the template. | array | — |
width The template canvas width in pixels. | number | — |
height The template canvas height in pixels. | number | — |
config The full canvas configuration, including its 'objects' layers. | object | — |
self The permalink to this template on the Bannerbear API. | string | — |
{
"config": {},
"description": "",
"height": 0,
"name": "",
"self": "",
"tags": [],
"uid": "",
"width": 0
}Notes
- The layer names in config.objects are what a render's modifications target by 'name'.
Related Bannerbear nodes
See Get Image Template 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.