Template Details
Get details of a template - Abyssale REST API
Once a template has been designed, all related information can be retrieved. It contains:
Its unique identifier (Template ID)
The list of available formats (format names are unique within a template)
The list of elements (9 types of element are available today)
All available attributes by element with the associated value for each format (color, payload, image_url...)
Advanced properties can be retrieved by using the ?i=advanced
query URL parameter.
Sample response
This sample represents the details of a template (ID: 7dc0229b-cc0e-4fe5-971d-325164480887), which contains:
2 formats: medium-rectangle and wide-skyscraper. Those names can be used in the image generation endpoints to define which formats to create.
2 elements:
root (type: container)
The root property is always available and corresponds to the root format container.
It contains a single
background_color
attribute:with a
#ffffff
value on the medium-rectangle formatwith a
#c3bfbf
value on the wide-skyscraper format
tb-text_0 (type: text). It contains 2 attributes:
payload
: The text content.Lorem Ipsum
on the medium-rectangle formatTest
on the wide-skyscraper format
color
: The text color.#000000
for both formats
Last updated