Asynchronous generation
Endpoint
POST /async/banner-builder/{design_id}/generate
Key Characteristics
Batch asset creation
Supports design:
static
animated
print
print_multipage
Asynchronous response
Generation tracking via request ID
Generation Process
Send design ID and customization parameters
Receive generation request ID
Retrieve results via:
Webhooks
Polling mechanism
Diagram
API documentation
You can find all layers properties in this section
Sample request
Do not forget to replace {YOUR-API-KEY}
and {design_id}
Sample response
This example is for multi format images generation but it works the same way for animated and pdf asynchronous generation
Webhook Configuration
Callback URL Setup
Include
callback_url
parameter in generation request bodySpecify your webhook endpoint to receive generation notifications
Abyssale will send complete generation results to this URL with a
JSON
payload as aPOST
query.
Notification Mechanism
Automatic notification after asset generation
Includes successful assets and generation errors
Payload structure
Payload Details
banners
: Successfully generated assetserrors
: Formats that failed generationEach successful banner includes file URLs, design details
Polling configuration
Progress Check Endpoint
GET /generation-request/{generation_request_id}
Response Details
Identical to webhook payload except it contains an additional
is_finalized
boolean property. Once this property is true, the generation request is completed and will never change in the future.
Additionnal information
A generation request will become unavailable after 7 days.
The endpoint is rate limited. Make sure you do not flood it or you will be blocked.
Abyssale uses a retry system, so a generation request can take a maximum of 10 minutes before being completed.
Payload structure
Diagram
Progress your design generation journey by diving deeper into configuration
Last updated