Connecting to ConvertAPI

ConvertAPI uses API Secret Key authentication. Your ConvertAPI Secret is used to authenticate requests. You can find your API Secret in the ConvertAPI dashboard under your account settings.

Using APIKey Authentication

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

AuthScheme: Set this to APIKey.
APIKey: Set this to your ConvertAPI API secret key.

Example connection string:

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

Available Tables

The ConvertAPI API Profile provides access to account and converter catalog data across 5 tables:

User - Query account information and usage statistics for the authenticated ConvertAPI account.
Converters - Query the complete catalog of 242 file converters supported by ConvertAPI, grouped into 18 converter categories.
CanConvert - Check whether conversion between two specific file formats is supported.

Usage Examples

Get account information and usage statistics:

SELECT * FROM User

Get all available converters:

SELECT * FROM Converters

Check whether converting PDF to DOCX is supported:

SELECT Message FROM CanConvert WHERE FromFormat = 'pdf' AND ToFormat = 'docx'

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 secret key used to authenticate to ConvertAPI.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT