Skip to main content
Server path: /cloudconvert | Type: Application | PCID required: Yes

Tools

ToolDescription
cloudconvert_cancel_taskCancel a task
cloudconvert_create_archive_taskCreate an archive task
cloudconvert_create_capture_website_taskCreate a capture-website task
cloudconvert_create_convert_taskCreate a convert task
cloudconvert_create_export_azure_blob_taskExport file to Azure Blob Storage
cloudconvert_create_export_google_drive_taskExport file to Google Drive
cloudconvert_create_export_openstack_taskExport file to OpenStack Object Storage
cloudconvert_create_export_s3_taskExport file to Amazon S3
cloudconvert_create_export_sftp_taskExport file via SFTP
cloudconvert_create_export_url_taskExport file as a temporary URL
cloudconvert_create_import_azure_blob_taskImport file from Azure Blob Storage
cloudconvert_create_import_google_drive_taskImport file from Google Drive
cloudconvert_create_import_openstack_taskImport file from OpenStack Object Storage
cloudconvert_create_import_s3_taskImport file from Amazon S3
cloudconvert_create_import_sftp_taskImport file via SFTP
cloudconvert_create_import_url_taskImport file from URL
cloudconvert_create_jobCreate a job
cloudconvert_create_merge_taskCreate a merge task
cloudconvert_create_metadata_read_taskCreate a metadata read task
cloudconvert_create_metadata_write_taskCreate a metadata write task
cloudconvert_create_optimize_taskCreate an optimize task
cloudconvert_create_thumbnail_taskCreate a thumbnail task
cloudconvert_create_watermark_taskCreate a watermark task
cloudconvert_create_webhookCreate a webhook
cloudconvert_delete_jobDelete a job
cloudconvert_delete_taskDelete a task
cloudconvert_delete_webhookDelete a webhook
cloudconvert_get_current_userGet current user
cloudconvert_get_jobGet a job
cloudconvert_get_taskGet a task
cloudconvert_get_webhookGet a webhook
cloudconvert_list_jobsList jobs
cloudconvert_list_operationsList supported conversion operations
cloudconvert_list_tasksList tasks
cloudconvert_list_webhooksList webhooks
cloudconvert_retry_taskRetry a task

cloudconvert_cancel_task

Cancel a task Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTask ID (UUID).

cloudconvert_create_archive_task

Create an archive task Parameters:
ParameterTypeRequiredDefaultDescription
enginestringNoOptional archiving engine override.
filenamestringNoOutput filename.
inputstring[]YesArray of input task names to archive.
output_formatstringYesArchive format.
timeoutintegerNoMaximum task duration in seconds.

cloudconvert_create_capture_website_task

Create a capture-website task Parameters:
ParameterTypeRequiredDefaultDescription
cssstringNoCustom CSS to inject before capturing.
display_header_footerbooleanNoDisplay header/footer (PDF only).
enginestringNoCapture engine (e.g. ‘chrome’).
engine_versionstringNoOptional engine version.
filenamestringNoOutput filename.
footer_templatestringNoHTML template for the footer.
header_templatestringNoHTML template for the header.
headersobjectNoCustom HTTP headers for the request.
javascriptstringNoCustom JavaScript to run before capturing.
margin_bottomnumberNoBottom margin in inches (PDF only).
margin_leftnumberNoLeft margin in inches (PDF only).
margin_rightnumberNoRight margin in inches (PDF only).
margin_topnumberNoTop margin in inches (PDF only).
output_formatstringYesOutput format: pdf, png, or jpg.
page_heightnumberNoCustom page height in inches (PDF only).
page_orientationstringNoPage orientation (PDF only).
page_widthnumberNoCustom page width in inches (PDF only).
pagesstringNoPage range (PDF only), e.g. ‘1-3’.
print_backgroundbooleanNoWhether to print background graphics (PDF only).
timeoutintegerNoMaximum task duration in seconds.
urlstringYesURL of the website to capture.
wait_for_elementstringNoCSS selector to wait for.
wait_timeintegerNoAdditional wait time in milliseconds.
wait_untilstringNoWhen to consider the page loaded.
zoomnumberNoZoom factor (default 1.0).

cloudconvert_create_convert_task

Create a convert task Parameters:
ParameterTypeRequiredDefaultDescription
enginestringNoOptional conversion engine (e.g. ‘office’, ‘libreoffice’, ‘imagemagick’).
engine_versionstringNoOptional engine version.
filenamestringNoOutput filename (without extension).
inputstring[]YesTask name(s) of the input task in the same job, or task ID(s). Can be a string or array of strings.
input_formatstringNoOptional input file format override (e.g. ‘pdf’, ‘docx’).
output_formatstringYesTarget output format (e.g. ‘pdf’, ‘png’, ‘docx’, ‘mp4’).
timeoutintegerNoMaximum task duration in seconds.

cloudconvert_create_export_azure_blob_task

Export file to Azure Blob Storage Parameters:
ParameterTypeRequiredDefaultDescription
blobstringYesDestination blob path/name.
containerstringYesBlob container name.
inputstring[]YesTask name(s) whose output should be exported.
sas_tokenstringNoOptional SAS token.
storage_access_keystringYesStorage access key (or use sas_token).
storage_accountstringYesAzure storage account name.

cloudconvert_create_export_google_drive_task

Export file to Google Drive Parameters:
ParameterTypeRequiredDefaultDescription
access_tokenstringYesOAuth access token for Google Drive.
file_namestringNoOptional destination filename.
folder_idstringNoOptional destination folder ID.
inputstring[]YesTask name(s) whose output should be exported.

cloudconvert_create_export_openstack_task

Export file to OpenStack Object Storage Parameters:
ParameterTypeRequiredDefaultDescription
auth_urlstringYesKeystone auth URL.
containerstringYesSwift container name.
filestringYesDestination file path.
inputstring[]YesTask name(s) whose output should be exported.
passwordstringYesOpenStack password.
regionstringYesOpenStack region.
tenant_namestringNoOptional tenant/project name.
usernamestringYesOpenStack username.

cloudconvert_create_export_s3_task

Export file to Amazon S3 Parameters:
ParameterTypeRequiredDefaultDescription
access_key_idstringYesAWS access key ID.
aclstringNoS3 canned ACL (e.g. ‘private’, ‘public-read’).
bucketstringYesS3 bucket name.
cache_controlstringNoS3 Cache-Control header.
endpointstringNoOptional S3-compatible endpoint.
inputstring[]YesTask name(s) whose output should be exported.
keystringYesDestination S3 key (path).
metadataobjectNoS3 user metadata to attach.
regionstringNoAWS region.
secret_access_keystringYesAWS secret access key.
server_side_encryptionstringNoS3 server-side encryption (e.g. ‘AES256’, ‘aws:kms’).
session_tokenstringNoOptional STS session token.
taggingobjectNoS3 object tags to attach.

cloudconvert_create_export_sftp_task

Export file via SFTP Parameters:
ParameterTypeRequiredDefaultDescription
filestringYesDestination file path.
hoststringYesSFTP host.
inputstring[]YesTask name(s) whose output should be exported.
passwordstringNoSFTP password (or use private_key).
portintegerNoSFTP port (default 22).
private_keystringNoPrivate key (PEM) (alternative to password).
usernamestringYesSFTP username.

cloudconvert_create_export_url_task

Export file as a temporary URL Parameters:
ParameterTypeRequiredDefaultDescription
archive_multiple_filesbooleanNoPack multiple inputs into a single zip URL.
inlinebooleanNoWhether the URL serves the file inline (rather than as attachment).
inputstring[]YesTask name(s) whose output should be exported.

cloudconvert_create_import_azure_blob_task

Import file from Azure Blob Storage Parameters:
ParameterTypeRequiredDefaultDescription
blobstringYesBlob path/name.
containerstringYesBlob container name.
filenamestringNoOptional filename override.
sas_tokenstringNoOptional SAS token (alternative to storage_access_key).
storage_access_keystringYesStorage access key (or use sas_token).
storage_accountstringYesAzure storage account name.

cloudconvert_create_import_google_drive_task

Import file from Google Drive Parameters:
ParameterTypeRequiredDefaultDescription
access_tokenstringYesOAuth access token for Google Drive.
file_idstringYesGoogle Drive file ID.
filenamestringNoOptional filename override.

cloudconvert_create_import_openstack_task

Import file from OpenStack Object Storage Parameters:
ParameterTypeRequiredDefaultDescription
auth_urlstringYesKeystone auth URL.
containerstringYesSwift container name.
filestringYesFile path within the container.
filenamestringNoOptional filename override.
passwordstringYesOpenStack password.
regionstringYesOpenStack region.
tenant_namestringNoOptional tenant/project name.
usernamestringYesOpenStack username.

cloudconvert_create_import_s3_task

Import file from Amazon S3 Parameters:
ParameterTypeRequiredDefaultDescription
access_key_idstringYesAWS access key ID.
bucketstringYesS3 bucket name.
endpointstringNoOptional custom S3-compatible endpoint.
filenamestringNoOptional filename override.
keystringYesS3 object key (path).
regionstringNoAWS region (e.g. ‘us-east-1’).
secret_access_keystringYesAWS secret access key.
session_tokenstringNoOptional STS session token.

cloudconvert_create_import_sftp_task

Import file via SFTP Parameters:
ParameterTypeRequiredDefaultDescription
filestringYesRemote file path.
filenamestringNoOptional filename override.
hoststringYesSFTP host.
passwordstringNoSFTP password (or use private_key).
portintegerNoSFTP port (default 22).
private_keystringNoPrivate key (PEM) (alternative to password).
usernamestringYesSFTP username.

cloudconvert_create_import_url_task

Import file from URL Parameters:
ParameterTypeRequiredDefaultDescription
filenamestringNoOptional filename override.
headersobjectNoOptional HTTP headers for the source request.
urlstringYesSource URL of the file to import.

cloudconvert_create_job

Create a job Parameters:
ParameterTypeRequiredDefaultDescription
tagstringNoOptional tag for the job (max 80 chars). Useful for filtering and identifying jobs later.
tasksobjectYesObject mapping task names to task definitions. Each value is a task object containing ‘operation’ plus operation-specific parameters.
webhook_urlstringNoOptional URL to receive a webhook notification when the job completes.

cloudconvert_create_merge_task

Create a merge task Parameters:
ParameterTypeRequiredDefaultDescription
enginestringNoOptional engine override.
filenamestringNoOutput filename.
inputstring[]YesArray of input task names to merge.
output_formatstringYesOutput format (e.g. ‘pdf’).
timeoutintegerNoMaximum task duration in seconds.

cloudconvert_create_metadata_read_task

Create a metadata read task Parameters:
ParameterTypeRequiredDefaultDescription
enginestringNoMetadata engine override.
inputstring[]YesTask name(s) of the input task.
input_formatstringNoOptional input format override.
timeoutintegerNoMaximum task duration in seconds.

cloudconvert_create_metadata_write_task

Create a metadata write task Parameters:
ParameterTypeRequiredDefaultDescription
enginestringNoMetadata engine override.
filenamestringNoOutput filename.
inputstring[]YesTask name(s) of the input task.
input_formatstringNoOptional input format override.
metadataobjectYesMetadata key/value pairs to write.
timeoutintegerNoMaximum task duration in seconds.

cloudconvert_create_optimize_task

Create an optimize task Parameters:
ParameterTypeRequiredDefaultDescription
enginestringNoOptimization engine (e.g. ‘jpegoptim’, ‘pngquant’).
engine_versionstringNoOptional engine version.
filenamestringNoOutput filename.
inputstring[]YesTask name(s) of the input task.
input_formatstringNoOptional input file format override.
profilestringNoOptimization profile (e.g. ‘web’, ‘print’, ‘archive’, ‘max’).
timeoutintegerNoMaximum task duration in seconds.

cloudconvert_create_thumbnail_task

Create a thumbnail task Parameters:
ParameterTypeRequiredDefaultDescription
countintegerNoNumber of thumbnails to generate.
enginestringNoOptional engine override.
filenamestringNoOutput filename.
fitstringNoHow to fit the thumbnail.
heightintegerNoThumbnail height in pixels.
inputstring[]YesTask name(s) of the input task.
input_formatstringNoOptional input format override.
output_formatstringYesOutput image format (e.g. ‘png’, ‘jpg’, ‘webp’).
timeoutintegerNoMaximum task duration in seconds.
timestampstringNoTimestamp for video thumbnails (e.g. ‘00:00:05.000’).
widthintegerNoThumbnail width in pixels.

cloudconvert_create_watermark_task

Create a watermark task Parameters:
ParameterTypeRequiredDefaultDescription
enginestringNoOptional engine override.
filenamestringNoOutput filename.
font_colorstringNoFont color (hex).
font_namestringNoFont family name.
font_sizeintegerNoFont size for text watermark.
imagestringNoTask name producing the watermark image.
image_heightintegerNoImage watermark height in pixels.
image_widthintegerNoImage watermark width in pixels.
inputstring[]YesTask name(s) of the input task.
input_formatstringNoOptional input format override.
layerstringNoWatermark layer.
margin_horizontalintegerNoHorizontal margin in pixels.
margin_verticalintegerNoVertical margin in pixels.
opacityintegerNoWatermark opacity (0-100).
output_formatstringNoOutput format (e.g. ‘pdf’).
position_horizontalstringNoHorizontal position.
position_verticalstringNoVertical position.
rotationintegerNoRotation in degrees.
textstringNoWatermark text.
timeoutintegerNoMaximum task duration in seconds.

cloudconvert_create_webhook

Create a webhook Parameters:
ParameterTypeRequiredDefaultDescription
eventsstring[]YesEvents to subscribe to.
urlstringYesWebhook target URL.

cloudconvert_delete_job

Delete a job Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesJob ID (UUID).

cloudconvert_delete_task

Delete a task Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTask ID (UUID).

cloudconvert_delete_webhook

Delete a webhook Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesWebhook ID.

cloudconvert_get_current_user

Get current user

cloudconvert_get_job

Get a job Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesJob ID (UUID).
includestringNoComma-separated relations to include: tasks.

cloudconvert_get_task

Get a task Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTask ID (UUID).
includestringNoComma-separated relations to include: job, payload.

cloudconvert_get_webhook

Get a webhook Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesWebhook ID.

cloudconvert_list_jobs

List jobs Parameters:
ParameterTypeRequiredDefaultDescription
filter[status]stringNoFilter by job status: waiting, processing, finished, error.
filter[tag]stringNoFilter by job tag.
includestringNoComma-separated list of relations to include: tasks.
per_pageintegerNoResults per page (max 100).
pageintegerNoPage number (1-indexed).

cloudconvert_list_operations

List supported conversion operations Parameters:
ParameterTypeRequiredDefaultDescription
filter[operation]stringNoFilter by operation type (e.g. ‘convert’, ‘optimize’).
filter[input_format]stringNoFilter by input file format (e.g. ‘pdf’).
filter[output_format]stringNoFilter by output file format (e.g. ‘docx’).
filter[engine]stringNoFilter by engine.
filter[engine_version]stringNoFilter by engine version.
includestringNoComma-separated relations to include.

cloudconvert_list_tasks

List tasks Parameters:
ParameterTypeRequiredDefaultDescription
filter[job_id]stringNoFilter tasks by job ID.
filter[status]stringNoFilter by task status: waiting, processing, finished, error.
filter[operation]stringNoFilter by operation name (e.g. convert, import/url, export/url).
includestringNoComma-separated relations to include: job, payload.
per_pageintegerNoResults per page (max 100).
pageintegerNoPage number (1-indexed).

cloudconvert_list_webhooks

List webhooks Parameters:
ParameterTypeRequiredDefaultDescription
per_pageintegerNoResults per page (max 100).
pageintegerNoPage number (1-indexed).

cloudconvert_retry_task

Retry a task Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesTask ID (UUID) to retry.