Designs
List all your designs - Abyssale REST API
A design is a reusable creative blueprint that defines both the visual structure and output specifications of your marketing assets. It includes at least:
one format (dimension, i.e. Facebook feed 1200x628 or IAB 300x250)
one element (text, button, image, shape...)
Each layer in a design has configurable properties that control its appearance and behavior. These properties can include:
Visual attributes (colors, opacity, effects)
Content values (text content, image sources)
Positioning and layout settings
Layer-specific configurations
The properties you set in the design builder serve as default values. However, you can dynamically override any property at generation time through the API, enabling:
Dynamic styling changes
Contextual customization
A/B testing variations
Design Types
Our platform supports four distinct design types, each optimized for different output needs:
Static Design
Purpose: Creates static visual assets
Output formats: PNG, JPEG, PDF
Use case: Single-frame marketing assets like social posts or display ads
Animated Design
Purpose: Creates dynamic visual content with motion
Features:
Animation effects (fade, slide, transitions)
Optional background video support
Output formats:
MP4 video
Animated GIF
HTML5 banner (ZIP package)
PDF Design
Purpose: Creates print-ready single-page documents
Output format: PDF
Use case: Brochures, flyers, or print advertisements
Multi-page PDF Design
Purpose: Creates multi-page documents
Output format: PDF
Use case: Catalogs, presentations, or multi-page marketing materials
Here is the mapping between a template type and supported generation file types:
static
animated
printer
printer_multipage
Get your designs
Abyssale provides a list of free templates in the Templates library page. Feel free to use one to start designing a template instead of doing it from scratch.
Only designs listed in the Projects page are accessible via API.
Retrieve all of your designs (containing for each the id, name, creation date & update date)
Unique identifier (UUID) of a category. Filter designs by a category.
Filter designs by one of these types static, animated, printer, printer_multipage
GET /designs HTTP/1.1
Host: api.abyssale.com
x-api-key: YOUR_API_KEY
Accept: */*
Ok
[
{
"id": "64238d01-d402-474b-8c2d-fbc957e9d290",
"name": "Ad campaign fall 2025",
"type": "static",
"created_at": 1649942114,
"updated_at": 1649942114,
"category_name": "Fall campaigns",
"preview_url": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/e0d292f2-ec21-11e9-a539-3c408bf94155/a9b3c668-7b84-4924-adf0-815dae727d32.png"
}
][
{
"id": "3f1900f0-9a0f-4d3f-867e-1bb3a6e4fa2d",
"name": "Abyssale demo - FB Square",
"type": "static",
"created_at": 1681215684,
"updated_at": 1681217794,
"preview_url": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/e0d292f2-ec21-11e9-a539-3c408bf94155/65422510-332e-4da6-ab50-d40ff532d000.png",
"category_name": "Abyssale Demo"
},
{
"id": "46d22c62-d134-44d3-a040-138e4ea9ea08",
"name": "Abyssale demo - FB Feed",
"type": "static",
"created_at": 1688631025,
"updated_at": 1688977170,
"preview_url": "https://production-banners.s3-eu-west-1.amazonaws.com/templates/e0d292f2-ec21-11e9-a539-3c408bf94155/9c872731-da6f-4923-b342-7c4250ac94cc.png",
"category_name": "Abyssale Demo"
}
]This sample contains 2 designs:
Abyssale demo - FB Feed (static template) with the
46d22c62-d134-44d3-a040-138e4ea9ea08template IDAbyssale demo - FB Square (static template) with the
3f1900f0-9a0f-4d3f-867e-1bb3a6e4fa2dtemplate ID
The preview_url property is the image associated with the first format in the template.
Last updated