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
    • Projects
    • Workspace Templates
    • 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

API Generation Fundamentals

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

  1. Synchronous Generation

    • Design type: static

    • Immediate asset creation

    • Direct response with generated asset URL

  2. Asynchronous Generation

    • 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. Identify Design Type: Understand the specific type of design you're working with: static, animated, print, or multi-page print.

  2. Retrieve Design Configuration: 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. Synchronous Generation: static

    2. Asynchronous Generation: static / animated / print / print_multipage

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

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

The full api reference can be found here.

PreviousDesign DetailsNextDesign information

Last updated 6 months ago