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 behind the operation id under each path, 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 listDesigns	List designs in your workspace, optionally scoped to a project.	Read	List Designs
GET	/designs/{designId} getDesign	Get full details of one design, including per-format layer data.	Read	Design Details
GET	/designs/{designId}/formats/{formatSpecifier} getDesignFormat	Get the details of one format of a design.	Read	Design Format Details
GET	/designs/{designId}/as-import getDesignAsImport	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 listWorkspaceTemplates	List organisation-level templates, optionally by category.	Read	Workspace Templates
GET	/workspace-template-categories listWorkspaceTemplateCategories	List the categories templates can be filed under.	Read	Workspace Templates
POST	/workspace-templates/{companyTemplateId}/use duplicateWorkspaceTemplate	Duplicate a workspace template into a project as a new design.	Write	Use a Workspace Template
GET	/design-duplication-requests/{duplicateRequestId} getDuplicationRequest	Poll the status of a template-duplication request.	Polling	Use a Workspace Template

Generation

Method	Path	Description	Tier	Guide
POST	/banner-builder/{designId}/generate generateImage	Generate a single image synchronously.	No budget	Generate Single Image
POST	/async/banner-builder/{designId}/generate generateMultiFormatMedia	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 generateMultiPagePdf	Generate a multi-page print PDF asynchronously.	No budget	Multi-Page PDF
GET	/generation-request/{generationRequestId} getGenerationRequest	Poll the status of an asynchronous generation request.	Polling	Asynchronous Generation
GET	/banners/{bannerId} getFile	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 createDesignImport	Create a design import from a full JSON structure (formats + layers).	Write — ?validate_only=true is Validation	Create Import
PUT	/designs/import/json/{importId} validateDesignImport	Validate an import after its assets have been uploaded.	Write	Validate Import
GET	/designs/import/json/{importId} getDesignImport	Poll the status of one import.	Polling	Import Status
GET	/designs/import/json listDesignImports	List your JSON imports, newest first.	Read	Import Status → List your imports

Everything else

Method	Path	Description	Tier	Guide
POST	/auth verifyApiKey	Verify your API key and read the workspace it belongs to.	Read	Authentication
GET	/fonts listFonts	List fonts available for text and button layers.	Read	Fonts
GET	/credits getCredits	Read the workspace's remaining generation and AI credits.	Read	Credits
GET	/projects listProjects	List projects in your workspace.	Read	Projects
POST	/projects createProject	Create a project.	Write	Projects
POST	/async/banners/export exportBanners	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 createDynamicImageUrl	Create the base dynamic image URL for a design.	Write	Create a Dynamic Image
GET	/signing-secret getSigningSecret	Read the workspace's webhook signing secret, creating it on the first call.	Read	Signature verification
POST	/signing-secret/rotate rotateSigningSecret	Issue a new signing secret, keeping the previous one valid for 24 hours.	Write	Signature verification
POST	/signing-secret/revoke revokeSigningSecret	Invalidate the previous signing secret immediately.	Write	Signature verification