When you retrieve a design's information, you'll receive a complete specification that includes:
Core Identifiers
Unique design ID for API reference
Format Definitions
List of all output formats configured for the design
Each format has a unique name & a unique uid within its parent design
Layer Configuration
Complete inventory of all layers
Supports 9 distinct layer types
Property Mappings
Detailed property values for each layer
Properties are format-specific and can include:
Color values
Content payloads
Image URLs
Other format-specific attributes
Additional information about layers:
mandatory (boolean):
true – The layer must be explicitly provided in API requests. Omitting it will result in a generation error. It must differ from the default value defined in the design.
false – The layer is optional during API generation.
Use this field to programmatically determine which layers require values before submitting a generation request.
Get Design details
get
Retrieve the details of a design (general information, formats, elements & properties).
Authorizations
x-api-keystringRequired
All of your Abyssale requests must contain a x-api-key header with your API Key.
{
"id": "4a2e214c-cb04-4388-bd59-bb93b03abe15",
"name": "untitled",
"type": "printer_multipage",
"template_id": "4a2e214c-cb04-4388-bd59-bb93b03abe15",
"pages": [
{
"id": "page_1",
"uuid": "088afbb8-bace-4f17-82e4-d30fc6719f4a",
"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",
"uuid": "188afbb8-bace-4f17-82e4-d30fc6719f4a",
"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",
"uuid": "288afbb8-bace-4f17-82e4-d30fc6719f4a",
"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",
"uuid": "388afbb8-bace-4f17-82e4-d30fc6719f4a",
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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",
"settings": {
"is_mandatory": false
},
"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"
}
