Design Format Details

Retrieve details for a specific format within a design, including its pixel dimensions (width × height) and the template_format_name value required for synchronous generation.

GET/designs/{designId}/formats/{formatSpecifier}API Reference

Path Parameters

Parameter	Type	Required	Description
designId	string	Yes	Unique identifier of the design.
formatSpecifier	string	Yes	Format name (e.g. "facebook-post") or format UID.

Response

Field	Type	Description
id	string	Format identifier (name), e.g. "facebook-post". This is the value to pass as template_format_name in generation requests.
uid	string (uuid)	Unique UUID of this format instance.
width	integer	Width of the format in the specified unit.
height	integer	Height of the format in the specified unit.
unit	string	Unit of measurement, e.g. "px".
preview_url	string (uri)	URL to the preview image for this format.
dynamic_image_url	string (uri)	Dynamic image URL for this format, if one has been created.
design	object	Summary of the parent design (id, name, type, etc.).
elements	array	All elements in this format with their attributes and layout.
variables	object	Template variables defined in text layers for this format.

Response Example

{
  "id": "facebook-post",
  "uid": "6248b96f-581a-43f0-9863-85e1b7d0ec05",
  "width": 1200,
  "height": 1200,
  "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",
  "elements": [
    {
      "name": "root",
      "type": "container",
      "settings": { "is_mandatory": false },
      "attributes": [
        { "id": "background_color", "help": "Background color of the banner", "value": "#FFFFFF" }
      ],
      "layout": { "x": 0, "y": 0, "width": 1200, "height": 1200 }
    }
  ],
  "variables": {
    "name": "{name}",
    "title": "{title}"
  }
}