Abyssale Developer Hub
  • Getting Started
  • Rest API
    • Overview - Rest API
    • Authentication
    • Designs
      • Design Details
    • Generation
      • Design information
      • Synchronous generation
        • Generate single image
      • Asynchronous generation
        • Generate Multi-Format images
        • Generate Multi-Format PDFs for Printing
        • Generate Multi-Page PDF for Printing
        • Generate Multi-Format Videos
        • Generate Multi-Format Animated GIFs
        • Generate HTML5 Banner Ads
          • ad network
      • Element properties
        • Root
        • Text
        • Button
        • Image
        • Logo
        • Shape
        • Rating
        • Illustration
        • QR Code
        • Video
        • Audio
      • Errors
    • Image Export
    • Fonts
    • Annexes
    • API Reference
  • Dynamic Images
    • Overview - Dynamic Images
    • Dynamic Image generation with URL
  • Webhooks
    • Overview - Webhooks
    • Events
      • Design
      • Banner
      • Global events
Powered by GitBook
On this page
  • API Generation Fundamentals
  • Getting Started with Design Generation
  1. Rest API

Generation

Generating visuals with the Abyssale REST API

PreviousDesign DetailsNextDesign information

Last updated 6 months ago

API Generation Fundamentals

Our platform provides flexible design generation capabilities through two primary modes:

    • Design type: static

    • Immediate asset creation

    • Direct response with generated asset URL

    • Design type: static / animated / print / print_multipage

    • Batch asset creation

    • Request tracking via generation ID

    • Supports webhook and polling retrieval

Getting Started with Design Generation

  1. : Understand the specific type of design you're working with: static, animated, print, or multi-page print.

  2. : Locate your design ID and default payload through the API panel in the design builder.

  3. Choose the generation mode base on the design type:

    1. : static

    2. : static / animated / print / print_multipage

  4. : Configure specific layer properties, content, to match your needs.

  5. : Manage potential generation issues through comprehensive error checking.

Synchronous Generation
Asynchronous Generation
Identify Design Type
Retrieve Design Configuration
Synchronous Generation
Asynchronous Generation
Element Customization
Error Handling
The full api reference can be found here.