Tools

Generate Image

Generate a single image synchronously from a design template. Override element properties (text, colors, images) and specify a format. Returns the generated image URL immediately. Only works with **static** design types.

Get Design Format

Retrieve detailed information about a specific format of a design, including dimensions, preview URL, dynamic image URL, and all customizable elements with their properties. Use this to inspect available elements before generating images.

Create Dynamic Image

Create a dynamic image URL for a design. Dynamic images allow real-time customization of visuals via URL parameters — useful for personalized email images, Open Graph images, etc. Only one dynamic image is allowed per design; subsequent calls return the existing one.

Export Banners

Export one or more previously generated banners as a downloadable ZIP file. This is an asynchronous operation — a callback URL is required to receive a notification with the download link when the export is ready.

List Designs

List all designs (templates) in your Abyssale workspace. Optionally filter by design type or project, search, sort, or page the results. Returns design metadata including name, type, timestamps, and preview URLs.

Get Duplication Status

Check the status of a workspace template duplication request. Returns progress status and details about duplicated designs once complete.

Generate Multi Format

Start an asynchronous generation of multiple formats (images, videos, PDFs, GIFs, or HTML5 banners) from a single design. Returns a generation request ID for tracking progress. Use "Get Generation Status" to poll for results, or provide a callback URL to receive a webhook when complete.

List Projects

List all projects in your Abyssale workspace. Projects are used to organize designs.

Get Generation Status

Poll the status of an asynchronous generation request. Returns whether the generation is finalized, along with any generated banners and errors. Use this after calling "Generate Multi-Format" to retrieve results.

Create Project

Create a new project in your Abyssale workspace for organizing designs.

Duplicate Workspace Template

Duplicate a workspace template into a target project. This is an asynchronous operation — use "Get Duplication Status" to track progress.

List Fonts

List all fonts available in your Abyssale workspace, including custom uploads and Google Fonts. Returns font IDs that can be used to override text element fonts during generation.

List Workspace Templates

Discover shared workspace master templates to duplicate into a project. These are separate from project designs returned by list_designs.

Generate Multipage Pdf

Generate a print-ready PDF asynchronously from a printer_multipage design. Inspect pages with get_design, then provide layer overrides per page. Poll get_generation_status for the downloadable result.

Get Generated File

Retrieve a previously generated image, video, GIF, PDF, or HTML5 ZIP file by its banner ID, including a downloadable file and complete provider metadata.

List Workspace Template Categories

Discover category IDs and names used to organize and filter workspace master templates.

Get Design

Inspect a design before generation: formats, elements, variables, print settings, animation, or multipage pages and per-page elements. Enable advanced to include group layers.

Get Credits

Retrieve remaining generation and AI credits for the current workspace and billing period. A null available balance or limit means unlimited.

Get Workspace

Verify the connected API key and retrieve the workspace name it belongs to. This does not return a user profile or account ID.