/cloudconvert | Type: Application | PCID required: Yes
Tools
cloudconvert_cancel_task
Cancel a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Task ID (UUID). |
cloudconvert_create_archive_task
Create an archive task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engine | string | No | — | Optional archiving engine override. |
filename | string | No | — | Output filename. |
input | string[] | Yes | — | Array of input task names to archive. |
output_format | string | Yes | — | Archive format. |
timeout | integer | No | — | Maximum task duration in seconds. |
cloudconvert_create_capture_website_task
Create a capture-website task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
css | string | No | — | Custom CSS to inject before capturing. |
display_header_footer | boolean | No | — | Display header/footer (PDF only). |
engine | string | No | — | Capture engine (e.g. ‘chrome’). |
engine_version | string | No | — | Optional engine version. |
filename | string | No | — | Output filename. |
footer_template | string | No | — | HTML template for the footer. |
header_template | string | No | — | HTML template for the header. |
headers | object | No | — | Custom HTTP headers for the request. |
javascript | string | No | — | Custom JavaScript to run before capturing. |
margin_bottom | number | No | — | Bottom margin in inches (PDF only). |
margin_left | number | No | — | Left margin in inches (PDF only). |
margin_right | number | No | — | Right margin in inches (PDF only). |
margin_top | number | No | — | Top margin in inches (PDF only). |
output_format | string | Yes | — | Output format: pdf, png, or jpg. |
page_height | number | No | — | Custom page height in inches (PDF only). |
page_orientation | string | No | — | Page orientation (PDF only). |
page_width | number | No | — | Custom page width in inches (PDF only). |
pages | string | No | — | Page range (PDF only), e.g. ‘1-3’. |
print_background | boolean | No | — | Whether to print background graphics (PDF only). |
timeout | integer | No | — | Maximum task duration in seconds. |
url | string | Yes | — | URL of the website to capture. |
wait_for_element | string | No | — | CSS selector to wait for. |
wait_time | integer | No | — | Additional wait time in milliseconds. |
wait_until | string | No | — | When to consider the page loaded. |
zoom | number | No | — | Zoom factor (default 1.0). |
cloudconvert_create_convert_task
Create a convert task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engine | string | No | — | Optional conversion engine (e.g. ‘office’, ‘libreoffice’, ‘imagemagick’). |
engine_version | string | No | — | Optional engine version. |
filename | string | No | — | Output filename (without extension). |
input | string[] | Yes | — | Task name(s) of the input task in the same job, or task ID(s). Can be a string or array of strings. |
input_format | string | No | — | Optional input file format override (e.g. ‘pdf’, ‘docx’). |
output_format | string | Yes | — | Target output format (e.g. ‘pdf’, ‘png’, ‘docx’, ‘mp4’). |
timeout | integer | No | — | Maximum task duration in seconds. |
cloudconvert_create_export_azure_blob_task
Export file to Azure Blob Storage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
blob | string | Yes | — | Destination blob path/name. |
container | string | Yes | — | Blob container name. |
input | string[] | Yes | — | Task name(s) whose output should be exported. |
sas_token | string | No | — | Optional SAS token. |
storage_access_key | string | Yes | — | Storage access key (or use sas_token). |
storage_account | string | Yes | — | Azure storage account name. |
cloudconvert_create_export_google_drive_task
Export file to Google Drive Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
access_token | string | Yes | — | OAuth access token for Google Drive. |
file_name | string | No | — | Optional destination filename. |
folder_id | string | No | — | Optional destination folder ID. |
input | string[] | Yes | — | Task name(s) whose output should be exported. |
cloudconvert_create_export_openstack_task
Export file to OpenStack Object Storage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
auth_url | string | Yes | — | Keystone auth URL. |
container | string | Yes | — | Swift container name. |
file | string | Yes | — | Destination file path. |
input | string[] | Yes | — | Task name(s) whose output should be exported. |
password | string | Yes | — | OpenStack password. |
region | string | Yes | — | OpenStack region. |
tenant_name | string | No | — | Optional tenant/project name. |
username | string | Yes | — | OpenStack username. |
cloudconvert_create_export_s3_task
Export file to Amazon S3 Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
access_key_id | string | Yes | — | AWS access key ID. |
acl | string | No | — | S3 canned ACL (e.g. ‘private’, ‘public-read’). |
bucket | string | Yes | — | S3 bucket name. |
cache_control | string | No | — | S3 Cache-Control header. |
endpoint | string | No | — | Optional S3-compatible endpoint. |
input | string[] | Yes | — | Task name(s) whose output should be exported. |
key | string | Yes | — | Destination S3 key (path). |
metadata | object | No | — | S3 user metadata to attach. |
region | string | No | — | AWS region. |
secret_access_key | string | Yes | — | AWS secret access key. |
server_side_encryption | string | No | — | S3 server-side encryption (e.g. ‘AES256’, ‘aws:kms’). |
session_token | string | No | — | Optional STS session token. |
tagging | object | No | — | S3 object tags to attach. |
cloudconvert_create_export_sftp_task
Export file via SFTP Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file | string | Yes | — | Destination file path. |
host | string | Yes | — | SFTP host. |
input | string[] | Yes | — | Task name(s) whose output should be exported. |
password | string | No | — | SFTP password (or use private_key). |
port | integer | No | — | SFTP port (default 22). |
private_key | string | No | — | Private key (PEM) (alternative to password). |
username | string | Yes | — | SFTP username. |
cloudconvert_create_export_url_task
Export file as a temporary URL Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
archive_multiple_files | boolean | No | — | Pack multiple inputs into a single zip URL. |
inline | boolean | No | — | Whether the URL serves the file inline (rather than as attachment). |
input | string[] | Yes | — | Task name(s) whose output should be exported. |
cloudconvert_create_import_azure_blob_task
Import file from Azure Blob Storage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
blob | string | Yes | — | Blob path/name. |
container | string | Yes | — | Blob container name. |
filename | string | No | — | Optional filename override. |
sas_token | string | No | — | Optional SAS token (alternative to storage_access_key). |
storage_access_key | string | Yes | — | Storage access key (or use sas_token). |
storage_account | string | Yes | — | Azure storage account name. |
cloudconvert_create_import_google_drive_task
Import file from Google Drive Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
access_token | string | Yes | — | OAuth access token for Google Drive. |
file_id | string | Yes | — | Google Drive file ID. |
filename | string | No | — | Optional filename override. |
cloudconvert_create_import_openstack_task
Import file from OpenStack Object Storage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
auth_url | string | Yes | — | Keystone auth URL. |
container | string | Yes | — | Swift container name. |
file | string | Yes | — | File path within the container. |
filename | string | No | — | Optional filename override. |
password | string | Yes | — | OpenStack password. |
region | string | Yes | — | OpenStack region. |
tenant_name | string | No | — | Optional tenant/project name. |
username | string | Yes | — | OpenStack username. |
cloudconvert_create_import_s3_task
Import file from Amazon S3 Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
access_key_id | string | Yes | — | AWS access key ID. |
bucket | string | Yes | — | S3 bucket name. |
endpoint | string | No | — | Optional custom S3-compatible endpoint. |
filename | string | No | — | Optional filename override. |
key | string | Yes | — | S3 object key (path). |
region | string | No | — | AWS region (e.g. ‘us-east-1’). |
secret_access_key | string | Yes | — | AWS secret access key. |
session_token | string | No | — | Optional STS session token. |
cloudconvert_create_import_sftp_task
Import file via SFTP Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file | string | Yes | — | Remote file path. |
filename | string | No | — | Optional filename override. |
host | string | Yes | — | SFTP host. |
password | string | No | — | SFTP password (or use private_key). |
port | integer | No | — | SFTP port (default 22). |
private_key | string | No | — | Private key (PEM) (alternative to password). |
username | string | Yes | — | SFTP username. |
cloudconvert_create_import_url_task
Import file from URL Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filename | string | No | — | Optional filename override. |
headers | object | No | — | Optional HTTP headers for the source request. |
url | string | Yes | — | Source URL of the file to import. |
cloudconvert_create_job
Create a job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tag | string | No | — | Optional tag for the job (max 80 chars). Useful for filtering and identifying jobs later. |
tasks | object | Yes | — | Object mapping task names to task definitions. Each value is a task object containing ‘operation’ plus operation-specific parameters. |
webhook_url | string | No | — | Optional URL to receive a webhook notification when the job completes. |
cloudconvert_create_merge_task
Create a merge task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engine | string | No | — | Optional engine override. |
filename | string | No | — | Output filename. |
input | string[] | Yes | — | Array of input task names to merge. |
output_format | string | Yes | — | Output format (e.g. ‘pdf’). |
timeout | integer | No | — | Maximum task duration in seconds. |
cloudconvert_create_metadata_read_task
Create a metadata read task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engine | string | No | — | Metadata engine override. |
input | string[] | Yes | — | Task name(s) of the input task. |
input_format | string | No | — | Optional input format override. |
timeout | integer | No | — | Maximum task duration in seconds. |
cloudconvert_create_metadata_write_task
Create a metadata write task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engine | string | No | — | Metadata engine override. |
filename | string | No | — | Output filename. |
input | string[] | Yes | — | Task name(s) of the input task. |
input_format | string | No | — | Optional input format override. |
metadata | object | Yes | — | Metadata key/value pairs to write. |
timeout | integer | No | — | Maximum task duration in seconds. |
cloudconvert_create_optimize_task
Create an optimize task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engine | string | No | — | Optimization engine (e.g. ‘jpegoptim’, ‘pngquant’). |
engine_version | string | No | — | Optional engine version. |
filename | string | No | — | Output filename. |
input | string[] | Yes | — | Task name(s) of the input task. |
input_format | string | No | — | Optional input file format override. |
profile | string | No | — | Optimization profile (e.g. ‘web’, ‘print’, ‘archive’, ‘max’). |
timeout | integer | No | — | Maximum task duration in seconds. |
cloudconvert_create_thumbnail_task
Create a thumbnail task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
count | integer | No | — | Number of thumbnails to generate. |
engine | string | No | — | Optional engine override. |
filename | string | No | — | Output filename. |
fit | string | No | — | How to fit the thumbnail. |
height | integer | No | — | Thumbnail height in pixels. |
input | string[] | Yes | — | Task name(s) of the input task. |
input_format | string | No | — | Optional input format override. |
output_format | string | Yes | — | Output image format (e.g. ‘png’, ‘jpg’, ‘webp’). |
timeout | integer | No | — | Maximum task duration in seconds. |
timestamp | string | No | — | Timestamp for video thumbnails (e.g. ‘00:00:05.000’). |
width | integer | No | — | Thumbnail width in pixels. |
cloudconvert_create_watermark_task
Create a watermark task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
engine | string | No | — | Optional engine override. |
filename | string | No | — | Output filename. |
font_color | string | No | — | Font color (hex). |
font_name | string | No | — | Font family name. |
font_size | integer | No | — | Font size for text watermark. |
image | string | No | — | Task name producing the watermark image. |
image_height | integer | No | — | Image watermark height in pixels. |
image_width | integer | No | — | Image watermark width in pixels. |
input | string[] | Yes | — | Task name(s) of the input task. |
input_format | string | No | — | Optional input format override. |
layer | string | No | — | Watermark layer. |
margin_horizontal | integer | No | — | Horizontal margin in pixels. |
margin_vertical | integer | No | — | Vertical margin in pixels. |
opacity | integer | No | — | Watermark opacity (0-100). |
output_format | string | No | — | Output format (e.g. ‘pdf’). |
position_horizontal | string | No | — | Horizontal position. |
position_vertical | string | No | — | Vertical position. |
rotation | integer | No | — | Rotation in degrees. |
text | string | No | — | Watermark text. |
timeout | integer | No | — | Maximum task duration in seconds. |
cloudconvert_create_webhook
Create a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
events | string[] | Yes | — | Events to subscribe to. |
url | string | Yes | — | Webhook target URL. |
cloudconvert_delete_job
Delete a job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Job ID (UUID). |
cloudconvert_delete_task
Delete a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Task ID (UUID). |
cloudconvert_delete_webhook
Delete a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Webhook ID. |
cloudconvert_get_current_user
Get current usercloudconvert_get_job
Get a job Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Job ID (UUID). |
include | string | No | — | Comma-separated relations to include: tasks. |
cloudconvert_get_task
Get a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Task ID (UUID). |
include | string | No | — | Comma-separated relations to include: job, payload. |
cloudconvert_get_webhook
Get a webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Webhook ID. |
cloudconvert_list_jobs
List jobs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter[status] | string | No | — | Filter by job status: waiting, processing, finished, error. |
filter[tag] | string | No | — | Filter by job tag. |
include | string | No | — | Comma-separated list of relations to include: tasks. |
per_page | integer | No | — | Results per page (max 100). |
page | integer | No | — | Page number (1-indexed). |
cloudconvert_list_operations
List supported conversion operations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter[operation] | string | No | — | Filter by operation type (e.g. ‘convert’, ‘optimize’). |
filter[input_format] | string | No | — | Filter by input file format (e.g. ‘pdf’). |
filter[output_format] | string | No | — | Filter by output file format (e.g. ‘docx’). |
filter[engine] | string | No | — | Filter by engine. |
filter[engine_version] | string | No | — | Filter by engine version. |
include | string | No | — | Comma-separated relations to include. |
cloudconvert_list_tasks
List tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter[job_id] | string | No | — | Filter tasks by job ID. |
filter[status] | string | No | — | Filter by task status: waiting, processing, finished, error. |
filter[operation] | string | No | — | Filter by operation name (e.g. convert, import/url, export/url). |
include | string | No | — | Comma-separated relations to include: job, payload. |
per_page | integer | No | — | Results per page (max 100). |
page | integer | No | — | Page number (1-indexed). |
cloudconvert_list_webhooks
List webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
per_page | integer | No | — | Results per page (max 100). |
page | integer | No | — | Page number (1-indexed). |
cloudconvert_retry_task
Retry a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Task ID (UUID) to retry. |

