CloudConvert - REST API Console

API v1 is deprecated and will be turned off on January 1, 2022. Check out the API v2 documentation.

The API Console generates requests for the convert API. Moreover you can find generated ready-to-use code snippets at the bottom of this page.

{{ method }} https://api.cloudconvert.com/v1/convert{{{ parameters | filterEmpty | prettyQueryParameters }}}

{{{ parameters | filterEmpty | prettyJson }}}

Hide Result Basic Parameters
Parameter	Description	Value
apikey Required	Your personal ApiKey. You can get it here.
mode Optional	Mode of the process. Defaults to convert.
inputformat Required	The format of the input file.
outputformat Required	The format the file should be converted to.
Input Parameters
Parameter	Description	Value
input Required	Set the method of uploading the input file.	{{ parameters.input \| valueOrFirstKey }} upload download s3 openstack azure googlecloud ftp raw base64
file Required	The input file.
file Required	The download URL of the input file.
file Required	The URL of the website to convert.
file Required	The raw content of the input file to convert.
file Required	The base64 encoded content of the input file to convert.
input.s3.accesskeyid Required	The Amazon S3 accessKeyId.
input.s3.secretaccesskey Required	The Amazon S3 secretAccessKey.
input.s3.sessiontoken Optional	Auth using AWS Security Token Service. Optional additional to accessKeyId/secretAccessKey.
input.s3.bucket Required	The Amazon S3 bucket where to download the input file or upload the output file.
input.s3.region Optional	Specify the Amazon S3 endpoint, e.g. us-west-2 or eu-west-1. As default us-east-1 will be used.
file Required	S3 key of the input file (normally the filename, including path).
input.openstack.authurl Required	The URL of the OpenStack Identity endpoint (without version).
input.openstack.username Required	The OpenStack username.
input.openstack.password Required	The OpenStack password.
input.openstack.container Required	The name of the OpenStack Storage Container where to download the input file.
input.openstack.region Optional	Specify the OpenStack region.
file Required	The filename, including path, of the input file.
input.azure.storageaccount Required	The name of the Azure storage account (This is the string before .file.core.windows.net).
input.azure.storageaccesskey Required	The Azure secret key.
input.azure.sharename Required	The name of the Azure Share where to download the input file.
file Required	The filename, including path, of the input file.
input.googlecloud.projectid Required	The Google Cloud Project ID.
input.googlecloud.bucket Required	The Google Cloud Storage Bucket name.
input.googlecloud.credentials Required	The credentials object is the content of the JSON key file, which can be generated using the Google Developers Console.
file Required	The filename, including path, of the input file.
input.ftp.host Required	The FTP server host.
input.ftp.port Optional	The port the FTP server is bind to. Defaults to 21.
input.ftp.user Required	FTP username.
input.ftp.password Required	FTP password.
file Required	Filename, including path, of the input file.
filename Required Optional	Override the input filename. Must include the input file extension.
Conversion Parameters
Parameter	Description	Value
timeout Optional	Timeout in seconds after the conversion will be cancelled. As default your account wide timeout will be used (5h for paid accounts).
preset Optional	Preset of conversion specific options. You can manage your presets here.	{{ parameters.preset != '' ? parameters.preset : 'none' }} none {{preset.name}} ({{preset.id}})
converteroptions Optional	Conversion specific options.	Clear Options
converteroptions.{{key}}
Output Parameters
Parameter	Description	Value
output Optional	The output storage for the converted file.	{{ parameters.output != '' ? parameters.output : 'none' \| valueOrFirstKey}} none dropbox googledrive onedrive box s3 openstack azure googlecloud ftp
output.s3.accesskeyid Required	The Amazon S3 accessKeyId.
output.s3.secretaccesskey Required	The Amazon S3 secretAccessKey.
output.s3.sessiontoken Optional	Auth using AWS Security Token Service. Optional additional to accessKeyId/secretAccessKey.
output.s3.bucket Required	The Amazon S3 bucket where to download the input file or upload the output file.
output.s3.region Optional	Specify the Amazon S3 endpoint, e.g. us-west-2 or eu-west-1. As default us-east-1 will be used.
output.s3.path Optional	Filename (S3 key), including path, for the output file. If this value ends with "/" the output file is stored in the corresponding directory.
output.s3.acl Optional	S3 ACL for storing the output file. Possible values include: private, public-read, public-read-write, authenticated-read, bucket-owner-read, bucket-owner-full-control.
output.openstack.authurl Required	The URL of the OpenStack Identity endpoint (without version).
output.openstack.username Required	The OpenStack username.
output.openstack.password Required	The OpenStack password.
output.openstack.container Required	The name of the OpenStack Storage Container where to upload the output file.
output.openstack.region Optional	Specify the OpenStack region.
output.openstack.path Optional	Filename, including path, for the output file. If this value ends with "/" the output file is stored in the corresponding directory.
output.azure.storageaccount Required	The name of the Azure storage account (This is the string before .file.core.windows.net).
output.azure.storageaccesskey Required	The Azure secret key.
output.azure.sharename Required	The name of the Azure Share where to upload the output file.
output.azure.path Optional	Filename, including path, for the output file. If this value ends with "/" the output file is stored in the corresponding directory.
output.googlecloud.projectid Required	The Google Cloud Project ID.
output.googlecloud.bucket Required	The Google Cloud Storage Bucket name.
output.googlecloud.credentials Required	The credentials object is the content of the JSON key file, which can be generated using the Google Developers Console.
output.googlecloud.path Optional	Filename, including path, for the output file. If this value ends with "/" the output file is stored in the corresponding directory.
output.ftp.host Required	The FTP server host.
output.ftp.port Optional	The port the FTP server is bind to.
output.ftp.user Required	FTP username.
output.ftp.password Required	FTP password.
output.ftp.path Optional	Filename, including path, for the output file. If not set the path will be choosen automatically. If this value ends with "/" the output file is stored in the corresponding directory.
wait Optional	Block request until the converison is finished.
callback Optional	Provide a callback URL for notification when the conversion is finished. You should disable the "wait" parameter if you use a callback.
download Optional	Download output file after conversion is finished or display it in browser (inline).	false (no download) true inline
save Optional	Save files on CloudConvert. Otherwise all files will be deleted immediately after the first download.

API Console

Basic Parameters

Input Parameters

Conversion Parameters

Output Parameters

Code Snippets