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, 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.
Visual Preview and Download:
Directly below the API console, a preview area will display the generated visual based on your API query. 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.
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.
Output File Type Selection (for Animated Designs):
If your design is an animated design, you'll see a dropdown filter in the top right corner of the console section. This allows you to select the desired output file type for your test generation: GIF, HTML5, or MP4.
Format Selection Panel:
On the right-hand side of the page, a panel allows you to select the desired format (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.