Connecting to Abyssale

Abyssale uses API Key authentication. Your Abyssale API Key is sent as the x-api-key request header. You can generate or view your API Key in the Abyssale dashboard under Settings > API.

Using ApiKey Authentication

After setting the following connection properties, you are ready to connect:

AuthScheme: Set this to APIKey.
APIKey: Set this to your Abyssale API Key.

Example connection string:

Profile=C:\profiles\Abyssale.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Available Tables

The Abyssale API Profile provides access to design templates and generation data across 5 tables:

Designs - Query Abyssale design templates with associated formats, elements, and variable configurations.
DesignFormats - Access individual format specifications for a design, including dimensions, preview URL, and element configurations.
Fonts - Query workspace fonts available in Abyssale, including Google Fonts and custom uploaded fonts.
Projects - Access Abyssale workspace projects that organize design templates.
DesignDuplicationRequests - Access asynchronous design duplication operation requests, tracking status and duplicated design results.

Usage Examples

Designs:

SELECT * FROM Designs
SELECT * FROM Designs WHERE Id = 'design-uuid'
SELECT * FROM Designs WHERE Type = 'static'

DesignFormats:

SELECT * FROM DesignFormats WHERE DesignId = 'design-uuid' AND FormatSpecifier = 'format-specifier'

Fonts:

SELECT * FROM Fonts

Projects:

SELECT * FROM Projects

DesignDuplicationRequests:

SELECT * FROM DesignDuplicationRequests WHERE RequestId = 'duplication-request-uuid'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	The API key used to authenticate to Abyssale.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD