Developers

Appearance

Generate Multi-Format Images ​

Asynchronously generate static images across multiple formats in a single API call. Ideal for multi-channel campaigns where the same design needs to be exported at different dimensions (e.g. Facebook Feed, Instagram Story, LinkedIn Banner) simultaneously.

The API returns a generation_request_id immediately. When generation is complete, Abyssale sends a NEW_BANNER_BATCH webhook event to your callback_url containing the URLs of all generated files. You can also retrieve results by polling using the returned ID.

Endpoint ​

POST/async/banner-builder/{designId}/generateAPI Reference

Generation Characteristics ​

  • Supported Design Type: Static
  • Response: Asynchronous
  • Enables batch generation of multiple assets
  • Retrieval methods: Webhooks, Polling

Output File Types ​

Supported: JPEG, PNG, WEBP, AVIF, Web PDF

Override the default with the image_file_type parameter: png, jpeg, webp, avif, or pdf.

Key Points ​

  • Initial request returns a generation_request_id
  • Retrieve results via webhook or polling
  • Generate all formats of a design by omitting the template_format_names property
  • Provide a callback_url parameter to receive results via webhook

Sample Request ​

Replace {YOUR-API-KEY} and {designId} before running.

bash
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/{designId}/generate

Sample Response ​

json
{ "generation_request_id": "df75afa8-5a77-4e03-aeef-6d1b6dd0580a" }