Image Export

Generate a ZIP archive containing multiple previously-generated images.

INFO

This process is asynchronous and requires a webhook endpoint to receive the export result.

Banner IDs are returned by the synchronous generation and asynchronous generation endpoints.

Step 1 — Request an Export

POST/async/banners/exportAPI Reference

Request Body

Field	Type	Required	Description
ids	array	Yes	Array of banner IDs (UUIDs) to include in the ZIP archive.
callback_url	string (uri)	Strongly recommended	URL that will receive a POST request when the export is ready. There is no polling endpoint for exports — if omitted, you will have no way to retrieve the export result.

Response

Field	Type	Description
export_id	string (uuid)	Unique identifier of the export job. Use this to match the incoming webhook.

Request Example

{
  "ids": [
    "64238d01-d402-474b-8c2d-fbc957e9d290",
    "7b349e12-e513-585c-9d3e-acd068f0ae40"
  ],
  "callback_url": "https://your-webhook.com/export-abyssale"
}

Step 2 — Receive the Export ID

If the request is accepted, the API returns an export_id identifying the asynchronous export job.

Possible errors:

• 400 — Invalid parameter (e.g. a banner ID that is not a valid UUID).
• 404 — One of the given banner IDs could not be found.

Step 3 — Receive the NewExport Event

Once the export is ready, Abyssale sends a NewExport webhook event (POST) to the callback_url you specified.

TIP

If the initial request returns an export ID, the NewExport event will always be sent — even if some images failed.

See Global Events for the full payload structure.