Abyssale integration: operations for AI agents
Abyssale connects to Type.com as an integration. This page lists the 30 operations documented for Claude and Codex in Type.com: 15 read, 11 write, 4 destructive.
About Abyssale
Abyssale is a creative automation platform that enables users to generate images, videos, GIFs, PDFs, and HTML5 content programmatically, streamlining visual content production.
Categories: Design & Media
How to connect Abyssale to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
30 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
30 operations listed.
Authentication
- Write
Verify an API key
Check that an API key is usable, and find out which workspace it belongs to.
Designs
- Read
List and search designs
Retrieve the designs available in your Abyssale workspace. Each design defines the visual layout, available formats (dimensions), and configurable elements (text, images, shapes, etc.) that can be overridden during image generation.
- Read
Get design details
Retrieve the full specification of a design: its formats (dimensions and preview URLs), all configurable elements with their properties, and any template variables defined in text layers. Use this endpoint to discover what data to send in a generation request.
- Read
Get format details
Retrieve detailed information for a specific format within a design, including dimensions, unit, preview URL, dynamic image URL, element layout, and variables. Useful for inspecting a single format before generating or building dynamic image URLs.
- Destructive
Delete a design
Delete one design from your workspace. Once deleted, it no longer appears in GET /designs, and every endpoint that takes its id — reads, generation, rename, move — answers 404 templatenotfound. Files already generated from it are not affected.
- Destructive
Rename a design
Change the name of one design. The name is trimmed, then must be 1 to 100 characters. Sending the name the design already has succeeds and changes nothing. Design names need not be unique: two designs, in the same project or not, can share one.
- Destructive
Move a design to another project
Move one design to another project of your workspace. List the projects, and their ids, with GET /projects. Moving a design resets its approval status, since that approval was given within the project it leaves.
Dynamic Images
- Write
Create a dynamic image URL
Creates a dynamic image URL for a given design (static designs only). Only one dynamic image is allowed per design — subsequent calls return the existing dynamic image (200 instead of 201).
Files
- Read
Get generated file
Retrieve the metadata and download URLs for a previously generated file (image, video, GIF, HTML5 banner, or PDF). Returns both the S3 storage URL and a CDN-hosted URL suitable for embedding directly in websites or emails.
Asset Generation
- Read
Poll async generation request status
Poll the status of an asynchronous generation request. Use this endpoint to track the progress of a batch generation operation started with the async generate endpoint. The result is available for 7 days after generation.
- Write
Generate an image (synchronous)
Synchronously generate a single image from a design. Send your dynamic data (text, images, colors) as element overrides in the request body and receive the generated file URL immediately in the response. static designs only.
- Write
Generate multiple formats (asynchronous)
Asynchronously generate multiple formats of an image, video, GIF, HTML5 banner, or PDF in a single API call. Ideal for bulk banner production, multi-channel marketing campaigns, and programmatic ad creative generation at scale.
- Write
Generate a multi-page PDF (asynchronous)
Asynchronously generate a multi-page print-ready PDF from a printermultipage design. Each page is defined by a pages dictionary entry, allowing different element overrides per page — ideal for brochures, catalogs, and variable data printing.
Webhooks
- Write
Get the webhook signing secret
Retrieve the workspace's webhook signing secret, creating it on the first call and returning the same value on every call after that. One secret covers every webhook in the workspace — dashboard subscriptions and per-job callbackurl deliveries alike.
- Write
Rotate the webhook signing secret
Issue a new signing secret and keep the previous one valid for 24 hours. During that window every delivery carries two v1 hashes — one per secret — so a receiver holding either value still verifies.
- Write
End the rotation overlap early
Invalidate the previous secret, ending the 24-hour overlap early. The current secret is untouched. Signing applies the change within 60 seconds — deliveries already in flight may still carry a signature from the revoked secret for up to a minute.
Fonts
- Read
List and search fonts
Retrieve the fonts available in your Abyssale workspace, including Google Fonts and any custom fonts you have uploaded, ordered by name. Use a font's id to override the font on text or button elements in a generation request.
Credits
- Read
Get remaining credits
Remaining generation and AI credits for the caller's workspace, for the current billing period.
Exports
- Read
Export generated assets as a ZIP archive (asynchronous)
Asynchronously package a set of previously generated assets — any output type (JPEG, PNG, WEBP, AVIF, PDF, MP4, GIF, HTML5 bundle) — into a single ZIP archive for download.
Projects
- Read
List and search projects
Retrieve the projects in your workspace, ordered by name. Projects group designs into logical collections. Only designs that belong to a project are accessible via the API.
- Write
Create a project
Create a new project to organize your designs. Assign designs to this project in the Abyssale editor to make them accessible via the API.
Workspace Templates
- Read
List all workspace templates
Retrieve the organisation-level master designs shared across your workspace. A workspace template lives in a category (categoryid), not a project — it belongs to the organisation until you duplicate it into a project with POST /workspace-templates/{companyTemplateId}/use.
- Read
List workspace template categories
The categories that group your workspace templates. Use an id from here as the categoryid filter on GET /workspace-templates. This is the workspace-template counterpart of GET /projects, which groups designs.
- Read
Poll template duplication request status
Poll the status of a template duplication request. Use this endpoint to track the progress of an asynchronous duplication operation.
- Write
Duplicate a workspace template into a project
Copy a shared workspace template into one of your projects, creating an editable design instance. The duplication is asynchronous — use the returned duplicationrequestid to poll for completion via GET /design-duplication-requests/{duplicateRequestId}.
Design Import
- Read
List imports
Alpha. This API is in Alpha. The contract may change without notice and imports created with it are not guaranteed to remain compatible. It is not covered by deprecation policy. List this company's JSON template imports, newest first.
- Read
Get import status
Alpha. This API is in Alpha. The contract may change without notice and imports created with it are not guaranteed to remain compatible. It is not covered by deprecation policy. Poll the status of a JSON template import. Scoped to the caller's company.
- Read
Export a design as an import payload
Alpha. The contract may change without notice and imports created with it are not guaranteed to remain compatible. Not covered by the deprecation policy.
- Write
Create a design from JSON
Alpha. This API is in Alpha. The contract may change without notice and imports created with it are not guaranteed to remain compatible. It is not covered by deprecation policy. Submit a template structure as JSON.
- Destructive
Validate an import and queue it
Alpha. This API is in Alpha. The contract may change without notice and imports created with it are not guaranteed to remain compatible. It is not covered by deprecation policy. Call this after every entry of uploads[] has been POSTed to S3.
No operations match.
See How connections work for access and permissions, or browse all integrations.