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

Sample request

curl -H "x-api-key: {YOUR-API-KEY}" \
  https://api.abyssale.com/designs/{designId}/formats/facebook-post

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.

This endpoint is always the advanced view

Unlike Design Details, it needs no ?i=advanced: it always returns the full property set and always includes the format's group layers. Everything is flattened to the single requested format, so layout, group, hidden and locked are plain values rather than objects keyed by format name. A group that does not exist in the requested format is not returned.

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.
dpi	integer	Printer designs only, always present. Render DPI resolved at import time (capped at 300; very large formats get a proportionally lower value), or 300 when the design has none stored. Read-only — not an import field.
bleed_size	number	Printer designs only, always present. Bleed size as a float in the format's unit (mm/in); 0 when bleed is off.
safe_size	number	Printer designs only, always present. Safe-zone size as a float in the format's unit (mm/in); 0 when the safe zone is off.
design	object	Summary of the parent design (id, name, type, etc.).
elements	array	All elements in this format with their attributes and layout, group layers included. See Group layers for the group shape.
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}"
  }
}

Multi-page print designs have no formats

A printer_multipage design is one document — it has no formats, and its pages are not addressable through this endpoint: any formatSpecifier returns 404 with format_not_found. Read the whole document (pages and elements included) with Design Details, or export it with as-import.

Related

• Design Details — the whole design, including the full pages[] list
• Multi-Page Print Imports — the authoring contract behind pages
• Node.js SDK · Python SDK — every method, config, retries and the polling helpers