Generate Multi-Format images
How to generate several images at once - Abyssale REST API
Asynchronous Asset Generation Endpoint
POST /async/banner-builder/{design_id}/generate
Generation Characteristics
Supported Design Type: Static
Response: Asynchronous
Enables batch generation of multiple assets
Retrieval methods:
Webhooks
Polling
Output File Types
Supported formats:
JPEG
PNG
WEBP
AVIF
Web PDF
You can override the default using the image_file_type
parameter:
Specify
png
,jpeg
,webp
,avif
orpdf
Additional information
Retrieval Mechanism
Initial request returns a
generation_request_id
You can track generation status and retrieve results using:
Webhook notifications
Periodic API polling
Key Differences from Synchronous Generation
All formats of a design can be generated by removing the
template_format_names
property.Supports bulk asset creation
Allows handling of complex or time-consuming generation tasks
Provides flexibility in result retrieval
The callback_url
request parameter and the asynchronous mechanism
callback_url
request parameter and the asynchronous mechanismAs this method is asynchronous you should provide a callback_url
. Check how the asynchronous generation works
Sample request
Do not forget to replace {YOUR-API-KEY}
and {designId}
curl -X POST -H "x-api-key:{YOUR-API-KEY}" -H "Content-Type: application/json" \
-d '{
"callback_url": "https://webhook.mycompany.com/images",
"template_format_names": ["facebook-feed", "instagram-post", "iab-medium"],
"elements": {
"primary_text": {
"payload": "New branding available.",
"color": "#FF0000"
}
}
}' \
https://api.abyssale.com/async/banner-builder/{design_id}/generate
Sample response
{
"generation_request_id": "df75afa8-5a77-4e03-aeef-6d1b6dd0580a"
}
Last updated