Generate HTML5 Banner Ads

Asynchronously generate HTML5 banner ads across multiple formats from a single HTML5 design. HTML5 banners are interactive, animation-capable creatives used in programmatic display advertising (Google Display Network, DV360, etc.).

Each format is exported as a self-contained ZIP archive delivered via a NEW_BANNER_BATCH webhook event to your callback_url. Set image_file_type: "html5" in your request body to activate this output type.

INFO

This feature is available from the Suite plan.

Endpoint

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

Generation Characteristics

• Supported Design Type: Animated
• Response: Asynchronous
• Output: ZIP file containing HTML5 assets
• Required Parameter: image_file_type=html5
• Retrieval methods: Webhooks, Polling

Output Customization

Use the html5 property to customize the output:

click_tag

A string used to redirect the user when clicking the ad. Accepts:

• Direct URL: "https://www.abyssale.com"
• URL with ad network macro: "[UNENCODED_CLICK_REDIRECT]https://developers.abyssale.com/"

Document Properties

Property	Description	Default
page_title	Sets the HTML document title
repeat	-1 = infinite, 0 = once, positive = N times	0
include_backup_image	Includes backup_image.jpeg in the ZIP	false

Ad Network

ad_network optimizes output for a specific platform, applying folder structure, file size limits, and GSAP animation library requirements:

Value	Platform
default	No specific constraints
google-ads	Google Ads
google-marketing	Former DoubleClick
adform	Adform
amazon-ads	Amazon Ads
adroll	AdRoll

{
  "image_file_type": "html5",
  "html5": {
    "click_tag": "{MY_CLICK_TAG}",
    "page_title": "My Ad",
    "ad_network": "google-ads",
    "repeat": 0,
    "include_backup_image": false
  }
}

Sample Request

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

curl -X POST \
  -H "x-api-key: {YOUR-API-KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "callback_url": "https://webhook.mycompany.com/images",
    "image_file_type": "html5",
    "html5": {
      "click_tag": "{MY_CLICK_TAG}",
      "page_title": "{MY_PAGE_TITLE}",
      "ad_network": "default",
      "repeat": 0,
      "include_backup_image": false
    },
    "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

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

Related

• Asynchronous Generation Overview
• Banner Events — webhook payload on completion
• Errors