Design format Details
Get details of a design format - Abyssale REST API
Rather than retrieving the full details of an entire design with all formats, you can use the following endpoint to get the details of a single design format. This endpoint returns all defined properties for that format.
Retrieve detailed information for a specific format of the given design. Returns all properties including dimensions, preview and dynamic image URLs, design metadata, elements and variables.
Authorizations
x-api-keystringRequired
All of your Abyssale requests must contain a x-api-key header with your API Key.
Path parameters
designIdstringRequired
Unique identifier of the design
formatSpecifierstringRequired
Format name or UID
Responses
200
Format details retrieved successfully
application/json
404
Format Not found
get
/designs/{designId}/formats/{formatSpecifier}GET /designs/{designId}/formats/{formatSpecifier} HTTP/1.1
Host: api.abyssale.com
x-api-key: YOUR_API_KEY
Accept: */*
{
"id": "new-format",
"uid": "6248b96f-581a-43f0-9863-85e1b7d0ec05",
"width": 3333,
"height": 666,
"unit": "px",
"preview_url": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/e0d292f2-ec21-11e9-a539-3c408bf94152/21aff1a9-bcde-4294-8320-be6cae651381.png",
"dynamic_image_url": "https://img.abyssale.com/673f0cb6-f1f6-4f7d-8ea2-4a0ed317efbe/6248b96f-581a-43f0-9863-85e1b7d0ec0a",
"design": {
"id": "64238d01-d402-474b-8c2d-fbc957e9d290",
"name": "Ad campaign fall 2025",
"type": "static",
"created_at": 1649942114,
"updated_at": 1649942114,
"category_name": "Fall campaigns"
},
"elements": [
{
"name": "root",
"type": "container",
"settings": {
"is_mandatory": false
},
"attributes": [
{
"id": "background_color",
"help": "6 or 8 digits hexadecimal background color (i.e. #F3F3F3) of the banner",
"value": "#FFFFFF"
}
],
"layout": {
"x": 0,
"y": 0,
"width": 3333,
"height": 666
}
}
],
"variables": {
"name": "{name}",
"title": "{title}"
}
}Last updated