Design Details

Retrieve all details for a specific design: its name, type, available formats, and — once created — its dynamic_image_url.

Use the designId from the List Designs endpoint or from the Abyssale dashboard URL.

GET/designs/{designId}API Reference

Path Parameters

Parameter	Type	Required	Description
designId	string (uuid)	Yes	Unique identifier of the design.

Response

Field	Type	Description
id	string (uuid)	Unique identifier of the design.
name	string	Name of the design.
type	string	Design type: "static", "animated", "printer", or "printer_multipage".
created_at	integer	Unix timestamp of creation.
updated_at	integer	Unix timestamp of last update.
category_name	string | null	Design category, if assigned.
formats	array	List of available formats (dimensions). Each item includes id, uid, width, height, unit, preview_url, and dynamic_image_url.
elements	array	All configurable elements and their properties. Each item includes name (layer name), type, and attributes.
variables	object	Template variables defined in text layers (e.g. { "name": "{name}" }).

Response Example

{
  "id": "64238d01-d402-474b-8c2d-fbc957e9d290",
  "name": "Ad campaign fall 2025",
  "type": "static",
  "created_at": 1649942114,
  "updated_at": 1649942114,
  "category_name": "Fall campaigns",
  "formats": [
    {
      "id": "facebook-post",
      "uid": "9b57d65e-eb2c-4a74-a51e-4482917c248a",
      "width": 1200,
      "height": 1200,
      "unit": "px",
      "preview_url": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/e0d292f2-ec21-11e9-a539-3c408bf94155/a9b3c668-7b84-4924-adf0-815dae727d32.png",
      "dynamic_image_url": "https://img.abyssale.com/ecf1fe8c-5392-48c2-b6d2-665183a18fe5/9b57d65e-eb2c-4a74-a51e-4482917c248a"
    }
  ],
  "elements": [
    {
      "name": "root",
      "type": "container",
      "attributes": [
        { "id": "background_color", "help": "Background color of the banner", "values": { "facebook-post": "#FFFFFF" } }
      ]
    },
    {
      "name": "text_title",
      "type": "text",
      "attributes": [
        { "id": "payload", "help": "Text content", "values": { "facebook-post": "My image title" } }
      ]
    }
  ],
  "variables": {
    "name": "{name}",
    "title": "{title}"
  }
}