For developers and users looking to integrate Abyssale into their applications, understanding how your designs respond to API calls is crucial. Abyssale provides a dedicated "API" tab for every single design you create, offering a convenient in-app console to test your API requests before writing any code.
Where to Find the API Tab
When you open any design in any project, you'll see a series of tabs on the left-hand side, usually below "Integrations". Simply click on the "API" tab to access the testing console.
Key Features of the API Console
Please note: Every generation made using this in-app API console will consume credits from your Abyssale plan, just like any other generation method.
This dedicated section is designed to streamline your API integration process with several powerful functionalities:
Interactive API Console:
You'll find a central console where you can post any attributes relevant to your design. This acts as a sandbox to craft the JSON payload for your API requests.
Abyssale provides a "Sample Post" with basic attributes pre-filled and generated from the design's current configuration, giving you a starting point to quickly test the design by API.
After modifying the JSON, click the "Query API" button to send your request. The response JSON will be displayed immediately, allowing you to debug and refine your payload.
Query Mode: Sync or Async (NEW) The Query mode selector in the top right corner of the console lets you choose which generation path to test. The sample payload, the available options, and the result behavior all update to match the selected mode.
Sync — Return one static image directly. Generates a single format and returns the result in the response. The payload uses
template_format_name(a single string).Async — Queue generation and return an ID. Generates one or many formats in a single call, processed in the background. The payload uses
template_format_names(an array). In production, results are delivered via webhook or retrieved by polling the request ID; in the console, the result is still displayed directly below, the console handles the polling for you.
Some AI actions are only available in async mode. Remove Background and Text-to-Image are only supported on asynchronous generation, because they can exceed the synchronous path's 10-second limit. To avoid generating a payload that would fail, the console only includes the parameters supported by the selected mode:
Query mode | AI parameters included in the sample payload |
Sync | Auto Focus ( |
Async | Auto Focus, Remove Background ( |
If Remove Background or Text-to-Image is enabled on your design and you don't see it in the payload, switch to Async. In sync mode, an info block below the console explains this and links to the asynchronous generation documentation. Animated, print, and multi-page print designs are async-only, and the console behaves the same way for them.
Output File Type Selection : The File type dropdown next to the Query mode selector lets you choose the output format for your test generation. It is now available for all design types:
Static designs: Auto, PNG, JPEG, WEBP, or AVIF
Animated designs: GIF, HTML5, or MP4
Visual Preview and Download:
Directly below the API console, a preview area will display the generated visual based on your API query, in both sync and async mode. This real-time feedback is invaluable for seeing the results of your data changes.
You can also download the generated image directly from this preview area.
Quick Action Buttons: For quick access to common actions and documentation, you'll find several convenient buttons:
Copy Code: Instantly copies a code snippet (often Curl or a basic request) based on your current query and selected mode.
Copy Design ID: Copies the unique ID of the current design, which is essential for making API calls.
API Reference: Opens a new tab to the Abyssale API Reference for detailed endpoint documentation.
Developer Hub: Opens a new tab to the Abyssale Developer Hub for a broader overview and guides.
Format Selection Panel:
On the right-hand side of the page, a panel allows you to select the desired format(s) (e.g., Instagram Story, YouTube Thumbnail) of your design for the current API test. This ensures your query targets the correct dimensions and aspect ratio.
The in-app API console is an indispensable tool for developing and debugging your Abyssale API integrations efficiently.