# Design format Details

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.

## Get Design Format details

> 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.

```json
{"openapi":"3.0.3","info":{"title":"API Reference - Abyssale","version":"0.0.1"},"tags":[{"name":"Designs","description":"A design is a layout including at least:\n- one format (dimension, i.e. Facebook feed 1200x628 or IAB 300x250)\n- one element (text, button, image, shape...)\n\nAll elements have their own properties that can be customized (color, text payload, image...).\n\nOnce designed, all properties of the design will act as a reference for subsequent image generation. Obviously, those properties can be overridden by sending new parameters in the generation API call.\n\nAbyssale provides a list of free template designs in the Template Library page. Feel free to use one to start designing your design instead of doing it from scratch.\n\n**All of your designs are listed in the different project pages, only those are accessible via API.**\n"}],"servers":[{"url":"https://api.abyssale.com","description":"Main Production Server"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"description":"All of your Abyssale requests must contain a `x-api-key header` with your API Key.","type":"apiKey","name":"x-api-key","in":"header"}},"schemas":{"Design":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier (UUID) of the design."},"name":{"type":"string","description":"Name of the design."},"type":{"type":"string","enum":["static","animated","printer","printer_multipage"],"description":"Type of the design"},"created_at":{"type":"integer","description":"Timestamp of when the design has been created."},"updated_at":{"type":"integer","description":"Timestamp of when the design has been updated for the last time."},"category_name":{"type":"string","nullable":true,"description":"Design Category"}},"required":["id","name","created_at","updated_at"]}}},"paths":{"/designs/{designId}/formats/{formatSpecifier}":{"get":{"tags":["Designs"],"summary":"Get Design Format details","description":"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.","parameters":[{"name":"designId","in":"path","required":true,"schema":{"type":"string"},"description":"Unique identifier of the design"},{"name":"formatSpecifier","in":"path","required":true,"schema":{"type":"string"},"description":"Format name or UID"}],"responses":{"200":{"description":"Format details retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Format identifier"},"uid":{"type":"string","format":"uuid","description":"Unique ID for the format instance"},"width":{"type":"integer","description":"Width of the format in specified units"},"height":{"type":"integer","description":"Height of the format in specified units"},"unit":{"type":"string","description":"Unit of measurement for dimensions"},"preview_url":{"type":"string","format":"uri","description":"URL to preview image of this format"},"dynamic_image_url":{"type":"string","format":"uri","description":"URL to the dynamically generated image"},"design":{"$ref":"#/components/schemas/Design"},"elements":{"type":"array","description":"List of all elements (& customizable properties) contained in the design format","items":{"type":"object","properties":{"name":{"type":"string","description":"Element name"},"type":{"type":"string","description":"Element type"},"settings":{"type":"object","properties":{"is_mandatory":{"type":"boolean","description":"Whether the element is mandatory"}}},"attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Attribute identifier"},"help":{"type":"string","description":"Help text for the attribute"},"value":{"type":"string","description":"Value of the attribute for this format"}}}},"layout":{"type":"object","properties":{"x":{"type":"integer"},"y":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"}}}}}},"variables":{"type":"object","description":"Variables used within the text layers of the design format (if any).\nKeys represent variable names (without braces), and values\nrepresent the placeholder format in the design (e.g. \"{name}\").\n","additionalProperties":{"type":"string"}}}}}}},"404":{"description":"Format Not found"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.abyssale.com/rest-api/designs/design-format-details.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.