Connecting to CloudConvert

CloudConvert uses API key authentication. Your CloudConvert API key is used to authenticate requests as a Bearer token. You can generate or view your keys at https://cloudconvert.com/dashboard/api/v2/keys.

Using API Key Authentication

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

AuthScheme: Set this to APIKey.
APIKey: Set this to your CloudConvert API key.

Example connection string:

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

Available Tables

The CloudConvert API Profile provides access to file conversion data across 4 tables:

Jobs - Asynchronous conversion jobs in CloudConvert. Each job contains one or more tasks that perform file conversions, imports, and exports.
Operations - Supported conversion operations and their available engines, formats, and options. Use filters to narrow results by operation type, input format, output format, or engine.
Tasks - Individual tasks within CloudConvert jobs. Each task performs a specific operation such as file conversion, import, or export.
Users - The authenticated CloudConvert user account. This table always returns a single row representing the currently authenticated user.

Usage Examples

Jobs:

SELECT * FROM Jobs

Operations:

SELECT * FROM Operations

Tasks:

SELECT * FROM Tasks

Users:

SELECT * FROM Users

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