Comment on page
Generation
Generating visuals with the Abyssale REST API
Basically, visuals are created by injecting your data (and customisation parameters) into your template.
The generation process is straightforward:
- 1.Design your template in Abyssale (or use one from the Abyssale library) (Check out this video if you would like to design your template)
- 2.Send your data through the API
- 3.Once your generation API request has been executed, there are 2 ways to get your visuals:
Synchronous means that the Abyssale process will wait for your visual to be generated before responding to the API call.
An example of synchronous JPEG generation
- Available for static templates only
- Only a single static image (jpeg, png, pdf) can be generated in this way (hence a single format of your template).
Here are the related documentations using the synchronous response type:
Asynchronous means that the Abyssale process will process your generation request as soon as it become ready. The API response will only contain a
generation_request_id.
From that point, there are 2 possibilities to obtain your visuals.
Once the generation is finished, Abyssale will post the response to a given URL. The associated event is NEW_BANNER_BATCH.
Example of Abyssale Webhook server posting to the callback URL
You can check the progress of an asynchronous generation by periodically calling an Abyssale endpoint with your initial
generation_request_id.
An example of an Abyssale call to check the progress of a generation request.
Here are the related documentations using the asynchronous response type:
Last modified 3mo ago