Generate Images

How to generate several images at once - Abyssale REST API

Multiple images can be created at once by sending data and customisation parameters to the POST /async/banner-builder/{template_id}/generate endpoint, which will respond synchronously with only a generation_request_id property.

Generating images asynchronously with a callback url (webhook system)

• Supported template type: Static

• Generation response type: Asynchronous (Webhooks or Polling)

Generation Request (1 & 2)

Generate Multi-Format Images

Generate multiple formats of an image at once from a template designed in Abyssale.

This method is asynchronous and allows to generate several images with one API call. Of course, it can also be used for single image generation (because of time-constraints for instance).

You can find available formats & elements of a template by calling the GET /templates/{templateId} route.

POSThttps://api.abyssale.com/async/banner-builder/{templateId}/generate

Authorization

api_key

Path parameters

templateId*string (uuid)

Unique identifier (UUID) of the template

Body

application/json

elements*Elements (object)

A dictionary containing all elements with properties you would like to override form the default template (keys correspond to layer names)

template_format_namesarray of string

Format IDs you would like to generate.

The array can be empty or not provided if you want to generate all formats of this template.

callback_urlstring (uri)

The url that will be called once generation of your images is done.

We will do a POST request of the NewBannerBatch event on this URL with a JSON payload.

Response

200

Ok

Body

application/json

generation_request_idstring (uuid)

Unique identifier (UUID) of the batch generation

Request

JavaScriptCurlPython

const response = await fetch('https://api.abyssale.com/async/banner-builder/{templateId}/generate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "generation_request_id": "123e4567-e89b-12d3-a456-426614174000"
}

The elements property is the same as Generate Image.

The full api reference can be found here

The callback_url request parameter and the asynchronous mechanism

As this method is asynchronous you should provide a callback_url. The NewBannerBatch event will be POSTed to this URL when the generation batch finishes.

To discover globally how this system works, check out the following Webhooks guide:

Webhooks

Sample request

​Do not forget to replace {YOUR-API-KEY} and {templateId}

cURL

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

Javascript

const axios = require('axios');

const payload = {
  "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"
    }
  }
}

// Replace {id} by your template ID
axios.post("https://api.abyssale.com/async/banner-builder/{id}/generate", payload, {
    headers: {"x-api-key": "{YOUR-API-KEY}", "Content-Type": "application/json", "timeout": 30000}
  }).then(response => {
    console.log(response.data)
}j

Python

import json
import requests

image_generation_payload = {
  "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"
    }
  }
}

# Do not forget to replace {YOUR-API-KEY} and {template_id}
r = requests.post("https://api.abyssale.com/async/banner-builder/{template_id}/generate",
  headers={"x-api-key": "YOUR-API-KEY", "Content-Type": "application/json"},
  data=json.dumps(image_generation_payload),
  timeout=30
)
r.json()

All formats of a template can be generated by removing the template_format_names property.

Sample response

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