Developers

Appearance

Generate Multi-Format Animated GIFs ​

Asynchronously generate animated GIFs across multiple formats from a single Animated design. Animated GIFs are widely supported across email clients, social platforms, and display ad networks without requiring video playback support.

The API returns immediately and delivers results via a NEW_BANNER_BATCH webhook event to your callback_url when all formats are ready.

INFO

This feature is available from the Pro plan.

Endpoint ​

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

Generation Characteristics ​

  • Supported Design Type: Animated
  • Response: Asynchronous
  • Output: Animated GIF per format
  • Required Parameter: image_file_type=gif
  • Retrieval methods: Webhooks, Polling

Output Customization ​

Use the gif property to customize the output:

Frame Rate (FPS) ​

  • Property: fps
  • Default: 9 fps
  • Range: 2–9 fps

Repeat ​

  • Property: repeat
  • Default: -1 — repeats indefinitely
  • 0: Play once
  • 1: Play twice, etc.

INFO

Duplicate frame removal generates a lighter file without compromising visual quality.

json
{
  "gif": {
    "fps": 8,
    "repeat": 3
  }
}

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",
    "image_file_type": "gif",
    "gif": {
      "fps": 9,
      "repeat": -1
    },
    "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" }