Abyssale icon

Abyssale

Consume Abyssale API

Actions10

Banner → Generate Single Image

AI-generated

Summary

Generate a single image from an Abyssale design. Supports optional AI text-to-image generation for image elements with up to 4 inpaint images.

Inputs

  • designId (required) — Select the design to use for generation. Choose from the list, or specify an ID using an expression.
  • designFormat (required) — Select the design format to use for generation. Choose from the list, or specify an ID using an expression.
  • imageFileType — Choose the output file format (auto selects JPEG or PNG based on transparency). Default: auto
  • root — Use a 6 or 8-digit hexadecimal color or CMYK color for the banner, if the design allows.
  • textElements — Text elements to modify: specify element ID/name, text content, and optional text color.
  • imageElements — Image elements to modify: specify element ID/name and either an image URL or provide AI text-to-image generation parameters (prompt and optional up to 4 inpaint images).
  • buttonElements — Button elements to modify: specify element ID/name, button text content, text color, and button background color.
  • shapeElements — Shape elements to modify: specify element ID/name and background color.
  • logoElements — Logo elements to modify: specify element ID/name and logo image URL.
  • qrcodeElements — QR code elements to modify: specify element ID/name, QR code image URL, and QR code content.
  • ratingElements — Rating elements to modify: specify element ID/name and rating score (0 to 100).
  • illustrationElements — Illustration elements to modify: specify element ID/name, illustration file name, and illustration library type.
  • simplify — Whether to return a simplified version of the response instead of the raw data. Default: false

Output shape

If simplify is enabled, returns { id, url, cdn_url, design_id, format_id }. Otherwise returns the full API response as JSON.

The operation sends a POST request to /banner-builder/{designId}/generate with a body composed from provided parameters: design format, output file type, root background color, and optionally modifies text/image/button/shape/logo/QR code/rating/illustration elements. For image elements, either an image URL or AI text-to-image instructions can be supplied (with prompt and up to 4 inpaint images). Simplification returns a reduced response object. URL fields are validated for correct format; inpaint images are limited to 4.

Examples

Example 1: Generate a single PNG image with custom root color and simplified response

designId: 'design_123', designFormat: 'format_1', imageFileType: 'png', root: '#EAEAEA', simplify: true

Links

Discussion