Design Details
Get details of a design - Abyssale REST API
Last updated
Get details of a design - Abyssale REST API
Last updated
When you retrieve a design's information, you'll receive a complete specification that includes:
Unique design ID for API reference
List of all output formats configured for the design
Each format has a unique name within its parent design
Complete inventory of all layers
Supports 9 distinct layer types
Detailed property values for each layer
Properties are format-specific and can include:
Color values
Content payloads
Image URLs
Other format-specific attributes
Advanced properties can be retrieved by using the ?i=advanced query URL parameter.
{
"template_id": "7dc0229b-cc0e-4fe5-971d-325164480887",
"name": "Abyssale demo - FB Feed",
"type": "static",
"created_at": 1681215684,
"updated_at": 1681217794,
"category_name": "Abyssale Demo",
"formats": [
{
"id": "medium-rectangle",
"width": 300,
"height": 250,
"preview_url": "https://public-example-link.com/preview/87f7f83b-894f-4900-abe2-3e0e769b12d7.png"
},
{
"id": "wide-skyscraper",
"width": 160,
"height": 600,
"preview_url": "https://public-example-link.com/preview/87f7f83b-894f-4900-abe2-3e0e769b12d7-wide-skyscraper.png"
}
],
"elements": [
{
"name": "root",
"type": "container",
"attributes": [
{
"id": "background_color",
"help": "6 digits hexadecimal background color of the banner (i.e. #F3F3F3)",
"values": {
"medium-rectangle": "#ffffff",
"wide-skyscraper": "#c3bfbf"
}
}
],
"layout": {
"medium-rectangle": {
"x": 0,
"y": 0,
"width": 300,
"height": 250
},
"wide-skyscraper": {
"x": 0,
"y": 0,
"width": 160,
"height": 600
}
}
},
{
"name": "tb-text_0",
"type": "text",
"attributes": [
{
"id": "payload",
"help": "Text content (i.e. Lorem ipsum)",
"values": {
"medium-rectangle": "Lorem Ipsum",
"wide-skyscraper": "Test"
}
},
{
"id": "color",
"help": "6 or 8 digits hexadecimal color of the text (i.e. #EAEAEA)",
"values": {
"medium-rectangle": "#000000",
"wide-skyscraper": "#000000",
}
}
],
"layout": {
"medium-rectangle": {
"x": 20,
"y": 40,
"width": 200,
"height": 50
},
"wide-skyscraper": {
"x": 10,
"y": 20,
"width": 100,
"height": 100
}
}
},
]
}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 format
with 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 format
Test on the wide-skyscraper format
color: The text color.
#000000 for both formats
{
"id": "4a2e214c-cb04-4388-bd59-bb93b03abe15",
"name": "untitled",
"type": "printer_multipage",
"template_id": "4a2e214c-cb04-4388-bd59-bb93b03abe15",
"pages": [
{
"id": "page_1",
"width": 5.5,
"height": 8.5,
"unit": "in",
"preview_url": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/e0d292f2-ec21-11e9-a539-3c408bf94155/b4d64049-e9be-4e06-af35-6310ba4199db.png"
},
{
"id": "page_2",
"width": 5.5,
"height": 8.5,
"unit": "in",
"preview_url": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/e0d292f2-ec21-11e9-a539-3c408bf94155/b4d64049-e9be-4e06-af35-6310ba4199db-page_2.png"
},
{
"id": "page_3",
"width": 5.5,
"height": 8.5,
"unit": "in",
"preview_url": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/e0d292f2-ec21-11e9-a539-3c408bf94155/b4d64049-e9be-4e06-af35-6310ba4199db-page_3.png"
},
{
"id": "page_4",
"width": 5.5,
"height": 8.5,
"unit": "in",
"preview_url": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/e0d292f2-ec21-11e9-a539-3c408bf94155/b4d64049-e9be-4e06-af35-6310ba4199db-page_4.png"
}
],
"elements_per_page": {
"page_1": [
{
"name": "root",
"type": "container",
"attributes": {
"background_color": {
"id": "background_color",
"help": "6 or 8 digits hexadecimal background color (i.e. #F3F3F3) or a CMYK color (i.e. cmyk(0,10,0,50)) of the banner ",
"values": "cmyka(0,0,0,0,100)"
}
},
"layout": {
"x": 0,
"y": 0,
"width": 5.5,
"height": 8.5
}
},
{
"name": "tb-image_0",
"type": "image",
"attributes": {
"image_url": {
"id": "image_url",
"help": "Public HTTP(s) URL of the image (i.e. https://photo.com/image.png)",
"values": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/v2/e0d292f2-ec21-11e9-a539-3c408bf94155/4a2e214c-cb04-4388-bd59-bb93b03abe15/v2_66bcfed3-792f-44b5-a4d6-bd9ecd5806e9.jpeg"
}
},
"layout": {
"x": 0.15,
"y": 2.546,
"width": 5.333,
"height": 5.8
}
},
{
"name": "tb-text_0",
"type": "text",
"attributes": {
"payload": {
"id": "payload",
"help": "Text content (i.e. Lorem ipsum)",
"values": "Aby Mag"
},
"color": {
"id": "color",
"help": "6 or 8 digits hexadecimal color (i.e. #EAEAEA) or a CMYK color (i.e. cmyk(0,10,0,50)) of the text",
"values": "cmyka(0,0,0,100,100)"
}
},
"layout": {
"x": 0.3,
"y": 0.179,
"width": 5.275,
"height": 2.058
}
}
],
"page_2": [
{
"name": "root",
"type": "container",
"attributes": {
"background_color": {
"id": "background_color",
"help": "6 or 8 digits hexadecimal background color (i.e. #F3F3F3) or a CMYK color (i.e. cmyk(0,10,0,50)) of the banner ",
"values": "cmyka(0,0,0,0,100)"
}
},
"layout": {
"x": 0,
"y": 0,
"width": 5.5,
"height": 8.5
}
},
{
"name": "tb-image_0",
"type": "image",
"attributes": {
"image_url": {
"id": "image_url",
"help": "Public HTTP(s) URL of the image (i.e. https://photo.com/image.png)",
"values": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/v2/e0d292f2-ec21-11e9-a539-3c408bf94155/4a2e214c-cb04-4388-bd59-bb93b03abe15/v2_6a887b92-9d46-4dca-a6d9-ed3648918c39.jpeg"
}
},
"layout": {
"x": 2.904,
"y": 0.012,
"width": 2.415,
"height": 2.415
}
},
{
"name": "tb-text_0",
"type": "text",
"attributes": {
"payload": {
"id": "payload",
"help": "Text content (i.e. Lorem ipsum)",
"values": "Health"
},
"color": {
"id": "color",
"help": "6 or 8 digits hexadecimal color (i.e. #EAEAEA) or a CMYK color (i.e. cmyk(0,10,0,50)) of the text",
"values": "cmyka(0,0,0,100,100)"
}
},
"layout": {
"x": 0.304,
"y": 1.046,
"width": 2.494,
"height": 0.775
}
},
{
"name": "tb-text_1",
"type": "text",
"attributes": {
"payload": {
"id": "payload",
"help": "Text content (i.e. Lorem ipsum)",
"values": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker."
},
"color": {
"id": "color",
"help": "6 or 8 digits hexadecimal color (i.e. #EAEAEA) or a CMYK color (i.e. cmyk(0,10,0,50)) of the text",
"values": "cmyka(0,0,0,100,100)"
}
},
"layout": {
"x": 0.179,
"y": 2.762,
"width": 5.088,
"height": 5.5
}
}
],
"page_3": [
{
"name": "root",
"type": "container",
"attributes": {
"background_color": {
"id": "background_color",
"help": "6 or 8 digits hexadecimal background color (i.e. #F3F3F3) or a CMYK color (i.e. cmyk(0,10,0,50)) of the banner ",
"values": "cmyka(0,0,0,0,100)"
}
},
"layout": {
"x": 0,
"y": 0,
"width": 5.5,
"height": 8.5
}
},
{
"name": "tb-image_0",
"type": "image",
"attributes": {
"image_url": {
"id": "image_url",
"help": "Public HTTP(s) URL of the image (i.e. https://photo.com/image.png)",
"values": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/v2/e0d292f2-ec21-11e9-a539-3c408bf94155/4a2e214c-cb04-4388-bd59-bb93b03abe15/v2_a14f51da-4e2a-407e-9ad7-66f946668f53.jpeg"
}
},
"layout": {
"x": 2.904,
"y": 0.212,
"width": 2.415,
"height": 2.415
}
},
{
"name": "tb-text_0",
"type": "text",
"attributes": {
"payload": {
"id": "payload",
"help": "Text content (i.e. Lorem ipsum)",
"values": "Sport"
},
"color": {
"id": "color",
"help": "6 or 8 digits hexadecimal color (i.e. #EAEAEA) or a CMYK color (i.e. cmyk(0,10,0,50)) of the text",
"values": "cmyka(0,0,0,100,100)"
}
},
"layout": {
"x": 0.296,
"y": 1.054,
"width": 2.494,
"height": 0.775
}
},
{
"name": "tb-text_1",
"type": "text",
"attributes": {
"payload": {
"id": "payload",
"help": "Text content (i.e. Lorem ipsum)",
"values": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker."
},
"color": {
"id": "color",
"help": "6 or 8 digits hexadecimal color (i.e. #EAEAEA) or a CMYK color (i.e. cmyk(0,10,0,50)) of the text",
"values": "cmyka(0,0,0,100,100)"
}
},
"layout": {
"x": 0.179,
"y": 2.763,
"width": 5.088,
"height": 5.5
}
}
],
"page_4": [
{
"name": "root",
"type": "container",
"attributes": {
"background_color": {
"id": "background_color",
"help": "6 or 8 digits hexadecimal background color (i.e. #F3F3F3) or a CMYK color (i.e. cmyk(0,10,0,50)) of the banner ",
"values": "cmyka(0,0,0,0,100)"
}
},
"layout": {
"x": 0,
"y": 0,
"width": 5.5,
"height": 8.5
}
},
{
"name": "tb-image_0",
"type": "image",
"attributes": {
"image_url": {
"id": "image_url",
"help": "Public HTTP(s) URL of the image (i.e. https://photo.com/image.png)",
"values": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/v2/e0d292f2-ec21-11e9-a539-3c408bf94155/4a2e214c-cb04-4388-bd59-bb93b03abe15/v2_366bee0e-5ec2-4c65-b095-516ab65cd549.jpeg"
}
},
"layout": {
"x": 2.896,
"y": 0.212,
"width": 2.414,
"height": 2.415
}
},
{
"name": "tb-text_0",
"type": "text",
"attributes": {
"payload": {
"id": "payload",
"help": "Text content (i.e. Lorem ipsum)",
"values": "Psycho"
},
"color": {
"id": "color",
"help": "6 or 8 digits hexadecimal color (i.e. #EAEAEA) or a CMYK color (i.e. cmyk(0,10,0,50)) of the text",
"values": "cmyka(0,0,0,100,100)"
}
},
"layout": {
"x": 0.296,
"y": 1.054,
"width": 2.494,
"height": 0.775
}
},
{
"name": "tb-text_1",
"type": "text",
"attributes": {
"payload": {
"id": "payload",
"help": "Text content (i.e. Lorem ipsum)",
"values": "Le Lorem Ipsum est simplement du faux texte employé dans la composition et la mise en page avant impression. Le Lorem Ipsum est le faux texte standard de l'imprimerie depuis les années 1500, quand un imprimeur anonyme assembla ensemble des morceaux de texte pour réaliser un livre spécimen de polices de texte. Il n'a pas fait que survivre cinq siècles, mais s'est aussi adapté à la bureautique informatique, sans que son contenu n'en soit modifié. Il a été popularisé dans les années 1960 grâce à la vente de feuilles Letraset contenant des passages du Lorem Ipsum, et, plus récemment, par son inclusion dans des applications de mise en page de texte, comme Aldus PageMaker."
},
"color": {
"id": "color",
"help": "6 or 8 digits hexadecimal color (i.e. #EAEAEA) or a CMYK color (i.e. cmyk(0,10,0,50)) of the text",
"values": "cmyka(0,0,0,100,100)"
}
},
"layout": {
"x": 0.179,
"y": 2.763,
"width": 5.088,
"height": 5.5
}
}
]
},
"created_at": 1715775978,
"updated_at": 1715865885,
"category_name": "PRO - Tech test"
}