Endpoint Catalog

Every endpoint documented on this site, for scanning before you dive into a guide. All paths are relative to https://api.abyssale.com.

Request and response shapes live on the linked guide, the full schema is at api-reference.abyssale.com, and how these fit together is on the Overview.

The Tier column is the endpoint's rate-limit budget class; the numbers behind each one are on Rate limits.

Designs

Method	Path	Description	Tier	Guide
GET	/designs	List designs in your workspace, optionally scoped to a project.	Read	List Designs
GET	/designs/{designId}	Get full details of one design, including per-format layer data.	Read	Design Details
GET	/designs/{designId}/formats/{formatSpecifier}	Get the details of one format of a design.	Read	Design Format Details
GET	/designs/{designId}/as-import	Export a live design back into the Design Import JSON schema.	Write	Export a Design

Workspace Templates

Method	Path	Description	Tier	Guide
GET	/workspace-templates	List organisation-level templates, optionally by category.	Read	Workspace Templates
GET	/workspace-template-categories	List the categories templates can be filed under.	Read	Workspace Templates
POST	/workspace-templates/{companyTemplateId}/use	Duplicate a workspace template into a project as a new design.	Write	Use a Workspace Template
GET	/design-duplication-requests/{duplicateRequestId}	Poll the status of a template-duplication request.	Polling	Use a Workspace Template

Generation

Method	Path	Description	Tier	Guide
POST	/banner-builder/{designId}/generate	Generate a single image synchronously.	No budget	Generate Single Image
POST	/async/banner-builder/{designId}/generate	Generate one or more formats asynchronously — images, videos, GIFs, HTML5 banners, or single-page print PDFs.	No budget	Asynchronous Generation
POST	/async/banner-builder/{designId}/generate-multipage-pdf	Generate a multi-page print PDF asynchronously.	No budget	Multi-Page PDF
GET	/generation-request/{generationRequestId}	Poll the status of an asynchronous generation request.	Polling	Asynchronous Generation
GET	/banners/{bannerId}	Retrieve a previously generated file — metadata plus the storage and CDN download URLs.	Read	Asynchronous Generation

Design Import

Method	Path	Description	Tier	Guide
POST	/designs/import/json	Create a design import from a full JSON structure (formats + layers).	Write — ?validate_only=true is Validation	Create Import
PUT	/designs/import/json/{id}	Validate an import after its assets have been uploaded.	Write	Validate Import
GET	/designs/import/json/{id}	Poll the status of one import.	Polling	Import Status
GET	/designs/import/json	List your JSON imports, newest first.	Read	Import Status → List your imports

Everything else

Method	Path	Description	Tier	Guide
POST	/auth	Verify your API key and read the workspace it belongs to.	Read	Authentication
GET	/fonts	List fonts available for text and button layers.	Read	Fonts
GET	/projects	List projects in your workspace.	Read	Projects
POST	/projects	Create a project.	Write	Projects
POST	/async/banners/export	Request an asynchronous ZIP export of generated assets (any output type); delivered via the NEW_EXPORT webhook.	Write	Asset Export
POST	/designs/{designId}/dynamic-image-url	Create the base dynamic image URL for a design.	Write	Create a Dynamic Image